MockReadable | Typed

Hierarchy

Readable
- MockReadable

Implements

ReadableStream

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MockReadable(options?: ReadableOptions): MockReadable

Overrides Readable.__constructor
- Defined in packages/node/source/stdio/MockReadable.ts:10
Parameters
- Optional options: ReadableOptions
Returns MockReadable

Properties

destroyed

destroyed: boolean

Protected options

options: ReadableOptions

Protected readData

readData: string[] = []

readable

readable: boolean

Readonly readableEncoding

readableEncoding: BufferEncoding | null

Readonly readableEnded

readableEnded: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

Protected writeData

writeData: string[] = []

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterableIterator<any>

Inherited from MockReadable.[Symbol.asyncIterator]
- Defined in node_modules/@types/node/stream.d.ts:123
Returns AsyncIterableIterator<any>

_destroy

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

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

_read

_read(size?: undefined | number): void

Overrides Readable._read
- Defined in packages/node/source/stdio/MockReadable.ts:18
Parameters
- Optional size: undefined | number
Returns void

addListener

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

Inherited from MockReadable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:60
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 this
Inherited from MockReadable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:61
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from MockReadable.addListener

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

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

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

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

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

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

data

data(): keyof string[]

- Defined in packages/node/source/stdio/MockReadable.ts:57
Returns keyof string[]

destroy

destroy(error?: Error): void

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

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

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:70
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from MockReadable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:71
Parameters
- event: "end"
Returns boolean
Inherited from MockReadable.emit

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

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:73
Parameters
- event: "pause"
Returns boolean
Inherited from MockReadable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:74
Parameters
- event: "readable"
Returns boolean
Inherited from MockReadable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:75
Parameters
- event: "resume"
Returns boolean
Inherited from MockReadable.emit

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

end

end(...args: any[]): void

- Defined in packages/node/source/stdio/MockReadable.ts:61
Parameters
- Rest ...args: any[]
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

isPaused

isPaused(): boolean

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

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

Inherited from MockReadable.on

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

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:79
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from MockReadable.on

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

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

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

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

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

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:85
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: "data", listener: (chunk: any) => void): this
once(event: "end", listener: () => void): this
once(event: "error", listener: (err: Error) => void): this
once(event: "pause", listener: () => void): this
once(event: "readable", listener: () => void): this
once(event: "resume", listener: () => void): this
once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockReadable.once

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

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:88
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from MockReadable.once

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

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

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

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

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

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

pause

pause(): this

Inherited from MockReadable.pause
- Defined in node_modules/@types/node/stream.d.ts:39
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: "data", listener: (chunk: any) => void): this
prependListener(event: "end", listener: () => void): this
prependListener(event: "error", listener: (err: Error) => void): this
prependListener(event: "pause", listener: () => void): this
prependListener(event: "readable", listener: () => void): this
prependListener(event: "resume", listener: () => void): this
prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockReadable.prependListener

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

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:97
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from MockReadable.prependListener

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

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

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

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

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

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:103
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: "data", listener: (chunk: any) => void): this
prependOnceListener(event: "end", listener: () => void): this
prependOnceListener(event: "error", listener: (err: Error) => void): this
prependOnceListener(event: "pause", listener: () => void): this
prependOnceListener(event: "readable", listener: () => void): this
prependOnceListener(event: "resume", listener: () => void): this
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from MockReadable.prependOnceListener

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

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:106
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from MockReadable.prependOnceListener

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

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

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

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

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

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

push

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

Inherited from MockReadable.push
- Defined in node_modules/@types/node/stream.d.ts:45
Parameters
- chunk: any
- Optional encoding: undefined | string
Returns boolean

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[]

read

read(size?: undefined | number): any

Inherited from MockReadable.read
- Defined in node_modules/@types/node/stream.d.ts:37
Parameters
- Optional size: undefined | number
Returns any

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

Inherited from MockReadable.removeListener

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

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:115
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from MockReadable.removeListener

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

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

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

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

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

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

resume

resume(): this

Inherited from MockReadable.resume
- Defined in node_modules/@types/node/stream.d.ts:40
Returns this

setEncoding

setEncoding(encoding: string): this

Inherited from MockReadable.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:38
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

unpipe

unpipe(destination?: NodeJS.WritableStream): this

Inherited from MockReadable.unpipe
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- Optional destination: NodeJS.WritableStream
Returns this

unshift

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

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

wrap

wrap(oldStream: ReadableStream): this

Inherited from MockReadable.wrap
- Defined in node_modules/@types/node/stream.d.ts:44
Parameters
- oldStream: ReadableStream
Returns this

write

write(...data: (string | Buffer)[]): MockReadable

- Defined in packages/node/source/stdio/MockReadable.ts:38
Parameters
- Rest ...data: (string | Buffer)[]
Returns MockReadable

Static from

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

Inherited from MockReadable.from
- Defined in node_modules/@types/node/stream.d.ts:26
A utility method for creating Readable Streams out of iterators.

Parameters
- iterable: Iterable<any> | AsyncIterable<any>
- Optional options: ReadableOptions
Returns Readable

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: ReadableOptions

Returns MockReadable

Properties

destroyed

Protected options

Protected readData

readable

Readonly readableEncoding

Readonly readableEnded

Readonly readableHighWaterMark

Readonly readableLength

Readonly readableObjectMode

Protected writeData

Methods

[Symbol.asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error | null

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

Parameters

Optional error: Error | null

Returns void

Returns void

_read

Parameters

Optional size: undefined | number

Returns void

addListener

Parameters

event: "close"

listener: () => void

Returns void

Returns this

Parameters

event: "data"

listener: (chunk: any) => void

Parameters

chunk: any

Returns void

Returns this

Parameters

event: "end"

listener: () => void

Returns void

Returns this

Parameters

event: "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns this

Parameters

event: "pause"

listener: () => void

Returns void

Returns this

Parameters

event: "readable"

listener: () => void

Returns void

Returns this

Parameters

event: "resume"

listener: () => void

Returns void

Returns this

Parameters

event: string | symbol

listener: (...args: any[]) => void