GridFSBucketReadStream | mongodb (original) (raw)

Optional_construct

• _construct(callback): void

• Parameters

  • callback: ((error?: null | Error) => void)
    * * (error?): void
    * #### Parameters
    * Optionalerror: null | Error
    #### Returns void

Returns void

_destroy

• _destroy(error, callback): void

• Parameters

  • error: null | Error
  • callback: ((error?: null | Error) => void)
    * * (error?): void
    * #### Parameters
    * Optionalerror: null | Error
    #### Returns void

Returns void

[asyncDispose]

• [asyncDispose](): Promise<void>

• Returns Promise<void>

[asyncIterator]

• [asyncIterator](): AsyncIterator<any, any, any>

• Returns AsyncIterator<any, any, any>

Optional[captureRejectionSymbol]

• [captureRejectionSymbol]<K>(error, event, ...args): void

• Type Parameters

  • K

Parameters

• error: Error
• event: string | symbol
• Rest...args: AnyRest

Returns void

abort

• abort(): Promise<void>

• Returns Promise<void>

addListener

• addListener(event, listener): this

• Parameters

  • event: "close"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Parameters

  • event: "data"
  • listener: ((chunk: any) => void)
    * * (chunk): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Parameters

  • event: "end"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Parameters

  • event: "error"
  • listener: ((err: Error) => void)
    * * (err): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Parameters

  • event: "pause"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Parameters

  • event: "readable"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Parameters

  • event: "resume"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Parameters

  • event: string | symbol
  • listener: ((...args: any[]) => void)
    * * (...args): void
    * #### Parameters
    * Rest...args: any[]
    #### Returns void

Returns this

asIndexedPairs

• asIndexedPairs(options?): Readable

• Parameters

  • Optionaloptions: Pick<ArrayOptions, "signal">

Returns Readable

a stream of indexed pairs.

compose

• compose<T>(stream, options?): T

• Type Parameters

  • T extends ReadableStream

Parameters

• stream:
  | ComposeFnParam
  | T
  | Iterable<T>
  | AsyncIterable<T>
• Optionaloptions: {
  signal: AbortSignal;
  }
  * ##### signal: AbortSignal

Returns T

destroy

• destroy(error?): this

• Parameters

  • Optionalerror: Error

Returns this

drop

• drop(limit, options?): Readable

• Parameters

  • limit: number
  • Optionaloptions: Pick<ArrayOptions, "signal">

Returns Readable

a stream with limit chunks dropped from the start.

emit

• emit(event): boolean

• Returns boolean

• emit(event, chunk): boolean

• Parameters

  • event: "data"
  • chunk: any

Returns boolean

• emit(event): boolean

• Returns boolean

• emit(event, err): boolean

• Parameters

  • event: "error"
  • err: Error

Returns boolean

• emit(event): boolean

• Returns boolean

• emit(event): boolean

• Parameters

  • event: "readable"

Returns boolean

• emit(event): boolean

• Parameters

  • event: "resume"

Returns boolean

• emit(event, ...args): boolean

• Parameters

  • event: string | symbol
  • Rest...args: any[]

Returns boolean

end

• end(end?): this

• Parameters

  • end: number = 0

Returns this

eventNames

• eventNames(): (string | symbol)[]

• Returns (string | symbol)[]

every

• every(fn, options?): Promise<boolean>

• Parameters

  • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)
    * * (data, options?): boolean | Promise<boolean>
    * #### Parameters
    * data: any
    * Optionaloptions: Pick<ArrayOptions, "signal">
    #### Returns boolean | Promise<boolean>
  • Optionaloptions: ArrayOptions

Returns Promise<boolean>

a promise evaluating to true if fn returned a truthy value for every one of the chunks.

filter

• filter(fn, options?): Readable

• Parameters

  • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)
    * * (data, options?): boolean | Promise<boolean>
    * #### Parameters
    * data: any
    * Optionaloptions: Pick<ArrayOptions, "signal">
    #### Returns boolean | Promise<boolean>
  • Optionaloptions: ArrayOptions

Returns Readable

a stream filtered with the predicate fn.

find

• find<T>(fn, options?): Promise<undefined | T>

• Type Parameters

  • T

Parameters

• fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => data is T)
  * * (data, options?): data is T
  * #### Parameters
  * data: any
  * Optionaloptions: Pick<ArrayOptions, "signal">
  #### Returns data is T
• Optionaloptions: ArrayOptions

Returns Promise<undefined | T>

a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

• find(fn, options?): Promise<any>

• Parameters

  • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)
    * * (data, options?): boolean | Promise<boolean>
    * #### Parameters
    * data: any
    * Optionaloptions: Pick<ArrayOptions, "signal">
    #### Returns boolean | Promise<boolean>
  • Optionaloptions: ArrayOptions

Returns Promise<any>

flatMap

• flatMap(fn, options?): Readable

• Parameters

  • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => any)
    * * (data, options?): any
    * #### Parameters
    * data: any
    * Optionaloptions: Pick<ArrayOptions, "signal">
    #### Returns any
  • Optionaloptions: ArrayOptions

Returns Readable

a stream flat-mapped with the function fn.

forEach

• forEach(fn, options?): Promise<void>

• Parameters

  • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => void | Promise<void>)
    * * (data, options?): void | Promise<void>
    * #### Parameters
    * data: any
    * Optionaloptions: Pick<ArrayOptions, "signal">
    #### Returns void | Promise<void>
  • Optionaloptions: ArrayOptions

Returns Promise<void>

a promise for when the stream has finished.

getMaxListeners

• getMaxListeners(): number

• Returns number

isPaused

• isPaused(): boolean

• Returns boolean

iterator

• iterator(options?): AsyncIterator<any, any, any>

• Parameters

  • Optionaloptions: {
    destroyOnReturn?: boolean;
    }
    * ##### OptionaldestroyOnReturn?: boolean

Returns AsyncIterator<any, any, any>

listenerCount

• listenerCount<K>(eventName, listener?): number

• Type Parameters

  • K

Parameters

• eventName: string | symbol
• Optionallistener: Function

Returns number

listeners

• listeners<K>(eventName): Function[]

• Type Parameters

  • K

Parameters

• eventName: string | symbol

Returns Function[]

map

• map(fn, options?): Readable

• Parameters

  • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => any)
    * * (data, options?): any
    * #### Parameters
    * data: any
    * Optionaloptions: Pick<ArrayOptions, "signal">
    #### Returns any
  • Optionaloptions: ArrayOptions

Returns Readable

a stream mapped with the function fn.

off

• off<K>(eventName, listener): this

• Type Parameters

  • K

Parameters

• eventName: string | symbol
• listener: ((...args: any[]) => void)
  * * (...args): void
  * #### Parameters
  * Rest...args: any[]
  #### Returns void

Returns this

on

• on(event, listener): this

• Parameters

  • event: "close"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• on(event, listener): this

• Parameters

  • event: "data"
  • listener: ((chunk: any) => void)
    * * (chunk): void
    * #### Returns void

Returns this

• on(event, listener): this

• Parameters

  • event: "end"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• on(event, listener): this

• Parameters

  • event: "error"
  • listener: ((err: Error) => void)
    * * (err): void
    * #### Returns void

Returns this

• on(event, listener): this

• Parameters

  • event: "pause"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• on(event, listener): this

• Parameters

  • event: "readable"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• on(event, listener): this

• Parameters

  • event: "resume"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• on(event, listener): this

• Parameters

  • event: string | symbol
  • listener: ((...args: any[]) => void)
    * * (...args): void
    * #### Parameters
    * Rest...args: any[]
    #### Returns void

Returns this

once

• once(event, listener): this

• Parameters

  • event: "close"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• once(event, listener): this

• Parameters

  • event: "data"
  • listener: ((chunk: any) => void)
    * * (chunk): void
    * #### Returns void

Returns this

• once(event, listener): this

• Parameters

  • event: "end"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• once(event, listener): this

• Parameters

  • event: "error"
  • listener: ((err: Error) => void)
    * * (err): void
    * #### Returns void

Returns this

• once(event, listener): this

• Parameters

  • event: "pause"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• once(event, listener): this

• Parameters

  • event: "readable"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• once(event, listener): this

• Parameters

  • event: "resume"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• once(event, listener): this

• Parameters

  • event: string | symbol
  • listener: ((...args: any[]) => void)
    * * (...args): void
    * #### Parameters
    * Rest...args: any[]
    #### Returns void

Returns this

pause

• pause(): this

• Returns this

pipe

• pipe<T>(destination, options?): T

• Type Parameters

  • T extends WritableStream

Parameters

• destination: T
• Optionaloptions: {
  end?: boolean;
  }
  * ##### Optionalend?: boolean

Returns T

prependListener

• prependListener(event, listener): this

• Parameters

  • event: "close"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Parameters

  • event: "data"
  • listener: ((chunk: any) => void)
    * * (chunk): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Parameters

  • event: "end"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Parameters

  • event: "error"
  • listener: ((err: Error) => void)
    * * (err): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Parameters

  • event: "pause"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Parameters

  • event: "readable"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Parameters

  • event: "resume"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Parameters

  • event: string | symbol
  • listener: ((...args: any[]) => void)
    * * (...args): void
    * #### Parameters
    * Rest...args: any[]
    #### Returns void

Returns this

prependOnceListener

• prependOnceListener(event, listener): this

• Parameters

  • event: "close"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: "data"
  • listener: ((chunk: any) => void)
    * * (chunk): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: "end"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: "error"
  • listener: ((err: Error) => void)
    * * (err): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: "pause"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: "readable"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: "resume"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: string | symbol
  • listener: ((...args: any[]) => void)
    * * (...args): void
    * #### Parameters
    * Rest...args: any[]
    #### Returns void

Returns this

push

• push(chunk, encoding?): boolean

• Parameters

  • chunk: any
  • Optionalencoding: BufferEncoding

Returns boolean

rawListeners

• rawListeners<K>(eventName): Function[]

• Type Parameters

  • K

Parameters

• eventName: string | symbol

Returns Function[]

read

• read(size?): any

• Parameters

  • Optionalsize: number

Returns any

reduce

• reduce<T>(fn, initial?, options?): Promise<T>

• Type Parameters

  • T = any

Parameters

• fn: ((previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T)
  * * (previous, data, options?): T
  * #### Parameters
  * previous: any
  * data: any
  * Optionaloptions: Pick<ArrayOptions, "signal">
  #### Returns T
• Optionalinitial: undefined
• Optionaloptions: Pick<ArrayOptions, "signal">

Returns Promise<T>

a promise for the final value of the reduction.

• reduce<T>(fn, initial, options?): Promise<T>

• Type Parameters

  • T = any

Parameters

• fn: ((previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T)
  * * (previous, data, options?): T
  * #### Parameters
  * previous: T
  * data: any
  * Optionaloptions: Pick<ArrayOptions, "signal">
  #### Returns T
• initial: T
• Optionaloptions: Pick<ArrayOptions, "signal">

Returns Promise<T>

removeAllListeners

• removeAllListeners(eventName?): this

• Parameters

  • OptionaleventName: string | symbol

Returns this

removeListener

• removeListener(event, listener): this

• Parameters

  • event: "close"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Parameters

  • event: "data"
  • listener: ((chunk: any) => void)
    * * (chunk): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Parameters

  • event: "end"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Parameters

  • event: "error"
  • listener: ((err: Error) => void)
    * * (err): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Parameters

  • event: "pause"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Parameters

  • event: "readable"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Parameters

  • event: "resume"
  • listener: (() => void)
    * * (): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Parameters

  • event: string | symbol
  • listener: ((...args: any[]) => void)
    * * (...args): void
    * #### Parameters
    * Rest...args: any[]
    #### Returns void

Returns this

resume

• resume(): this

• Returns this

setEncoding

• setEncoding(encoding): this

• Parameters

  • encoding: BufferEncoding

Returns this

setMaxListeners

• setMaxListeners(n): this

• Returns this

some

• some(fn, options?): Promise<boolean>

• Parameters

  • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)
    * * (data, options?): boolean | Promise<boolean>
    * #### Parameters
    * data: any
    * Optionaloptions: Pick<ArrayOptions, "signal">
    #### Returns boolean | Promise<boolean>
  • Optionaloptions: ArrayOptions

Returns Promise<boolean>

a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

start

• start(start?): this

• Parameters

  • start: number = 0

Returns this

take

• take(limit, options?): Readable

• Parameters

  • limit: number
  • Optionaloptions: Pick<ArrayOptions, "signal">

Returns Readable

a stream with limit chunks taken.

toArray

• toArray(options?): Promise<any[]>

• Parameters

  • Optionaloptions: Pick<ArrayOptions, "signal">

Returns Promise<any[]>

a promise containing an array with the contents of the stream.

unpipe

• unpipe(destination?): this

• Parameters

  • Optionaldestination: WritableStream

Returns this

unshift

• unshift(chunk, encoding?): void

• Parameters

  • chunk: any
  • Optionalencoding: BufferEncoding

Returns void

wrap

• wrap(stream): this

• Parameters

  • stream: ReadableStream

Returns this

StaticaddAbortListener

• addAbortListener(signal, resource): Disposable
• Experimental

Parameters

• signal: AbortSignal
• resource: ((event: Event) => void)
  * * (event): void
  * #### Returns void

Returns Disposable

Disposable that removes the abort listener.

Staticfrom

• from(iterable, options?): Readable

• Parameters

  • iterable: Iterable<any> | AsyncIterable<any>
  • Optionaloptions: ReadableOptions

Returns Readable

StaticfromWeb

• fromWeb(readableStream, options?): Readable
• Experimental

Parameters

• readableStream: ReadableStream<any>
• Optionaloptions: Pick<ReadableOptions,
  | "signal"
  | "objectMode"
  | "highWaterMark"
  | "encoding">

Returns Readable

StaticgetEventListeners

• getEventListeners(emitter, name): Function[]

• Parameters

  • emitter: EventEmitter<DefaultEventMap> | EventTarget
  • name: string | symbol

Returns Function[]

StaticgetMaxListeners

• getMaxListeners(emitter): number

• Parameters

  • emitter: EventEmitter<DefaultEventMap> | EventTarget

Returns number

StaticisDisturbed

• isDisturbed(stream): boolean

• Parameters

  • stream: Readable | ReadableStream

Returns boolean

StaticlistenerCount

• listenerCount(emitter, eventName): number

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol

Returns number

Staticon

• on(emitter, eventName, options?): AsyncIterator<any[], any, any>

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol
  • Optionaloptions: StaticEventEmitterIteratorOptions

Returns AsyncIterator<any[], any, any>

An AsyncIterator that iterates eventName events emitted by the emitter

• on(emitter, eventName, options?): AsyncIterator<any[], any, any>

• Parameters

  • emitter: EventTarget
  • eventName: string
  • Optionaloptions: StaticEventEmitterIteratorOptions

Returns AsyncIterator<any[], any, any>

Staticonce

• once(emitter, eventName, options?): Promise<any[]>

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol
  • Optionaloptions: StaticEventEmitterOptions

Returns Promise<any[]>

• once(emitter, eventName, options?): Promise<any[]>

• Parameters

  • emitter: EventTarget
  • eventName: string
  • Optionaloptions: StaticEventEmitterOptions

Returns Promise<any[]>

StaticsetMaxListeners

• setMaxListeners(n?, ...eventTargets): void

• Parameters

  • Optionaln: number
  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

Returns void

StatictoWeb

• toWeb(streamReadable, options?): ReadableStream<any>
• Experimental

Parameters

• streamReadable: Readable
• Optionaloptions: {
  strategy?: QueuingStrategy<any>;
  }
  * ##### Optionalstrategy?: QueuingStrategy<any>

Returns ReadableStream<any>