Interface CreateStreamParameters

Extended parameters for creating a resource with streaming support.

Remarks

This interface extends CreateParameters to include an optional flag for returning an object instead of a stream.

interface CreateStreamParameters {
    body?: Record<string, any>;
    headers?: OutgoingHttpHeaders;
    query?: Record<string, any>;
    returnObject?: boolean;
    signal?: AbortSignal;
    url: string;
}

Hierarchy (view full)

Properties

body? headers? query? returnObject? signal? url

Properties

Optional body

body?: Record<string, any>

Optional body content for the request.

Optional headers

headers?: OutgoingHttpHeaders

Optional headers for the request.

Optional query

query?: Record<string, any>

Optional query parameters for the request.

Optional returnObject

returnObject?: boolean

Flag to indicate whether to return the result as an object or a stream.

Optional signal

signal?: AbortSignal

Optional abort signal for the request.

url

url: string

The URL of the resource to create.

Settings

Member Visibility

Theme

On This Page

bodyheadersqueryreturnObjectsignalurl