GridFSBucketReadStream

A readable stream that enables you to read buffers from GridFS.

Do not instantiate this class directly. Use openDownloadStream() instead.

Hierarchy

Readable
- GridFSBucketReadStream

Index

Constructors

constructor

Events

Properties

Methods

Constructors

constructor

new GridFSBucketReadStream(chunks: Collection<GridFSChunk>, files: Collection<GridFSFile>, readPreference: undefined | ReadPreference, filter: Document, options?: GridFSBucketReadStreamOptions): GridFSBucketReadStream

Overrides Readable.constructor
- Defined in src/gridfs/download.ts:112
internal

Parameters
- chunks: Collection<GridFSChunk>
  
  Handle for chunks collection
- files: Collection<GridFSFile>
  
  Handle for files collection
- readPreference: undefined | ReadPreference
  
  The read preference to use
- filter: Document
  
  The filter to use to find the file document
- Optional options: GridFSBucketReadStreamOptions
Returns GridFSBucketReadStream

Events

Static Readonly CLOSE

CLOSE: "close" = ...

Fired when the stream is exhausted and the underlying cursor is killed

Static Readonly DATA

DATA: "data" = ...

Emitted when a chunk of data is available to be consumed.

Static Readonly END

END: "end" = ...

Fired when the stream is exhausted (no more data events).

Static Readonly ERROR

ERROR: "error" = ...

An error occurred

Static Readonly FILE

FILE: "file" = ...

Fires when the stream loaded the file document corresponding to the provided id.

Properties

destroyed

destroyed: boolean

readable

readable: boolean

Readonly readableEncoding

readableEncoding: null | BufferEncoding

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: null | boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

s

s: GridFSBucketReadStreamPrivate

internal

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<any>

Inherited from Readable.__@asyncIterator@1425
- Defined in node_modules/@types/node/stream.d.ts:131
Returns AsyncIterableIterator<any>

Optional _construct

_construct(callback: (error?: null | Error) => void): void

Inherited from Readable._construct
- Defined in node_modules/@types/node/stream.d.ts:43
Parameters
- callback: (error?: null | Error) => void
  - - (error?: null | Error): void
    - Parameters
      - Optional error: null | Error
      Returns void
Returns void

_destroy

_destroy(error: null | Error, callback: (error?: null | Error) => void): void

Inherited from Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:54
Parameters
- error: null | Error
- callback: (error?: null | Error) => void
  - - (error?: null | Error): void
    - Parameters
      - Optional error: null | Error
      Returns void
Returns void

_read

_read(): void

Overrides Readable._read
- Defined in src/gridfs/download.ts:144
Reads from the cursor and pushes to the stream. Private Impl, do not call directly

internal

Returns void

abort

abort(callback?: Callback<void>): void

- Defined in src/gridfs/download.ts:182
Marks this stream as aborted (will never push another data event) and kills the underlying cursor. Will emit the 'end' event, and then the 'close' event once the cursor is successfully killed.

Parameters
- Optional callback: Callback<void>
  
  called when the cursor is successfully closed or an error occurred.
Returns void

addListener

addListener(event: "close", listener: () => void): GridFSBucketReadStream
addListener(event: "data", listener: (chunk: any) => void): GridFSBucketReadStream
addListener(event: "end", listener: () => void): GridFSBucketReadStream
addListener(event: "error", listener: (err: Error) => void): GridFSBucketReadStream
addListener(event: "pause", listener: () => void): GridFSBucketReadStream
addListener(event: "readable", listener: () => void): GridFSBucketReadStream
addListener(event: "resume", listener: () => void): GridFSBucketReadStream
addListener(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketReadStream

Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:68
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. error
5. pause
6. readable
7. resume
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:69
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:70
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:71
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:72
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:73
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:74
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketReadStream

destroy

destroy(error?: Error): void

Inherited from Readable.destroy
- Defined in node_modules/@types/node/stream.d.ts:55
Parameters
- Optional error: Error
Returns void

emit

emit(event: "close"): boolean
emit(event: "data", chunk: any): boolean
emit(event: "end"): boolean
emit(event: "error", err: Error): boolean
emit(event: "pause"): boolean
emit(event: "readable"): boolean
emit(event: "resume"): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:77
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:78
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:79
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:80
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:81
Parameters
- event: "pause"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:82
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:83
Parameters
- event: "resume"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:84
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

end

end(end?: number): GridFSBucketReadStream

- Defined in src/gridfs/download.ts:169
Sets the 0-based offset in bytes to start streaming from. Throws an error if this stream has entered flowing mode (e.g. if you've already called on('data'))

Parameters
- end: number = 0
  
  Offset in bytes to stop reading at
Returns GridFSBucketReadStream

eventNames

eventNames(): (string | symbol)[]

Inherited from Readable.eventNames
- Defined in node_modules/@types/node/events.d.ts:87
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from Readable.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:79
Returns number

isPaused

isPaused(): boolean

Inherited from Readable.isPaused
- Defined in node_modules/@types/node/stream.d.ts:49
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from Readable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:83
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from Readable.listeners
- Defined in node_modules/@types/node/events.d.ts:80
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketReadStream

Inherited from Readable.off
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketReadStream

on

on(event: "close", listener: () => void): GridFSBucketReadStream
on(event: "data", listener: (chunk: any) => void): GridFSBucketReadStream
on(event: "end", listener: () => void): GridFSBucketReadStream
on(event: "error", listener: (err: Error) => void): GridFSBucketReadStream
on(event: "pause", listener: () => void): GridFSBucketReadStream
on(event: "readable", listener: () => void): GridFSBucketReadStream
on(event: "resume", listener: () => void): GridFSBucketReadStream
on(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketReadStream

Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:86
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:87
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:88
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:89
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:90
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:91
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:92
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:93
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketReadStream

once

once(event: "close", listener: () => void): GridFSBucketReadStream
once(event: "data", listener: (chunk: any) => void): GridFSBucketReadStream
once(event: "end", listener: () => void): GridFSBucketReadStream
once(event: "error", listener: (err: Error) => void): GridFSBucketReadStream
once(event: "pause", listener: () => void): GridFSBucketReadStream
once(event: "readable", listener: () => void): GridFSBucketReadStream
once(event: "resume", listener: () => void): GridFSBucketReadStream
once(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketReadStream

Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:95
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:96
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:97
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:98
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:99
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:100
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:101
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:102
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketReadStream

pause

pause(): GridFSBucketReadStream

Inherited from Readable.pause
- Defined in node_modules/@types/node/stream.d.ts:47
Returns GridFSBucketReadStream

pipe

pipe<T>(destination: T, options?: { end?: boolean }): T

Inherited from Readable.pipe
- Defined in node_modules/@types/node/stream.d.ts:6
Type parameters
- T: WritableStream<T>
Parameters
- destination: T
- Optional options: { end?: boolean }
  - Optional end?: boolean
Returns T

prependListener

prependListener(event: "close", listener: () => void): GridFSBucketReadStream
prependListener(event: "data", listener: (chunk: any) => void): GridFSBucketReadStream
prependListener(event: "end", listener: () => void): GridFSBucketReadStream
prependListener(event: "error", listener: (err: Error) => void): GridFSBucketReadStream
prependListener(event: "pause", listener: () => void): GridFSBucketReadStream
prependListener(event: "readable", listener: () => void): GridFSBucketReadStream
prependListener(event: "resume", listener: () => void): GridFSBucketReadStream
prependListener(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketReadStream

Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:104
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:105
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:106
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:107
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:108
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:109
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:110
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:111
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketReadStream

prependOnceListener

prependOnceListener(event: "close", listener: () => void): GridFSBucketReadStream
prependOnceListener(event: "data", listener: (chunk: any) => void): GridFSBucketReadStream
prependOnceListener(event: "end", listener: () => void): GridFSBucketReadStream
prependOnceListener(event: "error", listener: (err: Error) => void): GridFSBucketReadStream
prependOnceListener(event: "pause", listener: () => void): GridFSBucketReadStream
prependOnceListener(event: "readable", listener: () => void): GridFSBucketReadStream
prependOnceListener(event: "resume", listener: () => void): GridFSBucketReadStream
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketReadStream

Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:113
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:114
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:115
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:116
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:117
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:118
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:119
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:120
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketReadStream

push

push(chunk: any, encoding?: BufferEncoding): boolean

Inherited from Readable.push
- Defined in node_modules/@types/node/stream.d.ts:53
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns boolean

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from Readable.rawListeners
- Defined in node_modules/@types/node/events.d.ts:81
Parameters
- event: string | symbol
Returns Function[]

read

read(size?: number): any

Inherited from Readable.read
- Defined in node_modules/@types/node/stream.d.ts:45
Parameters
- Optional size: number
Returns any

removeAllListeners

removeAllListeners(event?: string | symbol): GridFSBucketReadStream

Inherited from Readable.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:77
Parameters
- Optional event: string | symbol
Returns GridFSBucketReadStream

removeListener

removeListener(event: "close", listener: () => void): GridFSBucketReadStream
removeListener(event: "data", listener: (chunk: any) => void): GridFSBucketReadStream
removeListener(event: "end", listener: () => void): GridFSBucketReadStream
removeListener(event: "error", listener: (err: Error) => void): GridFSBucketReadStream
removeListener(event: "pause", listener: () => void): GridFSBucketReadStream
removeListener(event: "readable", listener: () => void): GridFSBucketReadStream
removeListener(event: "resume", listener: () => void): GridFSBucketReadStream
removeListener(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketReadStream

Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:122
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:123
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:124
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:125
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketReadStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:126
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:127
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:128
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketReadStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:129
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketReadStream

resume

resume(): GridFSBucketReadStream

Inherited from Readable.resume
- Defined in node_modules/@types/node/stream.d.ts:48
Returns GridFSBucketReadStream

setEncoding

setEncoding(encoding: BufferEncoding): GridFSBucketReadStream

Inherited from Readable.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:46
Parameters
- encoding: BufferEncoding
Returns GridFSBucketReadStream

setMaxListeners

setMaxListeners(n: number): GridFSBucketReadStream

Inherited from Readable.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:78
Parameters
- n: number
Returns GridFSBucketReadStream

start

start(start?: number): GridFSBucketReadStream

- Defined in src/gridfs/download.ts:156
Sets the 0-based offset in bytes to start streaming from. Throws an error if this stream has entered flowing mode (e.g. if you've already called on('data'))

Parameters
- start: number = 0
  
  0-based offset in bytes to start streaming from
Returns GridFSBucketReadStream

unpipe

unpipe(destination?: WritableStream): GridFSBucketReadStream

Inherited from Readable.unpipe
- Defined in node_modules/@types/node/stream.d.ts:50
Parameters
- Optional destination: WritableStream
Returns GridFSBucketReadStream

unshift

unshift(chunk: any, encoding?: BufferEncoding): void

Inherited from Readable.unshift
- Defined in node_modules/@types/node/stream.d.ts:51
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns void

wrap

wrap(oldStream: ReadableStream): GridFSBucketReadStream

Inherited from Readable.wrap
- Defined in node_modules/@types/node/stream.d.ts:52
Parameters
- oldStream: ReadableStream
Returns GridFSBucketReadStream

Static from

from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable

Inherited from Readable.from
- Defined in node_modules/@types/node/stream.d.ts:32
A utility method for creating Readable Streams out of iterators.

Parameters
- iterable: Iterable<any> | AsyncIterable<any>
- Optional options: ReadableOptions
Returns Readable

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

Inherited from Readable.getEventListener
- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: DOMEventTarget | EventEmitter
- name: string | symbol
Returns Function[]

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Readable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:30
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

Inherited from Readable.on
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: EventEmitter
- event: string
- Optional options: StaticEventEmitterOptions
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

Inherited from Readable.once
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- emitter: NodeEventTarget
- event: string | symbol
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Inherited from Readable.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Hierarchy

Index

Constructors

Events

Properties

Methods

Constructors

constructor

Parameters

chunks: Collection<GridFSChunk>

files: Collection<GridFSFile>

readPreference: undefined | ReadPreference

filter: Document

Optional options: GridFSBucketReadStreamOptions

Returns GridFSBucketReadStream

Events

Static Readonly CLOSE

Static Readonly DATA

Static Readonly END

Static Readonly ERROR

Static Readonly FILE

Properties

destroyed

readable

Readonly readableEncoding

Readonly readableEnded

Readonly readableFlowing

Readonly readableHighWaterMark

Readonly readableLength

Readonly readableObjectMode

s

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

[asyncIterator]

Returns AsyncIterableIterator<any>

Optional _construct

Parameters

callback: (error?: null | Error) => void

Parameters

Optional error: null | Error

Returns void

Returns void

_destroy

Parameters

error: null | Error

callback: (error?: null | Error) => void

Parameters

Optional error: null | Error

Returns void

Returns void

_read

Returns void

abort

Parameters

Optional callback: Callback<void>

Returns void

addListener

Parameters

event: "close"

listener: () => void

Returns void

Returns GridFSBucketReadStream

Parameters

event: "data"

listener: (chunk: any) => void

Parameters

chunk: any

Returns void

Returns GridFSBucketReadStream

Parameters

event: "end"

listener: () => void

Returns void

Returns GridFSBucketReadStream

Parameters

event: "error"

listener: (err: Error) => void