Restate Typescript SDK
    Preparing search index...

    Interface IngressSendOptions<I>

    interface IngressSendOptions<I> {
        delay?: number | Duration;
        headers?: Record<string, string>;
        idempotencyKey?: string;
        input?: Serde<I>;
        limitKey?: string;
        output?: Serde<void>;
        signal?: AbortSignal;
        timeout?: number;
    }

    Type Parameters

    • I

    Hierarchy (View Summary)

    Index

    Properties

    delay? headers? idempotencyKey? input? limitKey? output? signal? timeout?

    Properties

    delay?: number | Duration

    If set, the invocation will be enqueued now to be executed after the provided delay. In milliseconds.

    headers?: Record<string, string>

    Headers to attach to the request.

    idempotencyKey?: string

    Key to use for idempotency key.

    See https://docs.restate.dev/operate/invocation#invoke-a-handler-idempotently for more details.

    input?: Serde<I>
    limitKey?: string

    An optional concurrency limit key within the scope. A limit key can only be used in conjunction with a scope (see Ingress.scope).

    NOTE: This API is in preview and is not enabled by default. To use it in restate-server 1.7, enable the flow control and protocol v7 experimental features, via RESTATE_EXPERIMENTAL_ENABLE_PROTOCOL_V7=true and RESTATE_EXPERIMENTAL_ENABLE_VQUEUES=true. These can be enabled only on new clusters, for more info check out https://docs.restate.dev/services/flow-control#enabling-flow-control. If these experimental features aren't enabled, the invocation isn't ingested and the client request fails.

    The limit key enforces hierarchical concurrency limits on invocations sharing the same scope. It can have one or two levels separated by / (e.g. "tenant1" or "tenant1/user42"). Each level must consist only of [a-zA-Z0-9_.-] characters, and 1 <= length <= 36.

    The limit key is not part of the request identity: two calls to the same target with the same scope and object key but different limit keys refer to the same resource instance. The limit key only affects concurrency limits, not resource identity.

    output?: Serde<void>
    signal?: AbortSignal

    Signal to abort the underlying fetch operation. See https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal.

    This field is exclusive with timeout, and using both of them will result in a runtime failure.

    timeout?: number

    Timeout to be used when executing the request. In milliseconds.

    Same as AbortSignal.timeout().

    This field is exclusive with signal, and using both of them will result in a runtime failure.

    Settings

    Member Visibility

    On This Page

    Properties