콘텐츠로 이동

PaymentLookup — @gj-kit/toss-payments

@gj-kit/toss-payments/webhook에서 공개하는 interface입니다. package version 0.6.1의 release declaration을 그대로 표시합니다.

import { PaymentLookup } from '@gj-kit/toss-payments/webhook';
/**
* {@link Unverified.refetch}가 요구하는 최소 조회 능력 — 구조적 인터페이스.
*
* `@gj-kit/toss-payments/server`의 `TossServerClient`가 그대로 구조 호환된다.
* webhook 엔트리는 Edge 등에서 서버 클라이언트 없이 단독 사용 가능해야 하므로
* server 모듈을 import하지 않고 여기서 구조적으로 정의한다.
*/
interface PaymentLookup {
getPayment(key: PaymentKey, options?: {
readonly signal?: AbortSignal;
}): Promise<Result<Payment, LookupError>>;
getPaymentByOrderId(orderId: OrderId, options?: {
readonly signal?: AbortSignal;
}): Promise<Result<Payment, LookupError>>;
}

이 선언은 매개변수, optionality, 제네릭, 반환값, 공개 union/type 계약의 정본입니다. 호출 전 필요한 환경·권한·오류 경계는 패키지 Golden path와 이 subpath의 import 조건을 함께 확인하세요.

  • 패키지: @gj-kit/toss-payments
  • 버전: 0.6.1
  • 공개 entry: ./webhook
  • 소스: GitHub

{@link Unverified.refetch}가 요구하는 최소 조회 능력 — 구조적 인터페이스.

@gj-kit/toss-payments/serverTossServerClient가 그대로 구조 호환된다. webhook 엔트리는 Edge 등에서 서버 클라이언트 없이 단독 사용 가능해야 하므로 server 모듈을 import하지 않고 여기서 구조적으로 정의한다.