MockWritable | Typed

Hierarchy

Writable
- MockWritable

Implements

WritableStream

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MockWritable(options?: WritableOptions): MockWritable

Overrides Writable.__constructor
- Defined in packages/node/source/stdio/MockWritable.ts:5
Parameters
- Optional options: WritableOptions
Returns MockWritable

Properties

Private _data

_data: any[] = []

destroyed

destroyed: 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

Methods

_destroy

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

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

_final

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

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

_write

_write(data: Buffer | string, encoding: string, callback: Function): void

Overrides Writable._write
- Defined in packages/node/source/stdio/MockWritable.ts:26
Parameters
- data: Buffer | string
- encoding: string
- callback: Function
Returns void

Optional _writev

_writev(chunks: Array<{ chunk: any; encoding: string }>, callback: (error?: Error | null) => void): void

Inherited from MockWritable._writev
- Defined in node_modules/@types/node/stream.d.ts:150
Parameters
- chunks: Array<{ chunk: any; encoding: string }>
- callback: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

addListener(event: "close", listener: () => void): this
addListener(event: "drain", listener: () => void): this
addListener(event: "error", listener: (err: Error) => void): this
addListener(event: "finish", listener: () => void): this
addListener(event: "pipe", listener: (src: Readable) => void): this
addListener(event: "unpipe", listener: (src: Readable) => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockWritable.addListener

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

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

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

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

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

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

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

cork

cork(): void

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

data

data(): any[]

- Defined in packages/node/source/stdio/MockWritable.ts:22
Returns any[]

destroy

destroy(error?: Error): void

Inherited from MockWritable.destroy
- Defined in node_modules/@types/node/stream.d.ts:161
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

Inherited from MockWritable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:181
Parameters
- event: "close"
Returns boolean
Inherited from MockWritable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:182
Parameters
- event: "drain"
Returns boolean
Inherited from MockWritable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:183
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from MockWritable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:184
Parameters
- event: "finish"
Returns boolean
Inherited from MockWritable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:185
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Inherited from MockWritable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:186
Parameters
- event: "unpipe"
- src: Readable
Returns boolean
Inherited from MockWritable.emit

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

end

end(): void

Overrides Writable.end
- Defined in packages/node/source/stdio/MockWritable.ts:11
Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from MockReadable.eventNames
- Defined in node_modules/@types/node/globals.d.ts:568
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from MockReadable.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:560
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from MockReadable.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:564
Parameters
- type: string | symbol
Returns number

listeners

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

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

off

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

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

on

on(event: "close", listener: () => void): this
on(event: "drain", listener: () => void): this
on(event: "error", listener: (err: Error) => void): this
on(event: "finish", listener: () => void): this
on(event: "pipe", listener: (src: Readable) => void): this
on(event: "unpipe", listener: (src: Readable) => void): this
on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockWritable.on

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

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

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

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

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

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

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

once

once(event: "close", listener: () => void): this
once(event: "drain", listener: () => void): this
once(event: "error", listener: (err: Error) => void): this
once(event: "finish", listener: () => void): this
once(event: "pipe", listener: (src: Readable) => void): this
once(event: "unpipe", listener: (src: Readable) => void): this
once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockWritable.once

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

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

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

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

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

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

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

pipe

pipe<T>(destination: T, options?: undefined | { end?: undefined | false | true }): T

Inherited from MockReadable.pipe
- Defined in node_modules/@types/node/stream.d.ts:5
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: undefined | { end?: undefined | false | true }
Returns T

prependListener

prependListener(event: "close", listener: () => void): this
prependListener(event: "drain", listener: () => void): this
prependListener(event: "error", listener: (err: Error) => void): this
prependListener(event: "finish", listener: () => void): this
prependListener(event: "pipe", listener: (src: Readable) => void): this
prependListener(event: "unpipe", listener: (src: Readable) => void): this
prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockWritable.prependListener

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

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

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

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

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

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

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

prependOnceListener

prependOnceListener(event: "close", listener: () => void): this
prependOnceListener(event: "drain", listener: () => void): this
prependOnceListener(event: "error", listener: (err: Error) => void): this
prependOnceListener(event: "finish", listener: () => void): this
prependOnceListener(event: "pipe", listener: (src: Readable) => void): this
prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockWritable.prependOnceListener

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

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

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

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

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

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

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

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from MockReadable.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:558
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "close", listener: () => void): this
removeListener(event: "drain", listener: () => void): this
removeListener(event: "error", listener: (err: Error) => void): this
removeListener(event: "finish", listener: () => void): this
removeListener(event: "pipe", listener: (src: Readable) => void): this
removeListener(event: "unpipe", listener: (src: Readable) => void): this
removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockWritable.removeListener

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

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

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

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

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

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

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

setDefaultEncoding

setDefaultEncoding(encoding: string): this

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

setMaxListeners

setMaxListeners(n: number): this

Inherited from MockReadable.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:559
Parameters
- n: number
Returns this

uncork

uncork(): void

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

write

write(data: Buffer | string): boolean

Overrides Writable.write
- Defined in packages/node/source/stdio/MockWritable.ts:16
Parameters
- data: Buffer | string
Returns boolean

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: WritableOptions

Returns MockWritable

Properties

Private _data

destroyed

Readonly writable

Readonly writableCorked

Readonly writableEnded

Readonly writableFinished

Readonly writableHighWaterMark

Readonly writableLength

Readonly writableObjectMode

Methods

_destroy

Parameters

error: Error | null

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

Parameters

Optional error: Error | null

Returns void

Returns void

_final

Parameters

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

Parameters

Optional error: Error | null

Returns void

Returns void

_write

Parameters

data: Buffer | string

encoding: string

callback: Function

Returns void

Optional _writev

Parameters

chunks: Array<{ chunk: any; encoding: string }>

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

Parameters

Optional error: Error | null

Returns void

Returns void

addListener

Parameters

event: "close"

listener: () => void

Returns void

Returns this

Parameters

event: "drain"

listener: () => void

Returns void

Returns this

Parameters

event: "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns this

Parameters

event: "finish"

listener: () => void

Returns void

Returns this

Parameters

event: "pipe"

listener: (src: Readable) => void

Parameters

src: Readable

Returns void