Type Alias FeedClientConfiguration

FeedClientConfiguration: Required<Pick<ClientConfiguration,
    | "long_type"
    | "max_attempts"
    | "max_backoff"
    | "client_timeout_buffer_ms"
    | "query_timeout_ms"
    | "secret"
    | "logger">> & {
    cursor?: string;
    httpClient: HTTPClient;
    page_size?: number;
    start_ts?: number;
}

Configuration for an event feed client.

Type declaration

  • Optionalcursor?: string

    The starting event cursor, exclusive. If set, Fauna will return events starting after the cursor.

  • httpClient: HTTPClient

    The underlying HTTPClient that will execute the actual HTTP calls.

  • Optionalpage_size?: number

    Maximum number of events returned per page. Must be in the range 1 to 16000 (inclusive). Defaults to 16.

  • Optionalstart_ts?: number

    The starting timestamp of the event feed, exclusive. If set, Fauna will return events starting after the timestamp.

Settings

Member Visibility