@temporal-contract/client-nestjs

---

@temporal-contract/client-nestjs

Classes

TemporalClientModule

Defined in: packages/client-nestjs/src/temporal-client.module.ts:28

Temporal client module for NestJS integration

Provides a declarative way to define Temporal clients with type safety.

Example

@Module({
  imports: [
    TemporalClientModule.forRoot({
      contract: myContract,
      client: temporalClient,
    }),
  ],
})
export class AppModule {}

Extends

• ConfigurableModuleClass

Indexable

[key: string]: any

Constructors

Constructor

new TemporalClientModule(): TemporalClientModule;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.12_reflect-metadata@0.2.2_rxjs@7.8.2/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Returns

TemporalClientModule

Inherited from

ConfigurableModuleClass.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
forRoot	static	(options) => DynamicModule	ConfigurableModuleClass.forRoot
forRootAsync	static	(options) => DynamicModule	ConfigurableModuleClass.forRootAsync

---

TemporalClientService<TContract>

Defined in: packages/client-nestjs/src/temporal-client.service.ts:11

Service managing the Temporal typed client lifecycle

Type Parameters

Type Parameter	Default type
TContract extends ContractDefinition	ContractDefinition

Implements

• OnModuleDestroy

Constructors

Constructor

new TemporalClientService<TContract>(options): TemporalClientService<TContract>;

Defined in: packages/client-nestjs/src/temporal-client.service.ts:17

Parameters

Parameter	Type
options	TemporalClientModuleOptions<TContract>

Returns

TemporalClientService<TContract>

Methods

getClient()

getClient(): TypedClient<TContract>;

Defined in: packages/client-nestjs/src/temporal-client.service.ts:38

Get the typed client instance

Returns

TypedClient<TContract>

onModuleDestroy()

onModuleDestroy(): Promise<void>;

Defined in: packages/client-nestjs/src/temporal-client.service.ts:29

Clean up resources on module destruction

Returns

Promise<void>

Implementation of

OnModuleDestroy.onModuleDestroy

Interfaces

TemporalClientModuleOptions<TContract>

Defined in: packages/client-nestjs/src/interfaces.ts:7

Options for configuring the Temporal client module

Type Parameters

Type Parameter	Default type
TContract extends ContractDefinition	ContractDefinition

Properties

Property	Type	Description	Defined in
client	Client	Temporal client instance or configuration to create one	packages/client-nestjs/src/interfaces.ts:18
contract	TContract	The contract definition for this client	packages/client-nestjs/src/interfaces.ts:13