Interface OsAPIClient`Beta`

Interface representing a client for interacting with the OctoStar API.

interface OsAPIClient {
    fetchData<T>(options: FetchOptions): Promise<T>;
    streamData(options: FetchOptions): Promise<ReadableStream<Uint8Array<ArrayBuffer>>>;
    streamJson<T>(options: StreamJsonOptions<T>): Promise<void>;
    streamText(options: StreamTextOptions): Promise<void>;
}

Index

Methods

fetchData streamData streamJson streamText

Methods

fetchData

fetchData<T>(options): Promise<T>
Beta
Fetch data from the API.
Type Parameters
- T
Parameters
- options: FetchOptions
  Configuration options for the fetch request.
Returns Promise<T>
A promise that resolves with the fetched data of type T.
- Defined in client.ts:24

streamData

streamData(options): Promise<ReadableStream<Uint8Array<ArrayBuffer>>>
Beta
Stream data from the API.
Parameters
- options: FetchOptions
  Configuration options for the stream request.
Returns Promise<ReadableStream<Uint8Array<ArrayBuffer>>>
A promise that resolves when the streaming is complete.
- Defined in client.ts:31

streamJson

streamJson<T>(options): Promise<void>
Beta
Streams JSON line data from the API.
Type Parameters
- T
Parameters
- options: StreamJsonOptions<T>
  Configuration options for the stream request.
Returns Promise<void>
A promise that resolves when the streaming is complete.
- Defined in client.ts:45

streamText

streamText(options): Promise<void>
Beta
Streams text data from the API.
Parameters
- options: StreamTextOptions
  Configuration options for the stream request.
Returns Promise<void>
A promise that resolves when the streaming is complete.
- Defined in client.ts:38