Skip to content

TossPaymentsModule — @gj-kit/toss-payments-nestjs

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

import { TossPaymentsModule } from '@gj-kit/toss-payments-nestjs';
declare class TossPaymentsModule {
/**
* 동기 조립 — `{ provide: TOSS_PAYMENTS, useValue: createTossPayments(config) }`.
* config는 코어 `defineTossPaymentsConfig` 산출물을 권장(간접 전달 시 타입 보존).
*/
static forRoot<E extends Env, const C extends AnyTossPaymentsConfig>(config: C, options?: TossPaymentsModuleOptions): DynamicModule;
/** 비동기 조립 — 스토어를 Nest 프로바이더(inject)로 받아 useFactory에서 config를 만든다. */
static forRootAsync<C extends AnyTossPaymentsConfig>(options: TossPaymentsModuleAsyncOptions<C>): DynamicModule;
/**
* 이름 있는 동기 조립. `forRoot`는 기존 단일 kit(`TOSS_PAYMENTS`) 호환 API로
* 유지하고, 여러 키 쌍은 이 메서드로 분리한다.
*/
static register<const C extends AnyTossPaymentsConfig>(options: TossPaymentsModuleRegisterOptions<C>): DynamicModule;
/** 이름 있는 비동기 조립. provider별 config/store를 독립적으로 주입한다. */
static registerAsync<C extends AnyTossPaymentsConfig>(options: TossPaymentsModuleRegisterAsyncOptions<C>): DynamicModule;
}

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-nestjs
  • Version: 0.4.4
  • Public entry: .
  • Source: GitHub