MessageStream | mongodb

A duplex stream that is capable of reading and writing raw wire protocol messages, with support for optional compression

internal

Hierarchy

Duplex
- MessageStream

Index

Constructors

constructor

Methods

Constructors

constructor

new MessageStream(options?: MessageStreamOptions): MessageStream

Overrides Duplex.constructor
- Defined in src/cmap/message_stream.ts:56
Parameters
- options: MessageStreamOptions = {}
Returns MessageStream

Properties

[kBuffer]

[kBuffer]: BufferPool

internal

destroyed

destroyed: boolean

maxBsonMessageSize

maxBsonMessageSize: number

internal

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

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

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 Duplex.__@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 Duplex._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 Duplex._destroy
- Defined in node_modules/@types/node/stream.d.ts:261
Parameters
- error: null | Error
- callback: (error: null | Error) => void
  - - (error: null | Error): void
    - Parameters
      - error: null | Error
      Returns void
Returns void

_final

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

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

_read

_read(): void

Overrides Duplex._read
- Defined in src/cmap/message_stream.ts:67
Returns void

_write

_write(chunk: Buffer, _: unknown, callback: Callback<Buffer>): void

Overrides Duplex._write
- Defined in src/cmap/message_stream.ts:62
Parameters
- chunk: Buffer
- _: unknown
- callback: Callback<Buffer>
Returns void

Optional _writev

_writev(chunks: { chunk: any; encoding: BufferEncoding }[], callback: (error?: null | Error) => void): void

Inherited from Duplex._writev
- Defined in node_modules/@types/node/stream.d.ts:260
Parameters
- chunks: { chunk: any; encoding: BufferEncoding }[]
- callback: (error?: null | Error) => void
  - - (error?: null | Error): void
    - Parameters
      - Optional error: null | Error
      Returns void
Returns void

addListener

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

Inherited from Duplex.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 MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.addListener
- Defined in node_modules/@types/node/stream.d.ts:70
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.addListener
- Defined in node_modules/@types/node/stream.d.ts:72
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.addListener
- Defined in node_modules/@types/node/stream.d.ts:73
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.addListener
- Defined in node_modules/@types/node/stream.d.ts:74
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream

cork

cork(): void

Inherited from Duplex.cork
- Defined in node_modules/@types/node/stream.d.ts:269
Returns void

destroy

destroy(error?: Error): void

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

end

end(cb?: () => void): void
end(chunk: any, cb?: () => void): void
end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void

Inherited from Duplex.end
- Defined in node_modules/@types/node/stream.d.ts:266
Parameters
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void
Inherited from Duplex.end
- Defined in node_modules/@types/node/stream.d.ts:267
Parameters
- chunk: any
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void
Inherited from Duplex.end
- Defined in node_modules/@types/node/stream.d.ts:268
Parameters
- chunk: any
- Optional encoding: BufferEncoding
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void

eventNames

eventNames(): (string | symbol)[]

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

getMaxListeners

getMaxListeners(): number

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

isPaused

isPaused(): boolean

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

listenerCount

listenerCount(event: string | symbol): number

Inherited from Duplex.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 Duplex.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): MessageStream

Inherited from Duplex.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 MessageStream

on

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

Inherited from Duplex.on
- Defined in node_modules/@types/node/stream.d.ts:86
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.on
- Defined in node_modules/@types/node/stream.d.ts:88
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.on
- Defined in node_modules/@types/node/stream.d.ts:90
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.on
- Defined in node_modules/@types/node/stream.d.ts:91
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.on
- Defined in node_modules/@types/node/stream.d.ts:92
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream

once

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

Inherited from Duplex.once
- Defined in node_modules/@types/node/stream.d.ts:95
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.once
- Defined in node_modules/@types/node/stream.d.ts:97
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.once
- Defined in node_modules/@types/node/stream.d.ts:99
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.once
- Defined in node_modules/@types/node/stream.d.ts:100
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.once
- Defined in node_modules/@types/node/stream.d.ts:101
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream

pause

pause(): MessageStream

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

pipe

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

Inherited from Duplex.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): MessageStream
prependListener(event: "data", listener: (chunk: any) => void): MessageStream
prependListener(event: "end", listener: () => void): MessageStream
prependListener(event: "error", listener: (err: Error) => void): MessageStream
prependListener(event: "pause", listener: () => void): MessageStream
prependListener(event: "readable", listener: () => void): MessageStream
prependListener(event: "resume", listener: () => void): MessageStream
prependListener(event: string | symbol, listener: (...args: any[]) => void): MessageStream

Inherited from Duplex.prependListener
- Defined in node_modules/@types/node/stream.d.ts:104
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.prependListener
- Defined in node_modules/@types/node/stream.d.ts:106
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.prependListener
- Defined in node_modules/@types/node/stream.d.ts:108
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.prependListener
- Defined in node_modules/@types/node/stream.d.ts:109
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.prependListener
- Defined in node_modules/@types/node/stream.d.ts:110
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream

prependOnceListener

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

Inherited from Duplex.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:113
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:115
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:117
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:118
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:119
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream

push

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

Inherited from Duplex.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 Duplex.rawListeners
- Defined in node_modules/@types/node/events.d.ts:81
Parameters
- event: string | symbol
Returns Function[]

read

read(size?: number): any

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

removeAllListeners

removeAllListeners(event?: string | symbol): MessageStream

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

removeListener

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

Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:122
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:124
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:126
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:127
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:128
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns MessageStream
Inherited from Duplex.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 MessageStream

resume

resume(): MessageStream

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

setDefaultEncoding

setDefaultEncoding(encoding: BufferEncoding): MessageStream

Inherited from Duplex.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:265
Parameters
- encoding: BufferEncoding
Returns MessageStream

setEncoding

setEncoding(encoding: BufferEncoding): MessageStream

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

setMaxListeners

setMaxListeners(n: number): MessageStream

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

uncork

uncork(): void

Inherited from Duplex.uncork
- Defined in node_modules/@types/node/stream.d.ts:270
Returns void

unpipe

unpipe(destination?: WritableStream): MessageStream

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

unshift

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

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

wrap

wrap(oldStream: ReadableStream): MessageStream

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

write

write(chunk: any, encoding?: BufferEncoding, cb?: (error: undefined | null | Error) => void): boolean
write(chunk: any, cb?: (error: undefined | null | Error) => void): boolean

Inherited from Duplex.write
- Defined in node_modules/@types/node/stream.d.ts:263
Parameters
- chunk: any
- Optional encoding: BufferEncoding
- Optional cb: (error: undefined | null | Error) => void
  - - (error: undefined | null | Error): void
    - Parameters
      - error: undefined | null | Error
      Returns void
Returns boolean
Inherited from Duplex.write
- Defined in node_modules/@types/node/stream.d.ts:264
Parameters
- chunk: any
- Optional cb: (error: undefined | null | Error) => void
  - - (error: undefined | null | Error): void
    - Parameters
      - error: undefined | null | Error
      Returns void
Returns boolean

writeCommand

writeCommand(command: WriteProtocolMessageType, operationDescription: OperationDescription): void

- Defined in src/cmap/message_stream.ts:73
Parameters
- command: WriteProtocolMessageType
- operationDescription: OperationDescription
Returns void

Static from

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

Inherited from Duplex.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 Duplex.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 Duplex.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 Duplex.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 Duplex.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 Duplex.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

Properties

Methods

Constructors

constructor

Parameters

options: MessageStreamOptions = {}

Returns MessageStream

Properties

[kBuffer]

destroyed

maxBsonMessageSize

readable

Readonly readableEncoding

Readonly readableEnded

Readonly readableFlowing

Readonly readableHighWaterMark

Readonly readableLength

Readonly readableObjectMode

Readonly writable

Readonly writableCorked

Readonly writableEnded

Readonly writableFinished

Readonly writableHighWaterMark

Readonly writableLength

Readonly writableObjectMode

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

error: null | Error

Returns void

Returns void

_final

Parameters

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

Parameters

Optional error: null | Error

Returns void

Returns void

_read

Returns void

_write

Parameters

chunk: Buffer

_: unknown

callback: Callback<Buffer>

Returns void

Optional _writev

Parameters

chunks: { chunk: any; encoding: BufferEncoding }[]

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

Parameters

Optional error: null | Error

Returns void

Returns void

addListener

Parameters

event: "close"

listener: () => void

Returns void

Returns MessageStream

Parameters