Class Bag

Hierarchy

Bag

Index

Constructors

Properties

bagOpt chunkInfos connections endTime? header? reader startTime?

Methods

messageIterator open readMessages

Constructors

constructor

new Bag(filelike: Filelike, opt?: BagOpt): Bag
Parameters
- filelike: Filelike
- Optional opt: BagOpt
Returns Bag
- Defined in Bag.ts:49

Properties

`Private` bagOpt

bagOpt: BagOpt

chunkInfos

chunkInfos: ChunkInfo[] = []

connections

connections: Map<number, Connection>

`Optional` endTime

endTime?: Time

`Optional` header

header?: BagHeader

reader

reader: default

`Optional` startTime

startTime?: Time

Methods

messageIterator

messageIterator(opt?: MessageIteratorOpt): MessageIterator
Parameters
- Optional opt: MessageIteratorOpt
Returns MessageIterator
- Defined in Bag.ts:81

open

open(): Promise<void>
Returns Promise<void>
- Defined in Bag.ts:57

readMessages

readMessages<T>(opts: ReadOptions, callback: ((msg: default<T>) => void)): Promise<void>
Deprecated
Prefer the messageIterator method instead.
Type Parameters
- T = unknown
Parameters
- opts: ReadOptions
- callback: ((msg: default<T>) => void)
  - - (msg: default<T>): void
    - Parameters
      
      msg: default<T>
      
      Returns void
Returns Promise<void>
- Defined in Bag.ts:133

Generated using TypeDoc