콘텐츠로 이동

CallOptions — @gj-kit/toss-payments

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

import { CallOptions } from '@gj-kit/toss-payments/server';
interface CallOptions<E extends Env> {
/**
* ≤300자, POST 전용. 처음 사용일부터 15일 유효 — TTL 초과 후 재사용하면 새 요청으로
* 실행될 수 있다(문서는 기간만 명시 — 안전하지 않은 것으로 취급). 멱등 판정 조합은 "키 + API 키 + 주소 + 메서드"이며 body는 포함되지
* 않는다(문서 명시) — 키 재사용 시 body 동일성은 호출자(또는 재시도 티켓)가 보장해야 한다.
*/
readonly idempotencyKey?: IdempotencyKey;
/**
* TossPayments-Test-Code 헤더 — 에러 시나리오 시뮬레이션.
* 라이브 키에선 서버가 조용히 무시하는 함정 → 타입으로 차단.
* ⚠ 비분배 조건부 — 미내로잉 union 키(E = Env)도 never다.
*/
readonly testCode?: [
E
] extends [
'test'
] ? string : never;
readonly signal?: AbortSignal;
}

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

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