@gladiaio/sdk/dist/types.d.ts

Gladia JavaScript/TypeScript SDK

import { Headers } from "./network/types.js";

//#region src/types.d.ts

/**
* Options for the HTTP retry policy.
*/
type HttpRetryOptions = {
  /**
  * Maximum number of attempts for an HTTP request.
  * 0 for unlimited. 1 for no retry.
  *
  * Default is 2.
  */
  maxAttempts?: number;
  /**
  * List of status codes eligible for retry. You can specify a range by using a tuple.
  *
  * Default for HTTP is [408, 413, 429, [500, 599]].
  */
  statusCodes?: (number | [start: number, end: number])[];
  /**
  * The function used to determine the delay between retries.
  * It takes one parameter, attemptCount, starting at 1.
  *
  * Default is (attemptCount) => Math.min(0, 0.3 * (2 ** (attemptCount - 1)) * 1_000, 10_000)
  */
  delay?: (attemptCount: number) => number;
};
/**
* Options for the WebSocket retry policy.
*/
type WebSocketRetryOptions = {
  /**
  * Maximum number of attempts for a WS connection.
  * 0 for unlimited. 1 for no retry.
  * Once connected, the number of attempts to reconnect is reset.
  *
  * Default is 5.
  */
  maxAttemptsPerConnection?: number;
  /**
  * The function used to determine the delay between retries.
  * It takes one parameter, attemptCount, starting at 1.
  *
  * Default is (attemptCount) => Math.min(0, 0.3 * (2 ** (attemptCount - 1)) * 1_000, 2_000)
  */
  delay?: (attemptCount: number) => number;
  /**
  * Maximum number of WS connections.
  * 0 for unlimited. 1 for no reconnection.
  *
  * Default is 0.
  */
  maxConnections?: number;
  /**
  * List of close code eligible for reconnection. You can specify a range by using a tuple.
  * Default is [[1002, 4399], [4500, 9999]].
  */
  closeCodes?: (number | [start: number, end: number])[];
};
/**
* Options for the Gladia Client.
*/
type GladiaClientOptions = {
  /**
  * Your Gladia API key.
  * You can obtain one by going to https://app.gladia.io.
  *
  * If you are using this client from a browser or in public code, you can omit it and give a different baseUrl pointing to a server you control.
  * The server will have to act as a proxy to https://api.gladia.io and only add the header "x-gladia-key" with your API key.
  *
  * If not provided, the client will use the API key from the environment variable GLADIA_API_KEY.
  */
  apiKey?: string;
  /**
  * Base API URL used for the API calls to Gladia.
  *
  * You can modify it to proxy the requests.
  *
  * If not provided, the client will take the environment variable GLADIA_API_URL and, if not provided either, it will default to https://api.gladia.io.
  */
  apiUrl?: string;
  /**
  * Region to use.
  *
  * If not provided, the client will take the environment variable GLADIA_REGION and, if not provided either, it will default to 'eu-west'.
  */
  region?: "eu-west" | "us-west";
  /**
  * Custom headers to add to the HTTP requests.
  */
  httpHeaders?: Headers | [string, string][];
  /**
  * Control the retry behavior for HTTP requests.
  *
  * Retries are not triggered following a timeout.
  */
  httpRetry?: HttpRetryOptions;
  /**
  * Timeout for HTTP requests in milliseconds.
  *
  * Retries are not triggered following a timeout.
  *
  * Default is 10_000.
  */
  httpTimeout?: number;
  /**
  * Control the retry behavior for WebSocket connections and re-connections after a close event.
  * Attempt count resets after a successful WebSocket connection.
  *
  * Retries are not triggered following a timeout.
  */
  wsRetry?: WebSocketRetryOptions;
  /**
  * Timeout for WebSocket connections and re-connections after a close event in milliseconds.
  *
  * Retries are not triggered following a timeout.
  *
  * Default is 10_000.
  */
  wsTimeout?: number;
};
//#endregion
export { GladiaClientOptions, HttpRetryOptions, WebSocketRetryOptions };
//# sourceMappingURL=types.d.ts.map