ResultStream | amazon-qldb-driver-nodejs

A class representing the result of a statement returned from QLDB as a stream. Extends Readable from the Node.JS Stream API interface. The stream will always operate in object mode.

Hierarchy

Readable
- ResultStream

Implements

ReadableStream

Index

Constructors

constructor

Properties

Constructors

constructor

new ResultStream(txnId: string, firstPage: Page, communicator: Communicator): ResultStream

Overrides Readable.__constructor
- Defined in src/ResultStream.ts:32
Create a ResultStream.

Parameters
- txnId: string
  
  The ID of the transaction the statement was executed in.
- firstPage: Page
  
  The initial page returned from the statement execution.
- communicator: Communicator
  
  The Communicator used for the statement execution.
Returns ResultStream

Properties

Private _cachedPage

_cachedPage: Page

Private _communicator

_communicator: Communicator

Private _isPushingData

_isPushingData: boolean

Private _retrieveIndex

_retrieveIndex: number

Private _shouldPushCachedPage

_shouldPushCachedPage: boolean

Private _txnId

_txnId: string

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

[Symbol.asyncIterator]

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

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

_destroy

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

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

Private _pushPageValues

_pushPageValues(): Promise<void>

- Defined in src/ResultStream.ts:68
Pushes the values for the Node Streams Readable Interface. This method fetches the next page if is required and handles converting the values returned from QLDB into an Ion value.

Returns Promise<void>

Promise which fulfills with void.

_read

_read(size?: number): void

Overrides Readable._read
- Defined in src/ResultStream.ts:55
Implementation of the readable.read method for the Node Streams Readable Interface.

Parameters
- Optional size: number
  
  The number of bytes to read asynchronously. This is currently not being used as only object mode is supported.
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 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: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

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

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

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

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

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:52
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 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 Readable.emit

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

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

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

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

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:58
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.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 EventEmitter.eventNames

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

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

isPaused

isPaused(): boolean

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

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

Overrides EventEmitter.listeners
- Defined in 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 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 node_modules/@types/node/stream.d.ts:61
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

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

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

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

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

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:66
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 node_modules/@types/node/stream.d.ts:68
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

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

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

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

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

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:73
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 node_modules/@types/node/stream.d.ts:28
Returns this

pipe

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

Inherited from internal.pipe
- Defined in node_modules/@types/node/stream.d.ts:5
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: object
  - Optional end?: boolean
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 node_modules/@types/node/stream.d.ts:75
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

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

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

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

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

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:80
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 node_modules/@types/node/stream.d.ts:82
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

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

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

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

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

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

push

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

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

rawListeners

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

Inherited from EventEmitter.rawListeners

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

read

read(size?: number): any

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in 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 node_modules/@types/node/stream.d.ts:89
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

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

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

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

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

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:94
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 node_modules/@types/node/stream.d.ts:29
Returns this

setEncoding

setEncoding(encoding: string): this

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

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

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

unpipe

unpipe(destination?: WritableStream): this

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

unshift

unshift(chunk: any): void

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

wrap

wrap(oldStream: ReadableStream): this

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

Static listenerCount

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

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

since v4.0.0

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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

txnId: string

firstPage: Page

communicator: Communicator

Returns ResultStream

Properties

Private _cachedPage

Private _communicator

Private _isPushingData

Private _retrieveIndex

Private _shouldPushCachedPage

Private _txnId

readable

readableHighWaterMark

readableLength

Static defaultMaxListeners

Methods

[Symbol.asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error | null

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

Private _pushPageValues

Returns Promise<void>

_read

Parameters

Optional 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