Class McapIndexedReader

Hierarchy

McapIndexedReader

Constructors

`Private` constructor

new McapIndexedReader(args): McapIndexedReader
Parameters
- args: McapIndexedReaderArgs
Returns McapIndexedReader
- Defined in McapIndexedReader.ts:47

Properties

`Private` #attachmentEndTime

#attachmentEndTime: undefined | bigint

`Private` #attachmentStartTime

#attachmentStartTime: undefined | bigint

`Private` `Optional` #decompressHandlers

#decompressHandlers?: DecompressHandlers

`Private` #messageEndTime

#messageEndTime: undefined | bigint

`Private` #messageStartTime

#messageStartTime: undefined | bigint

`Private` #readable

#readable: IReadable

`Readonly` attachmentIndexes

attachmentIndexes: readonly (AttachmentIndex & {
type: "AttachmentIndex";
})[]

`Readonly` channelsById

channelsById: ReadonlyMap<number, Channel & {
type: "Channel";
}>

`Readonly` chunkIndexes

chunkIndexes: readonly (ChunkIndex & {
type: "ChunkIndex";
})[]

`Readonly` dataEndOffset

dataEndOffset: bigint

`Optional` `Readonly` dataSectionCrc

dataSectionCrc?: number

`Readonly` footer

footer: Footer & {
type: "Footer";
}

Type declaration

type: "Footer"

`Readonly` header

header: Header & {
type: "Header";
}

Type declaration

type: "Header"

`Readonly` metadataIndexes

metadataIndexes: readonly (MetadataIndex & {
type: "MetadataIndex";
})[] = []

`Readonly` schemasById

schemasById: ReadonlyMap<number, Schema & {
type: "Schema";
}>

`Readonly` statistics

statistics: undefined | Statistics & {
type: "Statistics";
}

`Readonly` summaryOffsetsByOpcode

summaryOffsetsByOpcode: ReadonlyMap<number, SummaryOffset & {
type: "SummaryOffset";
}>

Methods

`Private` #errorWithLibrary

#errorWithLibrary(message): Error
Parameters
- message: string
Returns Error
- Defined in McapIndexedReader.ts:84

`Private` #loadChunkData

#loadChunkData(chunkIndex, options?): Promise<DataView>
Parameters
- chunkIndex: ChunkIndex & {
  type: "ChunkIndex";
  }
- Optional options: {
  validateCrcs: boolean;
  }
  - validateCrcs: boolean
Returns Promise<DataView>
- Defined in McapIndexedReader.ts:542

readAttachments

readAttachments(args?): AsyncGenerator<Attachment & {
type: "Attachment";
}, void, void>
Parameters
- args: {
      endTime?: bigint;
      mediaType?: string;
      name?: string;
      startTime?: bigint;
      validateCrcs?: boolean;
  } = {}
  - Optional endTime?: bigint
  - Optional mediaType?: string
  - Optional name?: string
  - Optional startTime?: bigint
  - Optional validateCrcs?: boolean
Returns AsyncGenerator<Attachment & {
type: "Attachment";
}, void, void>
- Defined in McapIndexedReader.ts:487

readMessages

readMessages(args?): AsyncGenerator<Message & {
type: "Message";
}, void, void>
Parameters
- args: {
      endTime?: bigint;
      reverse?: boolean;
      startTime?: bigint;
      topics?: readonly string[];
      validateCrcs?: boolean;
  } = {}
  - Optional endTime?: bigint
  - Optional reverse?: boolean
  - Optional startTime?: bigint
  - Optional topics?: readonly string[]
  - Optional validateCrcs?: boolean
Returns AsyncGenerator<Message & {
type: "Message";
}, void, void>
- Defined in McapIndexedReader.ts:348

readMetadata

readMetadata(args?): AsyncGenerator<Metadata & {
type: "Metadata";
}, void, void>
Parameters
- args: {
  name?: string;
  } = {}
  - Optional name?: string
Returns AsyncGenerator<Metadata & {
type: "Metadata";
}, void, void>
- Defined in McapIndexedReader.ts:459

`Static` Initialize

Initialize(__namedParameters): Promise<McapIndexedReader>
Parameters
- __namedParameters: {
  decompressHandlers?: DecompressHandlers;
  readable: IReadable;
  }
  - Optional decompressHandlers?: DecompressHandlers
    When a compressed chunk is encountered, the entry in decompressHandlers corresponding to the compression will be called to decompress the chunk data.
  - readable: IReadable
Returns Promise<McapIndexedReader>
- Defined in McapIndexedReader.ts:88

Class McapIndexedReader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

args: McapIndexedReaderArgs

Returns McapIndexedReader

Properties

Private #attachmentEndTime

Private #attachmentStartTime

Private Optional #decompressHandlers

Private #messageEndTime

Private #messageStartTime

Private #readable

Readonly attachmentIndexes

Readonly channelsById

Readonly chunkIndexes

Readonly dataEndOffset

Optional Readonly dataSectionCrc

Readonly footer

Type declaration

type: "Footer"

Readonly header

Type declaration

type: "Header"

Readonly metadataIndexes

Readonly schemasById

Readonly statistics

Readonly summaryOffsetsByOpcode

Methods

Private #errorWithLibrary

Parameters

message: string

Returns Error

Private #loadChunkData

Parameters

chunkIndex: ChunkIndex & { type: "ChunkIndex"; }

Optional options: { validateCrcs: boolean; }

validateCrcs: boolean

Returns Promise<DataView>

readAttachments

Parameters

args: { endTime?: bigint; mediaType?: string; name?: string; startTime?: bigint; validateCrcs?: boolean; } = {}

Optional endTime?: bigint

Optional mediaType?: string

Optional name?: string

Optional startTime?: bigint

Optional validateCrcs?: boolean

Returns AsyncGenerator<Attachment & { type: "Attachment"; }, void, void>

readMessages

Parameters

args: { endTime?: bigint; reverse?: boolean; startTime?: bigint; topics?: readonly string[]; validateCrcs?: boolean; } = {}

Optional endTime?: bigint

Optional reverse?: boolean

Optional startTime?: bigint

Optional topics?: readonly string[]

Optional validateCrcs?: boolean

Returns AsyncGenerator<Message & { type: "Message"; }, void, void>

readMetadata

Parameters

args: { name?: string; } = {}

Optional name?: string

Returns AsyncGenerator<Metadata & { type: "Metadata"; }, void, void>

Static Initialize

Parameters

__namedParameters: { decompressHandlers?: DecompressHandlers; readable: IReadable; }

Optional decompressHandlers?: DecompressHandlers

readable: IReadable

Returns Promise<McapIndexedReader>

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Private` #attachmentEndTime

`Private` #attachmentStartTime

`Private` `Optional` #decompressHandlers

`Private` #messageEndTime

`Private` #messageStartTime

`Private` #readable

`Readonly` attachmentIndexes

`Readonly` channelsById

`Readonly` chunkIndexes

`Readonly` dataEndOffset

`Optional` `Readonly` dataSectionCrc

`Readonly` footer

`Readonly` header

`Readonly` metadataIndexes

`Readonly` schemasById

`Readonly` statistics

`Readonly` summaryOffsetsByOpcode

`Private` #errorWithLibrary

`Private` #loadChunkData

chunkIndex: ChunkIndex & {
type: "ChunkIndex";
}

`Optional` options: {
validateCrcs: boolean;
}

args: {
endTime?: bigint;
mediaType?: string;
name?: string;
startTime?: bigint;
validateCrcs?: boolean;
} = {}

`Optional` endTime?: bigint

`Optional` mediaType?: string

`Optional` name?: string

`Optional` startTime?: bigint

`Optional` validateCrcs?: boolean

Returns AsyncGenerator<Attachment & {
type: "Attachment";
}, void, void>

args: {
endTime?: bigint;
reverse?: boolean;
startTime?: bigint;
topics?: readonly string[];
validateCrcs?: boolean;
} = {}

`Optional` endTime?: bigint

`Optional` reverse?: boolean

`Optional` startTime?: bigint

`Optional` topics?: readonly string[]

`Optional` validateCrcs?: boolean

Returns AsyncGenerator<Message & {
type: "Message";
}, void, void>

args: {
name?: string;
} = {}

`Optional` name?: string

Returns AsyncGenerator<Metadata & {
type: "Metadata";
}, void, void>

`Static` Initialize

__namedParameters: {
decompressHandlers?: DecompressHandlers;
readable: IReadable;
}

`Optional` decompressHandlers?: DecompressHandlers