NodeReadable | @textile/js-http-client

Type parameters

Hierarchy

Readable
- NodeReadable

Implements

ReadableStream

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NodeReadable(webStream: ReadableStream<T>, options?: undefined | __type): NodeReadable

Overrides Readable.__constructor
- Defined in helpers/handlers.ts:37
Parameters
- webStream: ReadableStream<T>
- Optional options: undefined | __type
Returns NodeReadable

Properties

_reader

_reader: ReadableStreamDefaultReader

_reading

_reading: boolean

_webStream

_webStream: ReadableStream

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

__@asyncIterator

__@asyncIterator(): AsyncIterableIterator<any>

Inherited from Readable.[Symbol.asyncIterator]
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:101
Returns AsyncIterableIterator<any>

_destroy

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

Inherited from Readable._destroy
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:40
Parameters
- error: Error | null
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_read

_read(size: number): void

Overrides Readable._read
- Defined in helpers/handlers.ts:45
Parameters
- size: number
Returns void

addListener

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
addListener(event: string | symbol, listener: function): this

Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:52
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. readable
5. error
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:53
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:54
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:55
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:56
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.addListener

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

destroy

destroy(error?: Error): void

Inherited from Readable.destroy
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:41
Parameters
- Optional error: Error
Returns void

emit

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

Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:59
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:60
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:61
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:62
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:63
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:64
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

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

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/events.d.ts:20
Returns number

isPaused

isPaused(): boolean

Inherited from Readable.isPaused
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:35
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

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

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /Users/carsonfarmer/Desktop/js-http-client/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 /Users/carsonfarmer/Desktop/js-http-client/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: "data", listener: function): this
on(event: "end", listener: function): this
on(event: "readable", listener: function): this
on(event: "error", listener: function): this
on(event: string | symbol, listener: function): this

Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:66
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:67
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:68
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:69
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:70
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:71
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: "data", listener: function): this
once(event: "end", listener: function): this
once(event: "readable", listener: function): this
once(event: "error", listener: function): this
once(event: string | symbol, listener: function): this

Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:73
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:74
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:75
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:76
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:77
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.once

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

pause

pause(): this

Inherited from Readable.pause
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:33
Returns this

pipe

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

Inherited from internal.pipe
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:5
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: undefined | object
Returns T

prependListener

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
prependListener(event: string | symbol, listener: function): this

Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:80
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:81
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:82
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:83
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:84
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:85
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: "data", listener: function): this
prependOnceListener(event: "end", listener: function): this
prependOnceListener(event: "readable", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: string | symbol, listener: function): this

Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:87
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:88
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:89
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:90
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:91
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.prependOnceListener

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

push

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

Inherited from Readable.push
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:39
Parameters
- chunk: any
- Optional encoding: undefined | string
Returns boolean

rawListeners

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

Inherited from EventEmitter.rawListeners

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

read

read(size?: undefined | number): any

Inherited from Readable.read
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:31
Parameters
- Optional size: undefined | number
Returns any

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

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

removeListener

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
removeListener(event: string | symbol, listener: function): this

Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:94
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:95
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:96
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:97
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:98
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.removeListener

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

resume

resume(): this

Inherited from Readable.resume
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:34
Returns this

setEncoding

setEncoding(encoding: string): this

Inherited from Readable.setEncoding
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:32
Parameters
- encoding: string
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

unpipe

unpipe(destination?: NodeJS.WritableStream): this

Inherited from Readable.unpipe
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:36
Parameters
- Optional destination: NodeJS.WritableStream
Returns this

unshift

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

Inherited from Readable.unshift
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:37
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns void

wrap

wrap(oldStream: ReadableStream): this

Inherited from Readable.wrap
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:38
Parameters
- oldStream: ReadableStream
Returns this

Static from

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

Inherited from Readable.from
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/stream.d.ts:24
A utility method for creating Readable Streams out of iterators.

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /Users/carsonfarmer/Desktop/js-http-client/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

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

Type parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

webStream: ReadableStream<T>

Optional options: undefined | __type

Returns NodeReadable

Properties

_reader

_reading

_webStream

readable

readableHighWaterMark

readableLength

Static defaultMaxListeners

Methods

__@asyncIterator

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error | null

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

_read

Parameters

size: number

Returns void

addListener

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "data"

listener: function

Parameters

chunk: any

Returns void

Returns this

Parameters

event: "end"

listener: function

Returns void

Returns this

Parameters

event: "readable"

listener: function

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

destroy

Parameters

Optional error: Error

Returns void

emit

Parameters