IFClite TypeScript API
    Preparing search index...

    Interface ValidatorOptions

    Options for the validation process

    interface ValidatorOptions {
        includePassingEntities?: boolean;
        maxEntities?: number;
        onProgress?: (progress: ValidationProgress) => void;
        preview?: IDSPreviewFlags;
        translator?: TranslationService;
        yieldEveryMs?: number;
    }
    Index
    includePassingEntities? maxEntities? onProgress? preview? translator? yieldEveryMs?
    includePassingEntities?: boolean

    Whether to include passing entities in results (default: true)

    maxEntities?: number

    Maximum entities to validate (for preview/sampling)

    onProgress?: (progress: ValidationProgress) => void

    Progress callback

    preview?: IDSPreviewFlags

    IDS 1.1 PREVIEW: required to validate a document that uses 1.1 candidate features.

    translator?: TranslationService

    Translation service for human-readable output

    yieldEveryMs?: number

    How often (ms of CPU work) the validator yields to the event loop so a host UI can repaint and progress callbacks become visible (default: 40). Validation is otherwise pure CPU work whose awaits resolve through microtasks only — without these yields a browser cannot paint a single frame for the whole run.

    Settings
    Member Visibility

    On This Page
    Properties