Skip to content

InvalidInput — @gj-kit/toss-payments

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

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;
}

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.

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