nestjs-temporal-core
    Preparing search index...

    Interface ClientConnectionOptions

    Configuration options for Temporal client connection. Used for establishing connection to Temporal server.

    const clientOptions: ClientConnectionOptions = {
      address: 'localhost:7233',
      namespace: 'default',
      tls: false,
      metadata: { 'client-version': '1.0.0' }
    };
    interface ClientConnectionOptions {
        address: string;
        apiKey?: string;
        grpcCompression?: GrpcCompressionConfig;
        interceptors?: ClientInterceptors;
        metadata?: Record<string, string>;
        namespace?: string;
        tls?: boolean | TLSConfig;
    }
    Index
    address apiKey? grpcCompression? interceptors? metadata? namespace? tls?
    address: string
    apiKey?: string
    grpcCompression?: GrpcCompressionConfig

    gRPC compression for the worker connection (NativeConnection). Temporal SDK 1.19 enables gzip compression by default; set { codec: 'none' } to opt out if your server can't decompress it. Has no effect on the plain gRPC client connection, which does not compress by default.

    interceptors?: ClientInterceptors

    Client-level interceptors (workflow, activity, schedule, nexus). Threaded into new Client({ interceptors }). Useful for OTel tracing/metadata propagation.

    metadata?: Record<string, string>
    namespace?: string
    tls?: boolean | TLSConfig

    Settings
    Member Visibility

    On This Page
    Properties