Skip to content

TossEvents — @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 { TossEvents } from '@gj-kit/toss-payments/server';
/** 공개 표면은 구독 전용 — emit은 내부 인터페이스로만 흐른다(라이브러리만 발행). */
interface TossEvents {
/**
* 반환값 = 구독 해제. 핸들러 파라미터는 구체 K에서 `TossEvent<K>`와 동일한 교차 형태 —
* 제네릭 K에서 분배 조건부(TossEvent)가 지연 평가되는 것을 피해 core 이미터와의
* 구조적 호환을 유지한다.
*/
on<K extends TossEventName>(type: K, handler: (event: {
readonly type: K;
readonly at: string;
} & TossEventMap[K]) => void | Promise<void>): () => void;
}

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