microscope-js - v0.0.0
    Preparing search index...

    Interface Renderer

    The single interface every format implementation must satisfy. Stateless — instances are reusable across renders.

    interface Renderer {
        extensions: readonly string[];
        id: string;
        mimes: readonly string[];
        name: string;
        canRender?(source: NormalizedSource): boolean | Promise<boolean>;
        render(ctx: RenderContext): Promise<RenderHandle>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    extensions id mimes name

    Methods

    canRender? render

    Properties

    extensions: readonly string[]

    Lowercase file extensions this renderer claims (no leading dot).

    id: string

    Unique id — e.g. pdf, image, docx.

    mimes: readonly string[]

    MIME types this renderer claims. Supports * wildcards (e.g. image/*).

    name: string

    Human-readable name for UI.

    Methods

    • Cheap predicate run by the registry. Defaults check MIME + extension; renderers that need byte-sniffing override this to inspect source.bytes().

      Parameters

      Returns boolean | Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods