PaymentStateSnapshotParseReason — @gj-kit/toss-payments

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

검증된 import 예제

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

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

/**
 * Why {@link parsePaymentStateSnapshot} rejected a value: the four string-constraint reasons
 * come from re-branding `paymentKey`/`orderId` through the existing id parsers;
 * `'malformed'` covers every structural failure (wrong type, missing field, unknown literal,
 * unsupported `schemaVersion`). The offending location is in
 * {@link InvalidPaymentStateSnapshot.path}.
 */
type PaymentStateSnapshotParseReason = InvalidInput<"paymentStateSnapshot">["reason"] | "malformed";

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

Release context

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

구현 주석

Why {@link parsePaymentStateSnapshot} rejected a value: the four string-constraint reasons come from re-branding paymentKey/orderId through the existing id parsers; 'malformed' covers every structural failure (wrong type, missing field, unknown literal, unsupported schemaVersion). The offending location is in {@link InvalidPaymentStateSnapshot.path}.