TrieReadStream.md

@ethereumjs/trie / TrieReadStream

Class: TrieReadStream

Hierarchy

• Readable

  ↳ TrieReadStream

Table of contents

Constructors

• constructor

Properties

• _readableState
• closed
• destroyed
• errored
• readable
• readableAborted
• readableDidRead
• readableEncoding
• readableEnded
• readableFlowing
• readableHighWaterMark
• readableLength
• readableObjectMode

Methods

• [asyncIterator]
• _destroy
• _read
• _undestroy
• addListener
• destroy
• emit
• eventNames
• getMaxListeners
• isPaused
• listenerCount
• listeners
• off
• on
• once
• pause
• pipe
• prependListener
• prependOnceListener
• push
• rawListeners
• read
• removeAllListeners
• removeListener
• resume
• setEncoding
• setMaxListeners
• unpipe
• unshift
• wrap

Constructors

constructor

• new TrieReadStream(trie)

Parameters

Name	Type
trie	Trie

Overrides

Readable.constructor

Defined in

packages/trie/src/util/readStream.ts:36

Properties

_readableState

• _readableState: ReadableState

Inherited from

Readable._readableState

Defined in

node_modules/@types/readable-stream/index.d.ts:146

---

closed

• Readonly closed: boolean

Inherited from

Readable.closed

Defined in

node_modules/@types/readable-stream/index.d.ts:59

---

destroyed

• destroyed: boolean

Inherited from

Readable.destroyed

Defined in

node_modules/@types/readable-stream/index.d.ts:147

---

errored

• Readonly errored: null | Error

Inherited from

Readable.errored

Defined in

node_modules/@types/readable-stream/index.d.ts:60

---

readable

• readable: boolean

Inherited from

Readable.readable

Defined in

node_modules/@types/readable-stream/index.d.ts:55

---

readableAborted

• Readonly readableAborted: never

Inherited from

Readable.readableAborted

Defined in

node_modules/@types/readable-stream/index.d.ts:292

---

readableDidRead

• Readonly readableDidRead: never

Inherited from

Readable.readableDidRead

Defined in

node_modules/@types/readable-stream/index.d.ts:293

---

readableEncoding

• Readonly readableEncoding: never

Inherited from

Readable.readableEncoding

Defined in

node_modules/@types/readable-stream/index.d.ts:294

---

readableEnded

• Readonly readableEnded: never

Inherited from

Readable.readableEnded

Defined in

node_modules/@types/readable-stream/index.d.ts:295

---

readableFlowing

• Readonly readableFlowing: null | boolean

Inherited from

Readable.readableFlowing

Defined in

node_modules/@types/readable-stream/index.d.ts:56

---

readableHighWaterMark

• Readonly readableHighWaterMark: number

Inherited from

Readable.readableHighWaterMark

Defined in

node_modules/@types/readable-stream/index.d.ts:57

---

readableLength

• Readonly readableLength: number

Inherited from

Readable.readableLength

Defined in

node_modules/@types/readable-stream/index.d.ts:58

---

readableObjectMode

• Readonly readableObjectMode: never

Inherited from

Readable.readableObjectMode

Defined in

node_modules/@types/readable-stream/index.d.ts:296

Methods

[asyncIterator]

▸ [asyncIterator](): AsyncIterableIterator<any>

Returns

AsyncIterableIterator<any>

Inherited from

Readable.__@asyncIterator@21529

Defined in

node_modules/@types/readable-stream/index.d.ts:143

---

_destroy

▸ _destroy(error, callback): void

Parameters

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

Returns

void

Inherited from

Readable._destroy

Defined in

node_modules/@types/readable-stream/index.d.ts:71

---

_read

▸ _read(): Promise<void>

Returns

Promise<void>

Overrides

Readable._read

Defined in

packages/trie/src/util/readStream.ts:43

---

_undestroy

▸ _undestroy(): void

Returns

void

Inherited from

Readable._undestroy

Defined in

node_modules/@types/readable-stream/index.d.ts:151

---

addListener

▸ addListener(event, listener): TrieReadStream

Event emitter The defined events on documents including:

1. close
2. data
3. end
4. readable
5. error

Parameters

Name	Type
event	"close"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.addListener

Defined in

node_modules/@types/readable-stream/index.d.ts:83

▸ addListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"data"
listener	(chunk: any) => void

Returns

TrieReadStream

Inherited from

Readable.addListener

Defined in

node_modules/@types/readable-stream/index.d.ts:84

▸ addListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"end"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.addListener

Defined in

node_modules/@types/readable-stream/index.d.ts:85

▸ addListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"readable"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.addListener

Defined in

node_modules/@types/readable-stream/index.d.ts:86

▸ addListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

TrieReadStream

Inherited from

Readable.addListener

Defined in

node_modules/@types/readable-stream/index.d.ts:87

▸ addListener(event, listener): TrieReadStream

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

TrieReadStream

Inherited from

Readable.addListener

Defined in

node_modules/@types/readable-stream/index.d.ts:88

---

destroy

▸ destroy(error?): TrieReadStream

Parameters

Name	Type
error?	Error

Returns

TrieReadStream

Inherited from

Readable.destroy

Defined in

node_modules/@types/readable-stream/index.d.ts:72

---

emit

▸ emit(event): boolean

Parameters

Name	Type
event	"close"

Returns

boolean

Inherited from

Readable.emit

Defined in

node_modules/@types/readable-stream/index.d.ts:90

▸ emit(event, chunk): boolean

Parameters

Name	Type
event	"data"
chunk	any

Returns

boolean

Inherited from

Readable.emit

Defined in

node_modules/@types/readable-stream/index.d.ts:91

▸ emit(event): boolean

Parameters

Name	Type
event	"end"

Returns

boolean

Inherited from

Readable.emit

Defined in

node_modules/@types/readable-stream/index.d.ts:92

▸ emit(event): boolean

Parameters

Name	Type
event	"readable"

Returns

boolean

Inherited from

Readable.emit

Defined in

node_modules/@types/readable-stream/index.d.ts:93

▸ emit(event, err): boolean

Parameters

Name	Type
event	"error"
err	Error

Returns

boolean

Inherited from

Readable.emit

Defined in

node_modules/@types/readable-stream/index.d.ts:94

▸ emit(event, ...args): boolean

Parameters

Name	Type
event	string | symbol
...args	any[]

Returns

boolean

Inherited from

Readable.emit

Defined in

node_modules/@types/readable-stream/index.d.ts:95

---

eventNames

▸ eventNames(): (string | symbol)[]

Returns

(string | symbol)[]

Inherited from

Readable.eventNames

Defined in

node_modules/@types/readable-stream/index.d.ts:141

---

getMaxListeners

▸ getMaxListeners(): number

Returns

number

Inherited from

Readable.getMaxListeners

Defined in

node_modules/@types/readable-stream/index.d.ts:135

---

isPaused

▸ isPaused(): boolean

Returns

boolean

Inherited from

Readable.isPaused

Defined in

node_modules/@types/readable-stream/index.d.ts:66

---

listenerCount

▸ listenerCount(eventName): number

Parameters

Name	Type
eventName	string | symbol

Returns

number

Inherited from

Readable.listenerCount

Defined in

node_modules/@types/readable-stream/index.d.ts:140

---

listeners

▸ listeners(eventName): Function[]

Parameters

Name	Type
eventName	string | symbol

Returns

Function[]

Inherited from

Readable.listeners

Defined in

node_modules/@types/readable-stream/index.d.ts:137

---

off

▸ off(eventName, listener): TrieReadStream

Parameters

Name	Type
eventName	string | symbol
listener	(...args: any[]) => void

Returns

TrieReadStream

Inherited from

Readable.off

Defined in

node_modules/@types/readable-stream/index.d.ts:133

---

on

▸ on(event, listener): TrieReadStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.on

Defined in

node_modules/@types/readable-stream/index.d.ts:97

▸ on(event, listener): TrieReadStream

Parameters

Name	Type
event	"data"
listener	(chunk: any) => void

Returns

TrieReadStream

Inherited from

Readable.on

Defined in

node_modules/@types/readable-stream/index.d.ts:98

▸ on(event, listener): TrieReadStream

Parameters

Name	Type
event	"end"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.on

Defined in

node_modules/@types/readable-stream/index.d.ts:99

▸ on(event, listener): TrieReadStream

Parameters

Name	Type
event	"readable"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.on

Defined in

node_modules/@types/readable-stream/index.d.ts:100

▸ on(event, listener): TrieReadStream

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

TrieReadStream

Inherited from

Readable.on

Defined in

node_modules/@types/readable-stream/index.d.ts:101

▸ on(event, listener): TrieReadStream

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

TrieReadStream

Inherited from

Readable.on

Defined in

node_modules/@types/readable-stream/index.d.ts:102

---

once

▸ once(event, listener): TrieReadStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.once

Defined in

node_modules/@types/readable-stream/index.d.ts:104

▸ once(event, listener): TrieReadStream

Parameters

Name	Type
event	"data"
listener	(chunk: any) => void

Returns

TrieReadStream

Inherited from

Readable.once

Defined in

node_modules/@types/readable-stream/index.d.ts:105

▸ once(event, listener): TrieReadStream

Parameters

Name	Type
event	"end"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.once

Defined in

node_modules/@types/readable-stream/index.d.ts:106

▸ once(event, listener): TrieReadStream

Parameters

Name	Type
event	"readable"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.once

Defined in

node_modules/@types/readable-stream/index.d.ts:107

▸ once(event, listener): TrieReadStream

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

TrieReadStream

Inherited from

Readable.once

Defined in

node_modules/@types/readable-stream/index.d.ts:108

▸ once(event, listener): TrieReadStream

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

TrieReadStream

Inherited from

Readable.once

Defined in

node_modules/@types/readable-stream/index.d.ts:109

---

pause

▸ pause(): TrieReadStream

Returns

TrieReadStream

Inherited from

Readable.pause

Defined in

node_modules/@types/readable-stream/index.d.ts:64

---

pipe

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

Type parameters

Name	Type
T	extends _IWritable<T>

Parameters

Name	Type
destination	T
options?	Object
options.end?	boolean

Returns

T

Inherited from

Readable.pipe

Defined in

node_modules/@types/readable-stream/index.d.ts:299

---

prependListener

▸ prependListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.prependListener

Defined in

node_modules/@types/readable-stream/index.d.ts:111

▸ prependListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"data"
listener	(chunk: any) => void

Returns

TrieReadStream

Inherited from

Readable.prependListener

Defined in

node_modules/@types/readable-stream/index.d.ts:112

▸ prependListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"end"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.prependListener

Defined in

node_modules/@types/readable-stream/index.d.ts:113

▸ prependListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"readable"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.prependListener

Defined in

node_modules/@types/readable-stream/index.d.ts:114

▸ prependListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

TrieReadStream

Inherited from

Readable.prependListener

Defined in

node_modules/@types/readable-stream/index.d.ts:115

▸ prependListener(event, listener): TrieReadStream

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

TrieReadStream

Inherited from

Readable.prependListener

Defined in

node_modules/@types/readable-stream/index.d.ts:116

---

prependOnceListener

▸ prependOnceListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.prependOnceListener

Defined in

node_modules/@types/readable-stream/index.d.ts:118

▸ prependOnceListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"data"
listener	(chunk: any) => void

Returns

TrieReadStream

Inherited from

Readable.prependOnceListener

Defined in

node_modules/@types/readable-stream/index.d.ts:119

▸ prependOnceListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"end"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.prependOnceListener

Defined in

node_modules/@types/readable-stream/index.d.ts:120

▸ prependOnceListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"readable"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.prependOnceListener

Defined in

node_modules/@types/readable-stream/index.d.ts:121

▸ prependOnceListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

TrieReadStream

Inherited from

Readable.prependOnceListener

Defined in

node_modules/@types/readable-stream/index.d.ts:122

▸ prependOnceListener(event, listener): TrieReadStream

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

TrieReadStream

Inherited from

Readable.prependOnceListener

Defined in

node_modules/@types/readable-stream/index.d.ts:123

---

push

▸ push(chunk, encoding?): boolean

Parameters

Name	Type
chunk	any
encoding?	string

Returns

boolean

Inherited from

Readable.push

Defined in

node_modules/@types/readable-stream/index.d.ts:70

---

rawListeners

▸ rawListeners(eventName): Function[]

Parameters

Name	Type
eventName	string | symbol

Returns

Function[]

Inherited from

Readable.rawListeners

Defined in

node_modules/@types/readable-stream/index.d.ts:139

---

read

▸ read(size?): any

Parameters

Name	Type
size?	number

Returns

any

Inherited from

Readable.read

Defined in

node_modules/@types/readable-stream/index.d.ts:62

---

removeAllListeners

▸ removeAllListeners(event?): TrieReadStream

Parameters

Name	Type
event?	string | symbol

Returns

TrieReadStream

Inherited from

Readable.removeAllListeners

Defined in

node_modules/@types/readable-stream/index.d.ts:132

---

removeListener

▸ removeListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.removeListener

Defined in

node_modules/@types/readable-stream/index.d.ts:125

▸ removeListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"data"
listener	(chunk: any) => void

Returns

TrieReadStream

Inherited from

Readable.removeListener

Defined in

node_modules/@types/readable-stream/index.d.ts:126

▸ removeListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"end"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.removeListener

Defined in

node_modules/@types/readable-stream/index.d.ts:127

▸ removeListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"readable"
listener	() => void

Returns

TrieReadStream

Inherited from

Readable.removeListener

Defined in

node_modules/@types/readable-stream/index.d.ts:128

▸ removeListener(event, listener): TrieReadStream

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

TrieReadStream

Inherited from

Readable.removeListener

Defined in

node_modules/@types/readable-stream/index.d.ts:129

▸ removeListener(event, listener): TrieReadStream

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

TrieReadStream

Inherited from

Readable.removeListener

Defined in

node_modules/@types/readable-stream/index.d.ts:130

---

resume

▸ resume(): TrieReadStream

Returns

TrieReadStream

Inherited from

Readable.resume

Defined in

node_modules/@types/readable-stream/index.d.ts:65

---

setEncoding

▸ setEncoding(encoding): TrieReadStream

Parameters

Name	Type
encoding	string

Returns

TrieReadStream

Inherited from

Readable.setEncoding

Defined in

node_modules/@types/readable-stream/index.d.ts:63

---

setMaxListeners

▸ setMaxListeners(n): TrieReadStream

Parameters

Name	Type
n	number

Returns

TrieReadStream

Inherited from

Readable.setMaxListeners

Defined in

node_modules/@types/readable-stream/index.d.ts:134

---

unpipe

▸ unpipe(destination?): TrieReadStream

Parameters

Name	Type
destination?	Writable

Returns

TrieReadStream

Inherited from

Readable.unpipe

Defined in

node_modules/@types/readable-stream/index.d.ts:67

---

unshift

▸ unshift(chunk): void

Parameters

Name	Type
chunk	any

Returns

void

Inherited from

Readable.unshift

Defined in

node_modules/@types/readable-stream/index.d.ts:68

---

wrap

▸ wrap(oldStream): TrieReadStream

Parameters

Name	Type
oldStream	Readable

Returns

TrieReadStream

Inherited from

Readable.wrap

Defined in

node_modules/@types/readable-stream/index.d.ts:69