InvalidInput — @gj-kit/toss-payments

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

검증된 import 예제

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

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

/**
 * Validation failure of a library-owned input.
 *
 * `Reason` defaults to the string-constraint reasons every id/key parser uses, so all
 * existing `InvalidInput<'orderId'>`-style references keep their exact shape. Structured
 * inputs (e.g. `parsePaymentStateSnapshot`) instantiate it with their own reason union.
 */
interface InvalidInput<Field extends string, Reason extends string = 'too-short' | 'too-long' | 'bad-charset' | 'empty'> {
    readonly source: 'library';
    readonly kind: 'invalid-input';
    readonly field: Field;
    readonly reason: Reason;
}

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

Release context

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

구현 주석

Validation failure of a library-owned input.

Reason defaults to the string-constraint reasons every id/key parser uses, so all existing InvalidInput<'orderId'>-style references keep their exact shape. Structured inputs (e.g. parsePaymentStateSnapshot) instantiate it with their own reason union.