ClientReadableObjectStream | Node.js bindings for DAML

A stream of objects that are pushed from the server and are readable from the client. It it a Readable Node.js stream and wraps the call to gRPC.

Type parameters

Hierarchy

Readable
- ClientReadableObjectStream

Implements

ReadableStream

Index

Properties

readable

readable: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

[Symbol.asyncIterator]

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

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

_destroy

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

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

_read

_read(): void

Overrides Deserializer._read
- Defined in src/call/ClientReadableObjectStream.ts:45
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: "readable", listener: () => void): this
addListener(event: "error", listener: (err: Error) => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Deserializer.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:47
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. readable
5. error
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Deserializer.addListener

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

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

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

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

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

cancel

cancel(): void

- Defined in src/call/ClientReadableObjectStream.ts:58
Cancel the ongoing call. Results in the call ending with a CANCELLED status, unless it has already ended with some other status.

Returns void

destroy

destroy(error?: Error): void

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

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

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

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

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

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

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

eventNames

eventNames(): Array<string | symbol>

Inherited from Deserializer.eventNames
- Defined in node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from Deserializer.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

getPeer

getPeer(): string

- Defined in src/call/ClientReadableObjectStream.ts:69
Get the endpoint this call/stream is connected to.

Returns string

The URI of the endpoint

isPaused

isPaused(): boolean

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from Deserializer.listenerCount
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

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

off

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

Inherited from Deserializer.off
- Defined in node_modules/@types/node/events.d.ts:17
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: "readable", listener: () => void): this
on(event: "error", listener: (err: Error) => void): this
on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Deserializer.on

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

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

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

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

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

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

Inherited from Deserializer.once

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

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

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

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

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

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

pause

pause(): this

Inherited from Deserializer.pause
- Defined in node_modules/@types/node/stream.d.ts:28
Returns this

pipe

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

Inherited from Deserializer.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: "readable", listener: () => void): this
prependListener(event: "error", listener: (err: Error) => void): this
prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Deserializer.prependListener

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

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

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

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

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

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

Inherited from Deserializer.prependOnceListener

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

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

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

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

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

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:87
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 Deserializer.push
- Defined in node_modules/@types/node/stream.d.ts:34
Parameters
- chunk: any
- Optional encoding: undefined | string
Returns boolean

rawListeners

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

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

read

read(size?: undefined | number): any

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from Deserializer.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:18
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: "readable", listener: () => void): this
removeListener(event: "error", listener: (err: Error) => void): this
removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Deserializer.removeListener

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

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

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

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

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

Overrides EventEmitter.removeListener
- 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

resume

resume(): this

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

setEncoding

setEncoding(encoding: string): this

Inherited from Deserializer.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:27
Parameters
- encoding: string
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from Deserializer.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

unpipe

unpipe(destination?: NodeJS.WritableStream): this

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

unshift

unshift(chunk: any): void

Inherited from Deserializer.unshift
- Defined in node_modules/@types/node/stream.d.ts:32
Parameters
- chunk: any
Returns void

wrap

wrap(oldStream: ReadableStream): this

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

Static from

from<O>(wrapped: Error): ClientReadableObjectStream<O>
from<T, O>(wrapped: ClientReadableStream<T>, codec: Codec<T, O>, opts?: ReadableOptions): ClientReadableObjectStream<O>

- Defined in src/call/ClientReadableObjectStream.ts:35
Type parameters
- O
Parameters
- wrapped: Error
Returns ClientReadableObjectStream<O>
- Defined in src/call/ClientReadableObjectStream.ts:36
Type parameters
- T
- O
Parameters
- wrapped: ClientReadableStream<T>
- codec: Codec<T, O>
- Optional opts: ReadableOptions
Returns ClientReadableObjectStream<O>

Static listenerCount

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

Inherited from Deserializer.listenerCount
- Defined in node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

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

Type parameters

O

Hierarchy

Implements

Index

Properties

Methods

Properties

readable

Readonly readableHighWaterMark

Readonly readableLength

Static defaultMaxListeners

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

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: "readable"

listener: () => void

Returns void

Returns this

Parameters

event: "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns this

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns this

cancel

Returns void

destroy

Parameters

Optional error: Error

Returns void

emit

Parameters

event: "close"

Returns boolean

Parameters

event: "data"

chunk: any

Returns boolean

Parameters

event: "end"

Returns boolean

Parameters