BufferWritableMock | Stream Mock

BufferWritableMock is a writable stream working in normal (buffer) mode.

example

import { BufferWritableMock } from 'stream-mock';

const writer = new BufferWritableMock();
writer.write('l', err => {
  if (!err) console.log(writer.data);
});
writer.end();
writer.on('finish', () => console.log(writer.flatData.toString()));

>
[ <Buffer 6c> ]
l

Hierarchy

Writable
- BufferWritableMock

Implements

WritableStream
IWritableMock

Index

Constructors

constructor

Properties

Constructors

constructor

new BufferWritableMock(options?: WritableOptions): BufferWritableMock

Overrides Writable.__constructor
- Defined in writable/BufferWritableMock.ts:39
Parameters
- Default value options: WritableOptions = {}
  
  Writable options. objectMode will be overwritten to false.
Returns BufferWritableMock

Properties

data

data: Buffer[]

Internal buffer, filled on every write

flatData

flatData: Buffer

Data flattern, filled on final callback (when BufferWritableMock.end) is called.

writable

writable: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

_destroy(error: Error | null, callback: function): void

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

_final

_final(callback: function): void

Overrides Writable._final
- Defined in writable/BufferWritableMock.ts:61
Parameters
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_write

_write(chunk: Buffer | string, encoding: BufferEncoding, callback: function): void

Overrides Writable._write
- Defined in writable/BufferWritableMock.ts:51
Parameters
- chunk: Buffer | string
- encoding: BufferEncoding
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

Optional _writev

_writev(chunks: Array<object>, callback: function): void

Inherited from Writable._writev
- Defined in node_modules/@types/node/stream.d.ts:118
Parameters
- chunks: Array<object>
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

addListener(event: "close", listener: function): this
addListener(event: "drain", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: "finish", listener: function): this
addListener(event: "pipe", listener: function): this
addListener(event: "unpipe", listener: function): this
addListener(event: string | symbol, listener: function): this

Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:141
Event emitter The defined events on documents including:
1. close
2. drain
3. error
4. finish
5. pipe
6. unpipe
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:142
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:143
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:144
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:145
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:146
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:147
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

cork

cork(): void

Implementation of IWritableMock.cork

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

destroy

destroy(error?: Error): void

Implementation of IWritableMock.destroy

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

emit

emit(event: "close"): boolean
emit(event: "drain"): boolean
emit(event: "error", err: Error): boolean
emit(event: "finish"): boolean
emit(event: "pipe", src: Readable): boolean
emit(event: "unpipe", src: Readable): boolean
emit(event: string | symbol, ...args: any[]): boolean

Implementation of IWritableMock.emit

Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:149
Parameters
- event: "close"
Returns boolean
Implementation of IWritableMock.emit

Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:150
Parameters
- event: "drain"
Returns boolean
Implementation of IWritableMock.emit

Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:151
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of IWritableMock.emit

Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:152
Parameters
- event: "finish"
Returns boolean
Implementation of IWritableMock.emit

Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:153
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Implementation of IWritableMock.emit

Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:154
Parameters
- event: "unpipe"
- src: Readable
Returns boolean
Implementation of IWritableMock.emit

Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:155
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

end

end(cb?: function): void
end(chunk: any, cb?: function): void
end(chunk: any, encoding: string, cb?: function): void

Inherited from Writable.end
- Defined in node_modules/@types/node/stream.d.ts:124
Parameters
- Optional cb: function
  - - (): void
    - Returns void
Returns void
Inherited from Writable.end
- Defined in node_modules/@types/node/stream.d.ts:125
Parameters
- chunk: any
- Optional cb: function
  - - (): void
    - Returns void
Returns void
Inherited from Writable.end
- Defined in node_modules/@types/node/stream.d.ts:126
Parameters
- chunk: any
- encoding: string
- Optional cb: function
  - - (): void
    - Returns void
Returns void

eventNames

eventNames(): Array<string | symbol>

Implementation of IWritableMock.eventNames

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Implementation of IWritableMock.getMaxListeners

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(type: string | symbol): number

Implementation of IWritableMock.listenerCount

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Implementation of IWritableMock.listeners

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:17
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "close", listener: function): this
on(event: "drain", listener: function): this
on(event: "error", listener: function): this
on(event: "finish", listener: function): this
on(event: "pipe", listener: function): this
on(event: "unpipe", listener: function): this
on(event: string | symbol, listener: function): this

Inherited from Writable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:157
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:158
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:159
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:160
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:161
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:162
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:163
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: "close", listener: function): this
once(event: "drain", listener: function): this
once(event: "error", listener: function): this
once(event: "finish", listener: function): this
once(event: "pipe", listener: function): this
once(event: "unpipe", listener: function): this
once(event: string | symbol, listener: function): this

Inherited from Writable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:165
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:166
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:167
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:168
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:169
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:170
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:171
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pipe

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

Inherited from internal.pipe
- Defined in node_modules/@types/node/stream.d.ts:5
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: object
  - Optional end?: boolean
Returns T

prependListener

prependListener(event: "close", listener: function): this
prependListener(event: "drain", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: "finish", listener: function): this
prependListener(event: "pipe", listener: function): this
prependListener(event: "unpipe", listener: function): this
prependListener(event: string | symbol, listener: function): this

Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:173
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:174
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:175
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:176
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:177
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:178
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:179
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "drain", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "finish", listener: function): this
prependOnceListener(event: "pipe", listener: function): this
prependOnceListener(event: "unpipe", listener: function): this
prependOnceListener(event: string | symbol, listener: function): this

Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:181
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:182
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:183
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:184
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:185
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:186
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:187
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Implementation of IWritableMock.rawListeners

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of IWritableMock.removeAllListeners

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "close", listener: function): this
removeListener(event: "drain", listener: function): this
removeListener(event: "error", listener: function): this
removeListener(event: "finish", listener: function): this
removeListener(event: "pipe", listener: function): this
removeListener(event: "unpipe", listener: function): this
removeListener(event: string | symbol, listener: function): this

Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:189
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:190
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:191
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:192
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:193
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:194
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:195
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setDefaultEncoding

setDefaultEncoding(encoding: string): this

Implementation of IWritableMock.setDefaultEncoding

Inherited from Writable.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:123
Parameters
- encoding: string
Returns this

setMaxListeners

setMaxListeners(n: number): this

Implementation of IWritableMock.setMaxListeners

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

uncork

uncork(): void

Implementation of IWritableMock.uncork

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

write

write(chunk: any, cb?: function): boolean
write(chunk: any, encoding: string, cb?: function): boolean

Inherited from Writable.write
- Defined in node_modules/@types/node/stream.d.ts:121
Parameters
- chunk: any
- Optional cb: function
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean
Inherited from Writable.write
- Defined in node_modules/@types/node/stream.d.ts:122
Parameters
- chunk: any
- encoding: string
- Optional cb: function
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean

Static listenerCount

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

Implementation of IWritableMock.listenerCount

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

since v4.0.0

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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value options: WritableOptions = {}

Returns BufferWritableMock

Properties

data

flatData

writable

writableHighWaterMark

writableLength

Static defaultMaxListeners

Methods

_destroy

Parameters

error: Error | null

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

_final

Parameters

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

_write

Parameters

chunk: Buffer | string

encoding: BufferEncoding

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

Optional _writev

Parameters

chunks: Array<object>

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

addListener

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "drain"

listener: function

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "finish"

listener: function

Returns void

Returns this

Parameters

event: "pipe"

listener: function

Parameters

src: Readable

Returns void