Options
All
  • Public
  • Public/Protected
  • All
Menu

Class 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事件

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

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>
  • Returns返回AsyncIterableIterator<any>

Optional _construct

  • _construct(callback: (error?: null | Error) => void): void
  • 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
  • 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
  • Reads from the cursor and pushes to the stream. Private Impl, do not call directly

    internal

    Returns返回void

abort

  • abort(callback?: Callback<void>): void
  • 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

  • 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

  • Parameters参数

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void
        • Parameters参数

          • chunk: any

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "end"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters参数

          • err: Error

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "pause"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "readable"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "resume"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters参数

          • Rest ...args: any[]

          Returns返回void

    Returns返回GridFSBucketReadStream

destroy

  • destroy(error?: Error): void
  • 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
  • Parameters参数

    • event: "close"

    Returns返回boolean

  • Parameters参数

    • event: "data"
    • chunk: any

    Returns返回boolean

  • Parameters参数

    • event: "end"

    Returns返回boolean

  • Parameters参数

    • event: "error"
    • err: Error

    Returns返回boolean

  • Parameters参数

    • event: "pause"

    Returns返回boolean

  • Parameters参数

    • event: "readable"

    Returns返回boolean

  • Parameters参数

    • event: "resume"

    Returns返回boolean

  • Parameters参数

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

    Returns返回boolean

end

  • 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)[]
  • Returns返回(string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • Returns返回number

isPaused

  • isPaused(): boolean
  • Returns返回boolean

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters参数

    • event: string | symbol

    Returns返回number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters参数

    • event: string | symbol

    Returns返回Function[]

off

  • Parameters参数

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters参数

          • Rest ...args: any[]

          Returns返回void

    Returns返回GridFSBucketReadStream

on

  • Parameters参数

    • event: "close"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void
        • Parameters参数

          • chunk: any

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "end"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters参数

          • err: Error

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "pause"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "readable"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "resume"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters参数

          • Rest ...args: any[]

          Returns返回void

    Returns返回GridFSBucketReadStream

once

  • Parameters参数

    • event: "close"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void
        • Parameters参数

          • chunk: any

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "end"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters参数

          • err: Error

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "pause"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "readable"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "resume"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters参数

          • Rest ...args: any[]

          Returns返回void

    Returns返回GridFSBucketReadStream

pause

  • Returns返回GridFSBucketReadStream

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T
  • Type parameters类型参数

    • T: WritableStream<T>

    Parameters参数

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns返回T

prependListener

  • Parameters参数

    • event: "close"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void
        • Parameters参数

          • chunk: any

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "end"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters参数

          • err: Error

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "pause"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "readable"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "resume"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters参数

          • Rest ...args: any[]

          Returns返回void

    Returns返回GridFSBucketReadStream

prependOnceListener

  • Parameters参数

    • event: "close"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void
        • Parameters参数

          • chunk: any

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "end"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters参数

          • err: Error

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "pause"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "readable"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "resume"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • 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
  • Parameters参数

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns返回boolean

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters参数

    • event: string | symbol

    Returns返回Function[]

read

  • read(size?: number): any
  • Parameters参数

    • Optional size: number

    Returns返回any

removeAllListeners

  • Parameters参数

    • Optional event: string | symbol

    Returns返回GridFSBucketReadStream

removeListener

  • Parameters参数

    • event: "close"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void
        • Parameters参数

          • chunk: any

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "end"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters参数

          • err: Error

          Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "pause"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "readable"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: "resume"
    • listener: () => void
        • (): void
        • Returns返回void

    Returns返回GridFSBucketReadStream

  • Parameters参数

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters参数

          • Rest ...args: any[]

          Returns返回void

    Returns返回GridFSBucketReadStream

resume

  • Returns返回GridFSBucketReadStream

setEncoding

  • Parameters参数

    • encoding: BufferEncoding

    Returns返回GridFSBucketReadStream

setMaxListeners

  • Parameters参数

    • n: number

    Returns返回GridFSBucketReadStream

start

  • 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

  • Parameters参数

    • Optional destination: WritableStream

    Returns返回GridFSBucketReadStream

unshift

  • unshift(chunk: any, encoding?: BufferEncoding): void
  • Parameters参数

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns返回void

wrap

  • Parameters参数

    • oldStream: ReadableStream

    Returns返回GridFSBucketReadStream

Static from

  • from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable
  • 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[]
  • 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
  • deprecated

    since v4.0.0

    Parameters参数

    • emitter: EventEmitter
    • event: string | symbol

    Returns返回number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • 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[]>
  • Parameters参数

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns返回Promise<any[]>

  • Parameters参数

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns返回Promise<any[]>

Generated using TypeDoc