@vivantel/virage-core
    Preparing search index...

    Interface FileChunker

    interface FileChunker {
        metadataGeneratorId: string;
        name: string;
        patterns: string[];
        sparseTextGeneratorId: string;
        version: string;
        canProcess?(filePath: string): Promise<boolean>;
        chunk(filePath: string, commitHash: string): Promise<Chunk[]>;
    }
    Index
    metadataGeneratorId name patterns sparseTextGeneratorId version
    canProcess? chunk
    metadataGeneratorId: string

    Method fingerprint for metadata assembly for this instance. Computed from name + version + metadata-assembly options. Stored per-chunk; if changed from a previous run, metadata re-enrichment is triggered for chunks produced by this chunker.

    name: string

    Unique name of this chunker plugin.

    patterns: string[]

    Glob patterns this chunker handles.

    sparseTextGeneratorId: string

    Method fingerprint for sparseText generation for this instance. Computed from name + version + sparse-generation options. Stored per-chunk; if changed from a previous run, FTS rebuild is triggered for chunks produced by this chunker.

    version: string

    Semver version — used to compute generator IDs.

    • Optional: validate whether this chunker can process the file (called before chunk() to filter early).

      Parameters

      • filePath: string

      Returns Promise<boolean>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods