@temporalio/worker
Version:
Temporal.io SDK Worker sub-package
48 lines (47 loc) • 1.85 kB
TypeScript
import * as native from '@temporalio/core-bridge';
type TLSConfig = native.TLSConfig;
type ProxyConfig = native.ProxyConfig;
export { TLSConfig, ProxyConfig };
export interface NativeConnectionOptions {
/**
* The address of the Temporal server to connect to, in `hostname:port` format.
*
* Port defaults to 7233. Raw IPv6 addresses must be wrapped in square brackets (e.g. `[ipv6]:port`).
*
* @default localhost:7233
*/
address?: string;
/**
* TLS configuration options.
*
* Pass a falsy value to use a non-encrypted connection or `true` or `{}` to
* connect with TLS without any customization.
*/
tls?: TLSConfig | boolean | null;
/**
* Proxying configuration.
*
* @experimental
*/
proxy?: ProxyConfig;
/**
* Optional mapping of gRPC metadata (HTTP headers) to send with each request to the server.
*
* Set statically at connection time, can be replaced later using {@link NativeConnection.setMetadata}.
*/
metadata?: Record<string, string>;
/**
* API key for Temporal. This becomes the "Authorization" HTTP header with "Bearer " prepended.
* This is only set if RPC metadata doesn't already have an "authorization" key.
*/
apiKey?: string;
}
export type RequiredNativeConnectionOptions = Omit<Required<NativeConnectionOptions>, 'tls' | 'proxy' | 'metadata' | 'apiKey'> & {
tls?: NativeConnectionOptions['tls'];
proxy?: NativeConnectionOptions['proxy'];
metadata?: NativeConnectionOptions['metadata'];
apiKey?: NativeConnectionOptions['apiKey'];
sdkVersion: string;
};
export declare function getDefaultConnectionOptions(): RequiredNativeConnectionOptions;
export declare function compileConnectionOptions(options: RequiredNativeConnectionOptions): RequiredNativeConnectionOptions;