Interface KosFetchOptions

Represents the configuration options for performing a Kos WebSocket fetch operation.

interface KosFetchOptions {
    method: "GET" | "POST" | "PUT" | "DELETE";
    body?: string | Uint8Array | ArrayBuffer | Blob | FormData;
    ordered?: boolean;
    destinationAddress?: string;
    tracker?: string;
    stream?: boolean;
    responseType?: "text" | "json" | "arraybuffer" | "blob";
}

Properties

method body? ordered? destinationAddress? tracker? stream? responseType?

Properties

method

method: "GET" | "POST" | "PUT" | "DELETE"

The HTTP method for the request (e.g., 'GET', 'POST', 'PUT', 'DELETE', etc.).

Optional body

body?: string | Uint8Array | ArrayBuffer | Blob | FormData

The request body - can be string, ArrayBuffer, Blob, or FormData.

Optional ordered

ordered?: boolean

Indicates whether the request should be ordered.

Optional destinationAddress

destinationAddress?: string

The destination address for the WebSocket request.

Optional tracker

tracker?: string

The tracker associated with the request.

Optional stream

stream?: boolean

Enable streaming mode for large responses

Optional responseType

responseType?: "text" | "json" | "arraybuffer" | "blob"

Response type hint for binary data handling

Settings

Member Visibility

Theme

On This Page

methodbodyordereddestinationAddresstrackerstreamresponseType