Skip to main content

Interface: NexusServiceClient<T>

client.NexusServiceClient

Typed service client for a specific Nexus service + endpoint pair.

Created via NexusClient.createServiceClient. Provides type-safe startOperation and executeOperation based on the service definition's operation types.

Nexus Standalone Operations are experimental.

Type parameters

NameType
Textends nexus.ServiceDefinition

Properties

endpoint

Readonly endpoint: string


service

Readonly service: T

Methods

executeOperation

executeOperation<Op>(operation, input, options): Promise<OperationOutput<Op>>

Start a Nexus operation and wait for its result.

Convenience for startOperation followed by NexusOperationHandle.result.

Nexus Standalone Operations are experimental.

Type parameters

NameType
Opextends OperationDefinition<any, any>

Parameters

NameType
operationOp
inputOperationInput<Op>
optionsStartNexusOperationOptions

Returns

Promise<OperationOutput<Op>>

executeOperation<K>(op, input, options): Promise<OperationOutput<T["operations"][K]>>

Type parameters

NameType
Kextends string

Parameters

NameType
opK
inputOperationInput<T["operations"][K]>
optionsStartNexusOperationOptions

Returns

Promise<OperationOutput<T["operations"][K]>>


startOperation

startOperation<Op>(operation, input, options): Promise<NexusOperationHandle<OperationOutput<Op>>>

Start a Nexus operation and return a handle.

Nexus Standalone Operations are experimental.

Type parameters

NameType
Opextends OperationDefinition<any, any>

Parameters

NameType
operationOp
inputOperationInput<Op>
optionsStartNexusOperationOptions

Returns

Promise<NexusOperationHandle<OperationOutput<Op>>>

startOperation<K>(op, input, options): Promise<NexusOperationHandle<OperationOutput<T["operations"][K]>>>

Type parameters

NameType
Kextends string

Parameters

NameType
opK
inputOperationInput<T["operations"][K]>
optionsStartNexusOperationOptions

Returns

Promise<NexusOperationHandle<OperationOutput<T["operations"][K]>>>