@btravstack/temporal-client

---

@btravstack/temporal-client

Classes

TemporalClientUnreachable

Defined in: packages/temporal-client/src/index.ts:14

The Temporal service did not answer while the client connection opened.

Extends

• TaggedErrorInstance<"TemporalClientUnreachable", { address: string; cause: unknown; }>

Constructors

Constructor

new TemporalClientUnreachable(args): TemporalClientUnreachable;

Defined in: node_modules/.pnpm/unthrown@5.12.1/node_modules/unthrown/dist/index.d.mts:2386

Parameters

Parameter	Type
args	object & object

Returns

TemporalClientUnreachable

Inherited from

TaggedError("TemporalClientUnreachable")<{
  readonly address: string;
  readonly cause: unknown;
}>.constructor

Properties

Property	Modifier	Type	Overrides	Inherited from	Defined in
_tag	readonly	"TemporalClientUnreachable"	-	TaggedError("TemporalClientUnreachable")._tag	node_modules/.pnpm/unthrown@5.12.1/node_modules/unthrown/dist/index.d.mts:2363
address	readonly	string	-	TaggedError("TemporalClientUnreachable").address	packages/temporal-client/src/index.ts:15
cause	public	unknown	-	TaggedError("TemporalClientUnreachable").cause	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
message	public	string	TaggedError("TemporalClientUnreachable").message	-	packages/temporal-client/src/index.ts:18
name	public	string	-	TaggedError("TemporalClientUnreachable").name	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
stack?	public	string	-	TaggedError("TemporalClientUnreachable").stack	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Type Aliases

TemporalClientSettings

type TemporalClientSettings = object;

Defined in: packages/temporal-client/src/index.ts:8

The deployment settings needed to call a Temporal service.

Properties

Property	Modifier	Type	Defined in
address	readonly	string	packages/temporal-client/src/index.ts:9
namespace	readonly	string	packages/temporal-client/src/index.ts:10

Functions

temporalClient()

function temporalClient<Settings, ClientId, ConnectionId, SettingsId>(
   port, 
   connection, 
   settings
): Provider<PortInstance<ClientId, TypedClient>, never, 
  | PortInstance<ConnectionId, Connection>
  | PortInstance<SettingsId, Settings>> & object;

Defined in: packages/temporal-client/src/index.ts:41

Bind the typed Temporal client; callers choose a contract with client.for(contract).

Type Parameters

Type Parameter
Settings extends TemporalClientSettings
ClientId extends string
ConnectionId extends string
SettingsId extends string

Parameters

Parameter	Type
port	PortClassOf<ClientId, TypedClient>
connection	PortClassOf<ConnectionId, Connection>
settings	PortClassOf<SettingsId, Settings>

Returns

Provider<PortInstance<ClientId, TypedClient>, never, | PortInstance<ConnectionId, Connection> | PortInstance<SettingsId, Settings>> & object

---

temporalConnection()

function temporalConnection<Settings, ConnectionId, SettingsId>(port, settings): Provider<PortInstance<ConnectionId, Connection>, TemporalClientUnreachable, PortInstance<SettingsId, Settings> | Scope> & object;

Defined in: packages/temporal-client/src/index.ts:22

Acquire and release a Temporal connection with the DI scope.

Type Parameters

Type Parameter
Settings extends TemporalClientSettings
ConnectionId extends string
SettingsId extends string

Parameters

Parameter	Type
port	PortClassOf<ConnectionId, Connection>
settings	PortClassOf<SettingsId, Settings>

Returns

Provider<PortInstance<ConnectionId, Connection>, TemporalClientUnreachable, PortInstance<SettingsId, Settings> | Scope> & object