Type Alias RunOptions<Input>

RunOptions<Input>: {
    abortSignal?: AbortSignal;
    input?: Input;
    method?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string;
    startTimeout?: number;
    storageSettings?: StorageSettings;
    tags?: Record<string, string>;
}

The function input and other configuration when running the function, such as the HTTP method to use.

Type Parameters

  • Input

Type declaration

  • Optional ReadonlyabortSignal?: AbortSignal

    The abort signal to cancel the request.

  • Optional Readonlyinput?: Input

    The function input. It will be submitted either as query params or the body payload, depending on the method.

  • Optional Readonlymethod?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string

    The HTTP method, defaults to post;

  • Optional ReadonlystartTimeout?: number

    Server-side request timeout in seconds. Limits total time spent waiting before processing starts (includes queue wait, retries, and routing). Does not apply once the application begins processing.

    This will be sent as the x-fal-request-timeout header.

  • Optional ReadonlystorageSettings?: StorageSettings

    Object lifecycle configuration for controlling how long generated objects (images, files, etc.) remain available before expiring.

    See

  • Optional Readonlytags?: Record<string, string>

    Tags to attribute the request's usage and cost to your own dimensions, e.g. { team: "design", env: "prod" }. Keys are lowercased, and both keys and values are limited (at most 10 pairs, 1 KB in total).

    Values cannot contain commas, which separate pairs. Surrounding whitespace is stripped from keys and values before they are recorded.

    This will be sent as a single packed x-fal-tags header. Realtime requests are WebSocket-based and carry no headers, so they cannot be tagged.

Settings

Member Visibility