Skip to main content

Interface: NexusServiceClient<T>

Experimental

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​

T​

T extends nexus.ServiceDefinition

Properties​

endpoint​

readonly endpoint: string

Experimental


service​

readonly service: T

Experimental

Methods​

executeOperation()​

Call Signature​

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

Experimental

Start a Nexus operation and wait for its result.

Convenience for startOperation followed by NexusOperationHandle.result.

Nexus Standalone Operations are experimental.

Type Parameters​
Op​

Op extends OperationDefinition<any, any>

Parameters​
operation​

Op

input​

OperationInput<Op>

options​

StartNexusOperationOptions

Returns​

Promise<OperationOutput<Op>>

Call Signature​

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

Experimental

Type Parameters​
K​

K extends string

Parameters​
op​

K

input​

OperationInput<T["operations"][K]>

options​

StartNexusOperationOptions

Returns​

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


startOperation()​

Call Signature​

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

Experimental

Start a Nexus operation and return a handle.

Nexus Standalone Operations are experimental.

Type Parameters​
Op​

Op extends OperationDefinition<any, any>

Parameters​
operation​

Op

input​

OperationInput<Op>

options​

StartNexusOperationOptions

Returns​

Promise<NexusOperationHandle<OperationOutput<Op>>>

Call Signature​

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

Experimental

Type Parameters​
K​

K extends string

Parameters​
op​

K

input​

OperationInput<T["operations"][K]>

options​

StartNexusOperationOptions

Returns​

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