Interface Signature

One recognizable file signature.

interface Signature {
    FileType: string;
    Magic: readonly number[];
    Offset?: number;
    TextPrefix?: string;
    Unambiguous: boolean;
}

Properties

FileType: string

The file type key it identifies.

Magic: readonly number[]

Bytes that must match at Offset. Empty for a TextPrefix signature.

Offset?: number

Where the magic starts. Defaults to 0.

TextPrefix?: string

Opening text, matched after a BOM and leading whitespace are stripped and case is folded.

Unambiguous: boolean

Whether a match may overrule a declared type. False for containers like zip (docx, xlsx are zips).