Restate Typescript SDK
    Preparing search index...

    Interface NodeEndpointOptions

    Options for creating a Node.js endpoint handler.

    Extends EndpointOptions with Node.js-specific options for controlling the protocol mode.

    interface NodeEndpointOptions {
        bidirectional?: boolean;
        defaultServiceOptions?: DefaultServiceOptions;
        identityKeys?: string[];
        journalValueCodecProvider?: () => Promise<JournalValueCodec>;
        logger?: LoggerTransport;
        services: (
            | ServiceDefinition<string, unknown>
            | VirtualObjectDefinition<string, unknown>
            | WorkflowDefinition<string, unknown>
        )[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    bidirectional? defaultServiceOptions? identityKeys? journalValueCodecProvider? logger? services

    Properties

    bidirectional?: boolean

    Controls the protocol mode used by the handler.

    • undefined (default): auto-detect based on HTTP version. HTTP/2+ uses bidirectional streaming (BIDI_STREAM), HTTP/1.1 uses request-response mode (REQUEST_RESPONSE).
    • true: force BIDI_STREAM for all requests.
    • false: force REQUEST_RESPONSE for all requests.
    defaultServiceOptions?: DefaultServiceOptions

    Default service options that will be used by all services bind to this endpoint.

    Options can be overridden on each service/handler.

    identityKeys?: string[]

    Provide a list of v1 request identity public keys eg publickeyv1_2G8dCQhArfvGpzPw5Vx2ALciR4xCLHfS5YaT93XjNxX9 to validate incoming requests against, limiting requests to Restate clusters with the corresponding private keys. This public key format is logged by the Restate process at startup if a request identity private key is provided.

    If this function is called, all incoming requests irrelevant of endpoint type will be expected to have x-restate-signature-scheme: v1 and x-restate-jwt-v1: <valid jwt signed with one of these keys>. If not called,

    journalValueCodecProvider?: () => Promise<JournalValueCodec>

    Provider for the codec to use for journal values. One codec will be instantiated globally for this endpoint. Check JournalValueCodec for more details

    logger?: LoggerTransport

    Replace the default console-based LoggerTransport

    Using console:

    createEndpointHandler({ logger: (meta, message, ...o) => {console.log(`${meta.level}: `, message, ...o)}})

    Using winston:

    const logger = createLogger({ ... })
    createEndpointHandler({ logger: (meta, message, ...o) => {logger.log(meta.level, {invocationId: meta.context?.invocationId}, [message, ...o].join(' '))} })

    Using pino:

    const logger = pino()
    createEndpointHandler({ logger: (meta, message, ...o) => {logger[meta.level]({invocationId: meta.context?.invocationId}, [message, ...o].join(' '))}} )
    services: (
        | ServiceDefinition<string, unknown>
        | VirtualObjectDefinition<string, unknown>
        | WorkflowDefinition<string, unknown>
    )[]

    A list of Restate services, virtual objects, or workflows that will be exposed via the endpoint.

    Settings

    Member Visibility

    On This Page

    Properties