OrderId — @gj-kit/toss-payments

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

검증된 import 예제

import { OrderId } from '@gj-kit/toss-payments/server';

시그니처, 매개변수, 반환 타입

/**
 * 문자열 도메인 타입 — 스마트 생성자.
 * 검증 통과가 브랜드 획득의 유일한 경로다 (`as` 없이는 제조 불가).
 */
/**
 * 주문 ID — 6–64자, `^[A-Za-z0-9_-]+$`.
 *
 * `'='`를 거부하는 근거: SDK 문서는 `=`를 포함한 집합을 허용하지만
 * 레퍼런스/빌링 승인의 orderId 규격은 영숫자와 `-`,`_`만 허용한다.
 * 같은 orderId가 일반 결제와 빌링 승인 양쪽에 쓰일 수 있으므로
 * 보수적 교집합을 채택해 빌링 승인 규격과의 충돌을 회피한다.
 */
type OrderId = string & Brand<'OrderId'>;

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

Release context

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

구현 주석

주문 ID — 6–64자, ^[A-Za-z0-9_-]+$.

'='를 거부하는 근거: SDK 문서는 =를 포함한 집합을 허용하지만 레퍼런스/빌링 승인의 orderId 규격은 영숫자와 -,_만 허용한다. 같은 orderId가 일반 결제와 빌링 승인 양쪽에 쓰일 수 있으므로 보수적 교집합을 채택해 빌링 승인 규격과의 충돌을 회피한다.