Skip to content

@ralphschuler.ai function caller.index.<internal>

Jump to bottom
github-actions edited this page Nov 26, 2023 · 1 revision

Module: <internal>

Table of contents

References

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

References

WritableOptions

Re-exports WritableOptions

Type Aliases

APIResponseProps

Ƭ APIResponseProps: Object

Type declaration

Name Type
controller AbortController
options FinalRequestOptions
response Response

Defined in

node_modules/openai/core.d.ts:10

Agent

Ƭ Agent: SelectType<manual.Agent, Agent>

Defined in

node_modules/openai/_shims/index.d.ts:13

ArrayBufferLike

Ƭ ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1707

ArrayBufferView

Ƭ ArrayBufferView: TypedArray | DataView

Defined in

node_modules/@types/node/globals.d.ts:271

Awaited

Ƭ Awaited<T>: T extends null | undefined ? T : T extends object & { then: (onfulfilled: F, ...args: _) => any } ? F extends (value: infer V, ...args: infer _) => any ? Awaited<V> : never : T

Recursively unwraps the "awaited type" of a type. Non-promise "thenables" should resolve to never. This emulates the behavior of await.

Type parameters

Name
T

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1562

BaseFunctionsArgs

Ƭ BaseFunctionsArgs: readonly (object | string)[]

Defined in

node_modules/openai/lib/RunnableFunction.d.ts:55

BinaryLike

Ƭ BinaryLike: string | ArrayBufferView

Defined in

node_modules/@types/node/crypto.d.ts:656

BlobLikePart

Ƭ BlobLikePart: string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView

Defined in

node_modules/openai/uploads.d.ts:5

BlobPart

Ƭ BlobPart: ArrayBuffer | ArrayBufferView | Blob | string

Defined in

node_modules/@types/node-fetch/index.d.ts:111

BlobParts

Ƭ BlobParts: unknown[] | Iterable<unknown>

Defined in

node_modules/formdata-node/@type/Blob.d.ts:13

BodyInit

Ƭ BodyInit: ArrayBuffer | ArrayBufferView | ReadableStream | string | URLSearchParams | FormData

Defined in

node_modules/@types/node-fetch/index.d.ts:196

BufferEncoding

Ƭ BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

Defined in

node_modules/@types/node/buffer.d.ts:232

ChatCompletionFunctionRunnerParams

Ƭ ChatCompletionFunctionRunnerParams<FunctionsArgs>: Omit<ChatCompletionCreateParamsNonStreaming, "functions"> & { functions: RunnableFunctions<FunctionsArgs> }

Type parameters

Name Type
FunctionsArgs extends BaseFunctionsArgs

Defined in

node_modules/openai/lib/ChatCompletionRunner.d.ts:7

ChatCompletionStreamParams

Ƭ ChatCompletionStreamParams: Omit<ChatCompletionCreateParamsBase, "stream"> & { stream?: true }

Defined in

node_modules/openai/lib/ChatCompletionStream.d.ts:9

ChatCompletionStreamingFunctionRunnerParams

Ƭ ChatCompletionStreamingFunctionRunnerParams<FunctionsArgs>: Omit<ChatCompletionCreateParamsStreaming, "functions"> & { functions: RunnableFunctions<FunctionsArgs> }

Type parameters

Name Type
FunctionsArgs extends BaseFunctionsArgs

Defined in

node_modules/openai/lib/ChatCompletionStreamingRunner.d.ts:10

ChatCompletionStreamingToolRunnerParams

Ƭ ChatCompletionStreamingToolRunnerParams<FunctionsArgs>: Omit<ChatCompletionCreateParamsStreaming, "tools"> & { tools: RunnableTools<FunctionsArgs> }

Type parameters

Name Type
FunctionsArgs extends BaseFunctionsArgs

Defined in

node_modules/openai/lib/ChatCompletionStreamingRunner.d.ts:13

ChatCompletionToolRunnerParams

Ƭ ChatCompletionToolRunnerParams<FunctionsArgs>: Omit<ChatCompletionCreateParamsNonStreaming, "tools"> & { tools: RunnableTools<FunctionsArgs> }

Type parameters

Name Type
FunctionsArgs extends BaseFunctionsArgs

Defined in

node_modules/openai/lib/ChatCompletionRunner.d.ts:10

ComposeFnParam

Ƭ ComposeFnParam: (source: any) => void

Type declaration

▸ (source): void

Parameters
Name Type
source any
Returns

void

Defined in

node_modules/@types/node/stream.d.ts:26

CustomEvents

Ƭ CustomEvents<Event>: { [k in Event]: k extends keyof AbstractChatCompletionRunnerEvents ? AbstractChatCompletionRunnerEvents[k] : Function }

Type parameters

Name Type
Event extends string

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:92

DefaultQuery

Ƭ DefaultQuery: Record<string, string | undefined>

Defined in

node_modules/openai/core.d.ts:177

EndingType

Ƭ EndingType: "native" | "transparent"

Defined in

node_modules/openai/_shims/node-types.d.ts:25

Exclude

Ƭ Exclude<T, U>: T extends U ? never : T

Exclude from T those types that are assignable to U

Type parameters

Name
T
U

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1612

Fetch

Ƭ Fetch: (url: RequestInfo, init?: RequestInit) => Promise<Response>

Type declaration

▸ (url, init?): Promise<Response>

Parameters
Name Type
url RequestInfo
init? RequestInit
Returns

Promise<Response>

Defined in

node_modules/openai/core.d.ts:8

File

Ƭ File: SelectType<manual.File, File>

Defined in

node_modules/openai/_shims/index.d.ts:51

node_modules/openai/_shims/index.d.ts:53

File

Ƭ File: File

Defined in

node_modules/openai/_shims/node-types.d.ts:39

node_modules/openai/_shims/node-types.d.ts:40

FileFromPathOptions

Ƭ FileFromPathOptions: Omit<FilePropertyBag, "lastModified">

Defined in

node_modules/openai/_shims/node-types.d.ts:35

FinalRequestOptions

Ƭ FinalRequestOptions<Req>: RequestOptions<Req> & { method: HTTPMethod ; path: string }

Type parameters

Name Type
Req extends Object = Record<string, unknown> | Readable

Defined in

node_modules/openai/core.d.ts:196

FlatArray

Ƭ FlatArray<Arr, Depth>: { done: Arr ; recur: Arr extends ReadonlyArray<infer InnerArr> ? FlatArray<InnerArr, [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][Depth]> : Arr }[Depth extends -1 ? "done" : "recur"]

Type parameters

Name Type
Arr Arr
Depth extends number

Defined in

node_modules/typescript/lib/lib.es2019.array.d.ts:19

FsReadStream

Ƭ FsReadStream: SelectType<manual.FsReadStream, ReadStream>

Defined in

node_modules/openai/_shims/index.d.ts:62

HTTPMethod

Ƭ HTTPMethod: "get" | "post" | "put" | "patch" | "delete"

Defined in

node_modules/openai/core.d.ts:172

Headers

Ƭ Headers: Record<string, string | null | undefined>

Defined in

node_modules/openai/core.d.ts:176

HeadersInit

Ƭ HeadersInit: Headers | string[][] | { [key: string]: string; }

Defined in

node_modules/@types/node-fetch/index.d.ts:193

IteratorResult

Ƭ IteratorResult<T, TReturn>: IteratorYieldResult<T> | IteratorReturnResult<TReturn>

Type parameters

Name Type
T T
TReturn any

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:39

JSONSchemaDefinition

Ƭ JSONSchemaDefinition: JSONSchema | boolean

JSON Schema v7

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01

Defined in

node_modules/openai/lib/jsonschema.d.ts:32

JSONSchemaType

Ƭ JSONSchemaType: string | number | boolean | JSONSchemaObject | JSONSchemaArray | null

Primitive type

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1

Defined in

node_modules/openai/lib/jsonschema.d.ts:10

JSONSchemaTypeName

Ƭ JSONSchemaTypeName: {} & string | "string" | "number" | "integer" | "boolean" | "object" | "array" | "null"

Primitive type

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1

Defined in

node_modules/openai/lib/jsonschema.d.ts:5

ListenerForEvent

Ƭ ListenerForEvent<Events, Event>: Event extends keyof AbstractChatCompletionRunnerEvents ? AbstractChatCompletionRunnerEvents[Event] : Events[Event]

Type parameters

Name Type
Events extends CustomEvents<any>
Event extends keyof Events

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:95

LookupFunction

Ƭ LookupFunction: (hostname: string, options: LookupAllOptions, callback: (err: ErrnoException | null, addresses: LookupAddress[]) => void) => void

Type declaration

▸ (hostname, options, callback): void

Parameters
Name Type
hostname string
options LookupAllOptions
callback (err: ErrnoException | null, addresses: LookupAddress[]) => void
Returns

void

Defined in

node_modules/@types/node/net.d.ts:19

Omit

Ƭ Omit<T, K>: Pick<T, Exclude<keyof T, K>>

Construct a type with the properties of T except for those in type K.

Type parameters

Name Type
T T
K extends keyof any

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1622

OutgoingHttpHeader

Ƭ OutgoingHttpHeader: number | string | string[]

Defined in

node_modules/@types/node/http.d.ts:115

PageInfo

Ƭ PageInfo: { url: URL } | { params: Record<string, unknown> | null }

Defined in

node_modules/openai/core.d.ts:129

Parameters

Ƭ Parameters<T>: T extends (...args: infer P) => any ? P : never

Obtain the parameters of a function type in a tuple

Type parameters

Name Type
T extends (...args: any) => any

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1632

Partial

Ƭ Partial<T>: { [P in keyof T]?: T[P] }

Make all properties in T optional

Type parameters

Name
T

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1577

Pick

Ƭ Pick<T, K>: { [P in K]: T[P] }

From T, pick a set of properties whose keys are in the union K

Type parameters

Name Type
T T
K extends keyof T

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1598

PromiseOrValue

Ƭ PromiseOrValue<T>: T | Promise<T>

Type parameters

Name
T

Defined in

node_modules/openai/core.d.ts:9

PromiseOrValue

Ƭ PromiseOrValue<T>: T | Promise<T>

Type parameters

Name
T

Defined in

node_modules/openai/lib/RunnableFunction.d.ts:4

PromiseSettledResult

Ƭ PromiseSettledResult<T>: PromiseFulfilledResult<T> | PromiseRejectedResult

Type parameters

Name
T

Defined in

node_modules/typescript/lib/lib.es2020.promise.d.ts:29

PropertyKey

Ƭ PropertyKey: string | number | symbol

Defined in

node_modules/typescript/lib/lib.es5.d.ts:108

QueuingStrategySizeCallback

Ƭ QueuingStrategySizeCallback<T>: (chunk: T) => number

Type parameters

Name Type
T any

Type declaration

▸ (chunk): number

Parameters
Name Type
chunk T
Returns

number

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:90

QueuingStrategySizeCallback

Ƭ QueuingStrategySizeCallback<T>: (chunk: T) => number

Type parameters

Name Type
T any

Type declaration

▸ (chunk): number

{@inheritDoc QueuingStrategy.size}

Parameters
Name Type
chunk T
Returns

number

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:98

Readable

Ƭ Readable: SelectType<manual.Readable, Readable>

Defined in

node_modules/openai/_shims/index.d.ts:60

ReadableByteStream

Ƭ ReadableByteStream: ReadableStream<Uint8Array> & { _readableStreamController: ReadableByteStreamController }

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:92

ReadableStreamBYOBReadResult

Ƭ ReadableStreamBYOBReadResult<T>: { done: false ; value: T } | { done: true ; value: T | undefined }

A result returned by ReadableStreamBYOBReader.read.

Type parameters

Name Type
T extends ArrayBufferView

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:269

ReadableStreamBYOBReadResult

Ƭ ReadableStreamBYOBReadResult<T>: { done: false ; value: T } | { done: true ; value: T | undefined }

A result returned by ReadableStreamBYOBReader.read.

Type parameters

Name Type
T extends ArrayBufferView

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:273

ReadableStreamController

Ƭ ReadableStreamController<T>: ReadableStreamDefaultController<T>

Type parameters

Name
T

Defined in

node_modules/@types/node/stream/web.d.ts:76

ReadableStreamDefaultReadResult

Ƭ ReadableStreamDefaultReadResult<T>: ReadableStreamDefaultReadValueResult<T> | ReadableStreamDefaultReadDoneResult

Type parameters

Name
T

Defined in

node_modules/@types/node/stream/web.d.ts:77

ReadableStreamDefaultReadResult

Ƭ ReadableStreamDefaultReadResult<T>: { done: false ; value: T } | { done: true ; value?: undefined }

A result returned by ReadableStreamDefaultReader.read.

Type parameters

Name
T

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:372

ReadableStreamDefaultReadResult

Ƭ ReadableStreamDefaultReadResult<T>: { done: false ; value: T } | { done: true ; value?: undefined }

A result returned by ReadableStreamDefaultReader.read.

Type parameters

Name
T

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:376

ReadableStreamReadResult

Ƭ ReadableStreamReadResult<T>: ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>

Type parameters

Name
T

Defined in

node_modules/@types/node/stream/web.d.ts:88

Record

Ƭ Record<K, T>: { [P in K]: T }

Construct a type with a set of properties K of type T

Type parameters

Name Type
K extends keyof any
T T

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1605

RequestClient

Ƭ RequestClient: Object

Type declaration

Name Type
fetch Fetch

Defined in

node_modules/openai/core.d.ts:173

RequestContext

Ƭ RequestContext: "audio" | "beacon" | "cspreport" | "download" | "embed" | "eventsource" | "favicon" | "fetch" | "font" | "form" | "frame" | "hyperlink" | "iframe" | "image" | "imageset" | "import" | "internal" | "location" | "manifest" | "object" | "ping" | "plugin" | "prefetch" | "script" | "serviceworker" | "sharedworker" | "style" | "subresource" | "track" | "video" | "worker" | "xmlhttprequest" | "xslt"

Defined in

node_modules/@types/node-fetch/index.d.ts:48

RequestInfo

Ƭ RequestInfo: string | URLLike | Request

Defined in

node_modules/@types/node-fetch/index.d.ts:203

RequestInfo

Ƭ RequestInfo: SelectType<manual.RequestInfo, RequestInfo>

Defined in

node_modules/openai/_shims/index.d.ts:21

RequestInfo

Ƭ RequestInfo: RequestInfo

Defined in

node_modules/openai/_shims/node-types.d.ts:15

RequestInit

Ƭ RequestInit: SelectType<manual.RequestInit, RequestInit>

Defined in

node_modules/openai/_shims/index.d.ts:23

RequestInit

Ƭ RequestInit: RequestInit

Defined in

node_modules/openai/_shims/node-types.d.ts:16

RequestRedirect

Ƭ RequestRedirect: "error" | "follow" | "manual"

Defined in

node_modules/@types/node-fetch/index.d.ts:83

Response

Ƭ Response: SelectType<manual.Response, Response>

Defined in

node_modules/openai/_shims/index.d.ts:26

Response

Ƭ Response: Response

Defined in

node_modules/openai/_shims/node-types.d.ts:18

ResponseType

Ƭ ResponseType: "basic" | "cors" | "default" | "error" | "opaque" | "opaqueredirect"

Defined in

node_modules/@types/node-fetch/index.d.ts:172

ReturnType

Ƭ ReturnType<T>: T extends (...args: any) => infer R ? R : any

Obtain the return type of a function type

Type parameters

Name Type
T extends (...args: any) => any

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1642

RunnableFunction

Ƭ RunnableFunction<Args>: Args extends string ? RunnableFunctionWithoutParse : Args extends object ? RunnableFunctionWithParse<Args> : never

Type parameters

Name Type
Args extends object | string

Defined in

node_modules/openai/lib/RunnableFunction.d.ts:49

RunnableFunctionWithParse

Ƭ RunnableFunctionWithParse<Args>: Object

Type parameters

Name Type
Args extends object

Type declaration

Name Type Description
description string A description of what the function does, used by the model to choose when and how to call the function.
function (args: Args, runner: ChatCompletionRunner | ChatCompletionStreamingRunner) => PromiseOrValue<unknown>
name? string The name of the function to be called. Will default to function.name if omitted.
parameters JSONSchema The parameters the function accepts, describes as a JSON Schema object.
parse (input: string) => PromiseOrValue<Args>

Defined in

node_modules/openai/lib/RunnableFunction.d.ts:5

RunnableFunctionWithoutParse

Ƭ RunnableFunctionWithoutParse: Object

Type declaration

Name Type Description
description string A description of what the function does, used by the model to choose when and how to call the function.
function (args: string, runner: ChatCompletionRunner | ChatCompletionStreamingRunner) => PromiseOrValue<unknown>
name? string The name of the function to be called. Will default to function.name if omitted.
parameters JSONSchema The parameters the function accepts, describes as a JSON Schema object.

Defined in

node_modules/openai/lib/RunnableFunction.d.ts:30

RunnableFunctions

Ƭ RunnableFunctions<FunctionsArgs>: [any[]] extends [FunctionsArgs] ? readonly RunnableFunction<any>[] : { [Index in keyof FunctionsArgs]: Index extends number ? RunnableFunction<FunctionsArgs[Index]> : FunctionsArgs[Index] }

Type parameters

Name Type
FunctionsArgs extends BaseFunctionsArgs

Defined in

node_modules/openai/lib/RunnableFunction.d.ts:56

RunnableToolFunction

Ƭ RunnableToolFunction<Args>: Object

Type parameters

Name Type
Args extends object | string

Type declaration

Name Type
function RunnableFunction<Args>
type "function"

Defined in

node_modules/openai/lib/RunnableFunction.d.ts:50

RunnableTools

Ƭ RunnableTools<FunctionsArgs>: [any[]] extends [FunctionsArgs] ? readonly RunnableToolFunction<any>[] : { [Index in keyof FunctionsArgs]: Index extends number ? RunnableToolFunction<FunctionsArgs[Index]> : FunctionsArgs[Index] }

Type parameters

Name Type
FunctionsArgs extends BaseFunctionsArgs

Defined in

node_modules/openai/lib/RunnableFunction.d.ts:61

SelectType

Ƭ SelectType<Manual, Auto>: unknown extends Manual ? Auto : Manual

Type parameters

Name
Manual
Auto

Defined in

node_modules/openai/_shims/index.d.ts:8

SocketConnectOpts

Ƭ SocketConnectOpts: TcpSocketConnectOpts | IpcSocketConnectOpts

Defined in

node_modules/@types/node/net.d.ts:76

SocketReadyState

Ƭ SocketReadyState: "opening" | "open" | "readOnly" | "writeOnly" | "closed"

Defined in

node_modules/@types/node/net.d.ts:77

ToFileInput

Ƭ ToFileInput: Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>

Defined in

node_modules/openai/uploads.d.ts:56

TypedArray

Ƭ TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array

Defined in

node_modules/@types/node/globals.d.ts:259

UnderlyingByteSourcePullCallback

Ƭ UnderlyingByteSourcePullCallback: (controller: ReadableByteStreamController) => void | PromiseLike<void>

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller ReadableByteStreamController
Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:543

UnderlyingByteSourcePullCallback

Ƭ UnderlyingByteSourcePullCallback: (controller: ReadableByteStreamController) => void | PromiseLike<void>

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller ReadableByteStreamController
Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:547

UnderlyingByteSourceStartCallback

Ƭ UnderlyingByteSourceStartCallback: (controller: ReadableByteStreamController) => void | PromiseLike<void>

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller ReadableByteStreamController
Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:546

UnderlyingByteSourceStartCallback

Ƭ UnderlyingByteSourceStartCallback: (controller: ReadableByteStreamController) => void | PromiseLike<void>

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller ReadableByteStreamController
Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:550

UnderlyingSinkAbortCallback

Ƭ UnderlyingSinkAbortCallback: (reason: any) => void | PromiseLike<void>

Type declaration

▸ (reason): void | PromiseLike<void>

Parameters
Name Type
reason any
Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:593

UnderlyingSinkAbortCallback

Ƭ UnderlyingSinkAbortCallback: (reason: any) => void | PromiseLike<void>

Type declaration

▸ (reason): void | PromiseLike<void>

Parameters
Name Type
reason any
Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:597

UnderlyingSinkCloseCallback

Ƭ UnderlyingSinkCloseCallback: () => void | PromiseLike<void>

Type declaration

▸ (): void | PromiseLike<void>

Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:596

UnderlyingSinkCloseCallback

Ƭ UnderlyingSinkCloseCallback: () => void | PromiseLike<void>

Type declaration

▸ (): void | PromiseLike<void>

Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:600

UnderlyingSinkStartCallback

Ƭ UnderlyingSinkStartCallback: (controller: WritableStreamDefaultController) => void | PromiseLike<void>

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller WritableStreamDefaultController
Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:599

UnderlyingSinkStartCallback

Ƭ UnderlyingSinkStartCallback: (controller: WritableStreamDefaultController) => void | PromiseLike<void>

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller WritableStreamDefaultController
Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:603

UnderlyingSinkWriteCallback

Ƭ UnderlyingSinkWriteCallback<W>: (chunk: W, controller: WritableStreamDefaultController) => void | PromiseLike<void>

Type parameters

Name
W

Type declaration

▸ (chunk, controller): void | PromiseLike<void>

Parameters
Name Type
chunk W
controller WritableStreamDefaultController
Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:602

UnderlyingSinkWriteCallback

Ƭ UnderlyingSinkWriteCallback<W>: (chunk: W, controller: WritableStreamDefaultController) => void | PromiseLike<void>

Type parameters

Name
W

Type declaration

▸ (chunk, controller): void | PromiseLike<void>

Parameters
Name Type
chunk W
controller WritableStreamDefaultController
Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:606

UnderlyingSourceCancelCallback

Ƭ UnderlyingSourceCancelCallback: (reason: any) => void | PromiseLike<void>

Type declaration

▸ (reason): void | PromiseLike<void>

Parameters
Name Type
reason any
Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:632

UnderlyingSourceCancelCallback

Ƭ UnderlyingSourceCancelCallback: (reason: any) => void | PromiseLike<void>

Type declaration

▸ (reason): void | PromiseLike<void>

Parameters
Name Type
reason any
Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:636

UnderlyingSourcePullCallback

Ƭ UnderlyingSourcePullCallback<R>: (controller: ReadableStreamDefaultController<R>) => void | PromiseLike<void>

Type parameters

Name
R

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller ReadableStreamDefaultController<R>
Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:635

UnderlyingSourcePullCallback

Ƭ UnderlyingSourcePullCallback<R>: (controller: ReadableStreamDefaultController<R>) => void | PromiseLike<void>

Type parameters

Name
R

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller ReadableStreamDefaultController<R>
Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:639

UnderlyingSourceStartCallback

Ƭ UnderlyingSourceStartCallback<R>: (controller: ReadableStreamDefaultController<R>) => void | PromiseLike<void>

Type parameters

Name
R

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller ReadableStreamDefaultController<R>
Returns

void | PromiseLike<void>

Defined in

node_modules/web-streams-polyfill/dist/types/ts3.6/polyfill.d.ts:638

UnderlyingSourceStartCallback

Ƭ UnderlyingSourceStartCallback<R>: (controller: ReadableStreamDefaultController<R>) => void | PromiseLike<void>

Type parameters

Name
R

Type declaration

▸ (controller): void | PromiseLike<void>

Parameters
Name Type
controller ReadableStreamDefaultController<R>
Returns

void | PromiseLike<void>

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:642

Uploadable

Ƭ Uploadable: FileLike | ResponseLike | FsReadStream

Typically, this is a native "File" class.

We provide the toFile utility to convert a variety of objects into the File class.

For convenience, you can also pass a fetch Response, or in Node, the result of fs.createReadStream().

Defined in

node_modules/openai/uploads.d.ts:16

WithImplicitCoercion

Ƭ WithImplicitCoercion<T>: T | { valueOf: () => T }

Type parameters

Name
T

Defined in

node_modules/@types/node/buffer.d.ts:245

__Event

Ƭ __Event: typeof globalThis extends { Event: any ; onmessage: any } ? {} : { bubbles: boolean ; cancelBubble: () => void ; cancelable: boolean ; composed: boolean ; currentTarget: EventTarget | null ; defaultPrevented: boolean ; eventPhase: 0 | 2 ; isTrusted: boolean ; returnValue: boolean ; srcElement: EventTarget | null ; target: EventTarget | null ; timeStamp: number ; type: string ; composedPath: () => [EventTarget?] ; preventDefault: () => void ; stopImmediatePropagation: () => void ; stopPropagation: () => void }

Defined in

node_modules/@types/node/dom-events.d.ts:11

__EventTarget

Ƭ __EventTarget: typeof globalThis extends { EventTarget: any ; onmessage: any } ? {} : { addEventListener: (type: string, listener: EventListener | EventListenerObject, options?: boolean | AddEventListenerOptions) => void ; dispatchEvent: (event: Event) => boolean ; removeEventListener: (type: string, listener: EventListener | EventListenerObject, options?: boolean | EventListenerOptions) => void }

Defined in

node_modules/@types/node/dom-events.d.ts:50

Variables

AbortController

• AbortController: Object

Call signature

• new AbortController(): AbortController

Returns

AbortController

Type declaration

Name Type
prototype AbortController

Defined in

node_modules/@types/node/globals.d.ts:47

node_modules/@types/node/globals.d.ts:70

AbortSignal

• AbortSignal: Object

Call signature

• new AbortSignal(): AbortSignal

Returns

AbortSignal

Type declaration

Name Type
prototype AbortSignal
abort (reason?: any) => AbortSignal
timeout (milliseconds: number) => AbortSignal

Defined in

node_modules/@types/node/globals.d.ts:60

node_modules/@types/node/globals.d.ts:76

Buffer

• Buffer: BufferConstructor

Defined in

node_modules/@types/node/buffer.d.ts:631

node_modules/@types/node/buffer.d.ts:2314

Event

• Event: Object

Call signature

• new Event(type, eventInitDict?): Object

Parameters
Name Type
type string
eventInitDict? EventInit
Returns

Object

Name Type Description
bubbles boolean This is not used in Node.js and is provided purely for completeness.
cancelBubble () => void Alias for event.stopPropagation(). This is not used in Node.js and is provided purely for completeness.
cancelable boolean True if the event was created with the cancelable option
composed boolean This is not used in Node.js and is provided purely for completeness.
currentTarget null | EventTarget Alias for event.target.
defaultPrevented boolean Is true if cancelable is true and event.preventDefault() has been called.
eventPhase 0 | 2 This is not used in Node.js and is provided purely for completeness.
isTrusted boolean The AbortSignal "abort" event is emitted with isTrusted set to true. The value is false in all other cases.
returnValue boolean This is not used in Node.js and is provided purely for completeness.
srcElement null | EventTarget Alias for event.target.
target null | EventTarget The EventTarget dispatching the event
timeStamp number The millisecond timestamp when the Event object was created.
type string Returns the type of event, e.g. "click", "hashchange", or "submit".
composedPath () => [EventTarget?] Returns an array containing the current EventTarget as the only entry or empty if the event is not being dispatched. This is not used in Node.js and is provided purely for completeness.
preventDefault () => void Sets the defaultPrevented property to true if cancelable is true.
stopImmediatePropagation () => void Stops the invocation of event listeners after the current one completes.
stopPropagation () => void This is not used in Node.js and is provided purely for completeness.

Type declaration

Name Type
prototype { bubbles: boolean ; cancelBubble: () => void ; cancelable: boolean ; composed: boolean ; currentTarget: null | EventTarget ; defaultPrevented: boolean ; eventPhase: 0 | 2 ; isTrusted: boolean ; returnValue: boolean ; srcElement: null | EventTarget ; target: null | EventTarget ; timeStamp: number ; type: string ; composedPath: () => [EventTarget?] ; preventDefault: () => void ; stopImmediatePropagation: () => void ; stopPropagation: () => void }
prototype.bubbles boolean
prototype.cancelBubble () => void
prototype.cancelable boolean
prototype.composed boolean
prototype.currentTarget null | EventTarget
prototype.defaultPrevented boolean
prototype.eventPhase 0 | 2
prototype.isTrusted boolean
prototype.returnValue boolean
prototype.srcElement null | EventTarget
prototype.target null | EventTarget
prototype.timeStamp number
prototype.type string
prototype.composedPath [object Object]
prototype.preventDefault [object Object]
prototype.stopImmediatePropagation [object Object]
prototype.stopPropagation [object Object]

Defined in

node_modules/@types/node/dom-events.d.ts:105

node_modules/@types/node/dom-events.d.ts:106

EventTarget

• EventTarget: Object

Call signature

• new EventTarget(): Object

Returns

Object

Name Type
addEventListener (type: string, listener: EventListener | EventListenerObject, options?: boolean | AddEventListenerOptions) => void
dispatchEvent (event: Event) => boolean
removeEventListener (type: string, listener: EventListener | EventListenerObject, options?: boolean | EventListenerOptions) => void

Type declaration

Name Type
prototype { addEventListener: (type: string, listener: EventListener | EventListenerObject, options?: boolean | AddEventListenerOptions) => void ; dispatchEvent: (event: Event) => boolean ; removeEventListener: (type: string, listener: EventListener | EventListenerObject, options?: boolean | EventListenerOptions) => void }
prototype.addEventListener [object Object]
prototype.dispatchEvent [object Object]
prototype.removeEventListener [object Object]

Defined in

node_modules/@types/node/dom-events.d.ts:116

node_modules/@types/node/dom-events.d.ts:117

File

• File: any

Defined in

node_modules/openai/_shims/index.d.ts:51

node_modules/openai/_shims/index.d.ts:53

File

• File: typeof File

Defined in

node_modules/openai/_shims/node-types.d.ts:39

node_modules/openai/_shims/node-types.d.ts:40

ReadableByteStreamController

• ReadableByteStreamController: Object

Call signature

• new ReadableByteStreamController(): ReadableByteStreamController

Returns

ReadableByteStreamController

Type declaration

Name Type
prototype ReadableByteStreamController

Defined in

node_modules/@types/node/stream/web.d.ts:176

node_modules/@types/node/stream/web.d.ts:183

ReadableStream

• ReadableStream: Object

Call signature

• new ReadableStream(underlyingSource, strategy?): ReadableStream<Uint8Array>

Parameters
Name Type
underlyingSource UnderlyingByteSource
strategy? QueuingStrategy<Uint8Array>
Returns

ReadableStream<Uint8Array>

• new ReadableStream<R>(underlyingSource?, strategy?): ReadableStream<R>

Type parameters
Name Type
R any
Parameters
Name Type
underlyingSource? UnderlyingSource<R>
strategy? QueuingStrategy<R>
Returns

ReadableStream<R>

Type declaration

Name Type
prototype ReadableStream<any>

Defined in

node_modules/@types/node/stream/web.d.ts:146

node_modules/@types/node/stream/web.d.ts:157

ReadableStreamBYOBReader

• ReadableStreamBYOBReader: any

Defined in

node_modules/@types/node/stream/web.d.ts:166

node_modules/@types/node/stream/web.d.ts:174

ReadableStreamDefaultController

• ReadableStreamDefaultController: Object

Call signature

• new ReadableStreamDefaultController(): ReadableStreamDefaultController<any>

Returns

ReadableStreamDefaultController<any>

Type declaration

Name Type
prototype ReadableStreamDefaultController<any>

Defined in

node_modules/@types/node/stream/web.d.ts:187

node_modules/@types/node/stream/web.d.ts:193

ReadableStreamDefaultReader

• ReadableStreamDefaultReader: Object

Call signature

• new ReadableStreamDefaultReader<R>(stream): ReadableStreamDefaultReader<R>

Type parameters
Name Type
R any
Parameters
Name Type
stream ReadableStream<R>
Returns

ReadableStreamDefaultReader<R>

Type declaration

Name Type
prototype ReadableStreamDefaultReader<any>

Defined in

node_modules/@types/node/stream/web.d.ts:162

node_modules/@types/node/stream/web.d.ts:170

SharedArrayBuffer

• SharedArrayBuffer: SharedArrayBufferConstructor

Defined in

node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:22

node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:40

URL

• URL: typeof URL

URL class is a global reference for require('url').URL https://nodejs.org/api/url.html#the-whatwg-url-api

Since

v10.0.0

Defined in

node_modules/@types/node/url.d.ts:898

node_modules/@types/node/url.d.ts:908

WritableStream

• WritableStream: Object

Call signature

• new WritableStream<W>(underlyingSink?, strategy?): WritableStream<W>

Type parameters
Name Type
W any
Parameters
Name Type
underlyingSink? UnderlyingSink<W>
strategy? QueuingStrategy<W>
Returns

WritableStream<W>

Type declaration

Name Type
prototype WritableStream<any>

Defined in

node_modules/@types/node/stream/web.d.ts:231

node_modules/@types/node/stream/web.d.ts:237

WritableStreamDefaultController

• WritableStreamDefaultController: Object

Call signature

• new WritableStreamDefaultController(): WritableStreamDefaultController

Returns

WritableStreamDefaultController

Type declaration

Name Type
prototype WritableStreamDefaultController

Defined in

node_modules/@types/node/stream/web.d.ts:266

node_modules/@types/node/stream/web.d.ts:269

WritableStreamDefaultWriter

• WritableStreamDefaultWriter: Object

Call signature

• new WritableStreamDefaultWriter<W>(stream): WritableStreamDefaultWriter<W>

Type parameters
Name Type
W any
Parameters
Name Type
stream WritableStream<W>
Returns

WritableStreamDefaultWriter<W>

Type declaration

Name Type
prototype WritableStreamDefaultWriter<any>

Defined in

node_modules/@types/node/stream/web.d.ts:247

node_modules/@types/node/stream/web.d.ts:256

Functions

Object

▸ Object(): any

Provides functionality common to all JavaScript objects.

Returns

any

Defined in

node_modules/typescript/lib/lib.es5.d.ts:157

▸ Object(value): any

Provides functionality common to all JavaScript objects.

Parameters

Name Type
value any

Returns

any

Defined in

node_modules/typescript/lib/lib.es5.d.ts:158

Typescript Libraries

Modules

Namespaces

Clone this wiki locally