Class BamError

BAM format-specific errors with binary context

Hierarchy (View Summary)

ParseError
- BamError

Index

Constructors

Methods

withBlockContext toString

Properties

code lineNumber? context? format qname? fieldName? blockOffset?

Constructors

constructor

new BamError(
    message: string,
    qname?: string,
    fieldName?: string,
    blockOffset?: number,
    context?: string,
): BamError
Parameters
- message: string
- Optionalqname: string
- OptionalfieldName: string
- OptionalblockOffset: number
- Optionalcontext: string
Returns BamError
Overrides ParseError.constructor
- Defined in src/errors.ts:306

Methods

`Static`withBlockContext

withBlockContext(
    message: string,
    blockOffset: number,
    qname?: string,
    fieldName?: string,
): BamError
Create BAM error with BGZF block context
Parameters
- message: string
- blockOffset: number
- Optionalqname: string
- OptionalfieldName: string
Returns BamError
- Defined in src/errors.ts:320

toString

toString(): string
Enhanced toString with BAM-specific context

Returns string
Overrides ParseError.toString
- Defined in src/errors.ts:338

Properties

`Readonly`code

code: string

`Optional` `Readonly`lineNumber

lineNumber?: number

`Optional` `Readonly`context

context?: string

`Readonly`format

format: string

`Optional` `Readonly`qname

qname?: string

`Optional` `Readonly`fieldName

fieldName?: string

`Optional` `Readonly`blockOffset

blockOffset?: number