Class LedgerReadStream

Hierarchy

Readable
- LedgerReadStream

Index

Constructors

Properties

_metadata ledger metaDataTxId nextTx

Accessors

Methods

_construct _destroy _read parseMetadata

Constructors

constructor

new LedgerReadStream(metaDataTxId, ledger): LedgerReadStream
Parameters
- metaDataTxId: string
- ledger: Api
Returns LedgerReadStream
Overrides Readable.constructor
- Defined in lib/core/ledgerReadStream.ts:21

Properties

`Private` _metadata

_metadata: null | SignumFSMetaData = null

`Private` ledger

ledger: Api

`Private` metaDataTxId

metaDataTxId: string

`Private` nextTx

nextTx: string

Accessors

metadata

get metadata(): null | SignumFSMetaData
Returns null | SignumFSMetaData
- Defined in lib/core/ledgerReadStream.ts:26

Methods

_construct

_construct(callback): void
Parameters
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      
      Optional error: null | Error
      
      Returns void
Returns void
Overrides Readable._construct
- Defined in lib/core/ledgerReadStream.ts:30

_destroy

_destroy(error, callback): void
Parameters
- error: null | Error
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      
      Optional error: null | Error
      
      Returns void
Returns void
Overrides Readable._destroy
- Defined in lib/core/ledgerReadStream.ts:85

_read

_read(): void
Returns void
Overrides Readable._read
- Defined in lib/core/ledgerReadStream.ts:40

`Private` parseMetadata

parseMetadata(attachmentMessage): SignumFSMetaData
Parameters
- attachmentMessage: string
Returns SignumFSMetaData
- Defined in lib/core/ledgerReadStream.ts:89

Generated using TypeDoc