GridFSBucketReadStream

GridFSBucketReadStream.

see: https://mongodb.github.io/node-mongodb-native/2.1/api/GridFSBucketReadStream.html

Hierarchy

Readable
- GridFSBucketReadStream

Implements

ReadableStream

Index

Constructors

constructor

Properties

Constructors

constructor

new GridFSBucketReadStream(chunks: Collection, files: Collection, readPreference: Object, filter: Object, options?: GridFSBucketReadStreamOptions): GridFSBucketReadStream

Overrides Readable.__constructor
- Defined in driver/mongodb/typings.ts:5556
Parameters
- chunks: Collection
  
  Handle for chunks collection.
- files: Collection
  
  Handle for files collection.
- readPreference: Object
  
  The read preference to use.
- filter: Object
  
  The query to use to find the file document.
- Optional options: GridFSBucketReadStreamOptions
  
  Optional settings.
Returns GridFSBucketReadStream

Properties

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

_destroy(err: Error, callback: Function): void

Inherited from Readable._destroy
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5396
Parameters
- err: Error
- callback: Function
Returns void

_read

_read(size: number): void

Inherited from Readable._read
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5386
Parameters
- size: number
Returns void

addListener

addListener(event: string, listener: function): this
addListener(event: "close", listener: function): this
addListener(event: "data", listener: function): this
addListener(event: "end", listener: function): this
addListener(event: "readable", listener: function): this
addListener(event: "error", listener: function): this

Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5408
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. readable
5. error
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5409
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5410
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5411
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5412
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5413
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this

destroy

destroy(error?: Error): void

Inherited from Readable.destroy
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5397
Parameters
- Optional error: Error
Returns void

emit

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

Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5415
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5416
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5417
Parameters
- event: "data"
- chunk: Buffer | string
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5418
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5419
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5420
Parameters
- event: "error"
- err: Error
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:1015
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:1011
Returns number

isPaused

isPaused(): boolean

Inherited from Readable.isPaused
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5391
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:1016
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:1012
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string, listener: function): this
on(event: "close", listener: function): this
on(event: "data", listener: function): this
on(event: "end", listener: function): this
on(event: "readable", listener: function): this
on(event: "error", listener: function): this

Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5422
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5423
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5424
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5425
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5426
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5427
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this

once

once(event: string, listener: function): this
once(event: "close", listener: function): this
once(event: "data", listener: function): this
once(event: "end", listener: function): this
once(event: "readable", listener: function): this
once(event: "error", listener: function): this

Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5429
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5430
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5431
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5432
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5433
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5434
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this

pause

pause(): this

Inherited from Readable.pause
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5389
Returns this

pipe

pipe<T>(destination: T, options?: undefined | object): T

Inherited from internal.pipe
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5367
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: undefined | object
Returns T

prependListener

prependListener(event: string, listener: function): this
prependListener(event: "close", listener: function): this
prependListener(event: "data", listener: function): this
prependListener(event: "end", listener: function): this
prependListener(event: "readable", listener: function): this
prependListener(event: "error", listener: function): this

Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5436
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5437
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5438
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5439
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5440
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5441
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string, listener: function): this
prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "data", listener: function): this
prependOnceListener(event: "end", listener: function): this
prependOnceListener(event: "readable", listener: function): this
prependOnceListener(event: "error", listener: function): this

Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5443
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5444
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5445
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5446
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5447
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5448
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this

push

push(chunk: any, encoding?: undefined | string): boolean

Inherited from Readable.push
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5395
Parameters
- chunk: any
- Optional encoding: undefined | string
Returns boolean

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:1013
Parameters
- event: string | symbol
Returns Function[]

read

read(size?: undefined | number): any

Inherited from Readable.read
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5387
Parameters
- Optional size: undefined | number
Returns any

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:1009
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string, listener: function): this
removeListener(event: "close", listener: function): this
removeListener(event: "data", listener: function): this
removeListener(event: "end", listener: function): this
removeListener(event: "readable", listener: function): this
removeListener(event: "error", listener: function): this

Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5450
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5451
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5452
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5453
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5454
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5455
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this

resume

resume(): this

Inherited from Readable.resume
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5390
Returns this

setEncoding

setEncoding(encoding: string): this

Inherited from Readable.setEncoding
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5388
Parameters
- encoding: string
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:1010
Parameters
- n: number
Returns this

unpipe

unpipe<T>(destination?: T): this

Inherited from Readable.unpipe
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5392
Type parameters
- T: WritableStream
Parameters
- Optional destination: T
Returns this

unshift

unshift(chunk: any): void

Inherited from Readable.unshift
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5393
Parameters
- chunk: any
Returns void

wrap

wrap(oldStream: ReadableStream): this

Inherited from Readable.wrap
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:5394
Parameters
- oldStream: ReadableStream
Returns this

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /Users/lesha/trunk/sandbox/typeorm/node_modules/@types/node/index.d.ts:1000
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

chunks: Collection

files: Collection

readPreference: Object

filter: Object

Optional options: GridFSBucketReadStreamOptions

Returns GridFSBucketReadStream

Properties

readable

readableHighWaterMark

readableLength

Static defaultMaxListeners

Methods

_destroy

Parameters

err: Error

callback: Function

Returns void

_read

Parameters

size: number

Returns void

addListener

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "data"

listener: function

Parameters

chunk: Buffer | string

Returns void

Returns this

Parameters

event: "end"

listener: function

Returns void

Returns this

Parameters

event: "readable"

listener: function

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

destroy

Parameters

Optional error: Error

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Parameters

event: "close"

Returns boolean

Parameters