OrderId — @gj-kit/toss-payments

A public type from @gj-kit/toss-payments. The signature below is taken directly from the 0.6.1 release declaration.

Verified import example

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

Signature, parameters, and return type

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

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

Release context

• Package: @gj-kit/toss-payments
• Version: 0.6.1
• Public entry: .
• Source: GitHub