Interface BAIIndex

Complete BAI index structure Root container for all reference sequence indexes

interface BAIIndex {
    referenceCount: number;
    references: readonly BAIReference[];
    version?: string;
    createdAt?: Date;
    sourceFile?: string;
}

Index

Properties

referenceCount references version? createdAt? sourceFile?

Properties

`Readonly`referenceCount

referenceCount: number

Number of reference sequences indexed

`Readonly`references

references: readonly BAIReference[]

Array of reference indexes (one per reference sequence)

`Optional` `Readonly`version

version?: string

BAI format version for compatibility checking

`Optional` `Readonly`createdAt

createdAt?: Date

Index creation timestamp for metadata

`Optional` `Readonly`sourceFile

sourceFile?: string

Source BAM file path for tracking