Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RlpEncoderTransform

An RLP (Recursive Length Prefix) transform, which encodes RLPItems and encodes them according to the RLP serialization format used by Ethereum and as specified in the Yellow Paper (yellowpaper.io).

Hierarchy

  • Transform
    • RlpEncoderTransform

Implements

  • ReadableStream
  • Writable

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

writable

writable: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

__@asyncIterator

  • __@asyncIterator(): AsyncIterableIterator<Buffer | string>

  • Returns AsyncIterableIterator<Buffer | string>

_destroy

  • _destroy(err: Error, callback: Function): void

  • Parameters

    • err: Error
    • callback: Function

    Returns void

_final

  • _final(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: TransformCallback): void

  • Parameters

    • chunk: any
    • encoding: string
    • callback: TransformCallback

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: function): void

  • Parameters

    • chunk: any
    • encoding: string
    • callback: function

        • Parameters

          Returns void

    Returns void

Optional _writev

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

  • Parameters

    • chunks: Array<object>
    • callback: function

        • Parameters

          Returns void

    Returns void

addListener

  • addListener(event: string, listener: function): this
  • addListener(event: "close", listener: function): this
  • addListener(event: "data", listener: function): this
  • addListener(event: "end", listener: function): this
  • addListener(event: "readable", listener: function): this
  • addListener(event: "error", listener: function): this

  • Event emitter The defined events on documents including:

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

    Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void

        • Parameters

          • chunk: Buffer | string

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

cork

  • cork(): void

  • Returns void

destroy

  • destroy(error?: Error): void

  • Parameters

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close"): boolean
  • emit(event: "data", chunk: Buffer | string): boolean
  • emit(event: "end"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "error", err: Error): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: Buffer | string

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

end

  • end(cb?: Function): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: undefined | string, cb?: Function): void

  • Parameters

    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: undefined | string
    • Optional cb: Function

    Returns void

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

isPaused

  • isPaused(): boolean

  • Returns boolean

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string, listener: function): this
  • on(event: "close", listener: function): this
  • on(event: "data", listener: function): this
  • on(event: "end", listener: function): this
  • on(event: "readable", listener: function): this
  • on(event: "error", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void

        • Parameters

          • chunk: Buffer | string

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

once

  • once(event: string, listener: function): this
  • once(event: "close", listener: function): this
  • once(event: "data", listener: function): this
  • once(event: "end", listener: function): this
  • once(event: "readable", listener: function): this
  • once(event: "error", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void

        • Parameters

          • chunk: Buffer | string

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

pause

  • pause(): this

  • Returns this

pipe

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

  • Type parameters

    • T: WritableStream

    Parameters

    • destination: T
    • Optional options: undefined | object

    Returns T

prependListener

  • prependListener(event: string, listener: function): this
  • prependListener(event: "close", listener: function): this
  • prependListener(event: "data", listener: function): this
  • prependListener(event: "end", listener: function): this
  • prependListener(event: "readable", listener: function): this
  • prependListener(event: "error", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void

        • Parameters

          • chunk: Buffer | string

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: function): this
  • prependOnceListener(event: "close", listener: function): this
  • prependOnceListener(event: "data", listener: function): this
  • prependOnceListener(event: "end", listener: function): this
  • prependOnceListener(event: "readable", listener: function): this
  • prependOnceListener(event: "error", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void

        • Parameters

          • chunk: Buffer | string

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

push

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

  • Parameters

    • chunk: any
    • Optional encoding: undefined | string

    Returns boolean

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

read

  • read(size?: undefined | number): any

  • Parameters

    • Optional size: undefined | number

    Returns any

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string, listener: function): this
  • removeListener(event: "close", listener: function): this
  • removeListener(event: "data", listener: function): this
  • removeListener(event: "end", listener: function): this
  • removeListener(event: "readable", listener: function): this
  • removeListener(event: "error", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void

        • Parameters

          • chunk: Buffer | string

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

resume

  • resume(): this

  • Returns this

setDefaultEncoding

  • setDefaultEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setEncoding

  • setEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

uncork

  • uncork(): void

  • Returns void

unpipe

  • unpipe<T>(destination?: T): this

  • Type parameters

    • T: WritableStream

    Parameters

    • Optional destination: T

    Returns this

unshift

  • unshift(chunk: any): void

  • Parameters

    • chunk: any

    Returns void

wrap

  • wrap(oldStream: ReadableStream): this

  • Parameters

    • oldStream: ReadableStream

    Returns this

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: undefined | string, cb?: Function): boolean

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: undefined | string
    • Optional cb: Function

    Returns boolean

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc