@omnist-dev/omnist
    Preparing search index...

    Interface Format

    A registered format plugin: a name plus read/write/check callables.

    interface Format {
        check?: (node: unknown) => WriteReport;
        name: string;
        read: (text: string, opts?: unknown) => unknown;
        write: (node: unknown, opts?: unknown) => string;
    }
    Index
    check? name read write
    check?: (node: unknown) => WriteReport

    node -> WriteReport; simulates a write without producing output.

    name: string

    Registered format name identifier (e.g. "json", "yaml", "oml").

    read: (text: string, opts?: unknown) => unknown

    text -> node. opts is format-specific (e.g. XML's { report } for read-time codec diagnostics, issue #123/D-3); most formats ignore it. Every built-in reader honours opts.maxInputBytes (D-23); a plugin's may not, which is why readFormat checks the size itself.

    write: (node: unknown, opts?: unknown) => string

    (node, opts?) -> text

    Settings
    Member Visibility

    On This Page
    Properties