NodeOPCUA API Documentation
    Preparing search index...

    Interface NodesetFormat

    a serialisation the loader can read

    interface NodesetFormat {
        extensions?: readonly string[];
        name: string;
        priority?: number;
        readModels(document: NodesetDocument): Promise<NodesetModelInfo>;
        records(
            document: NodesetDocument,
            options?: NodeSetLoaderOptions,
        ): AsyncIterable<NodesetRecord>;
        sniff(head: NodesetHead): boolean;
    }
    Index
    extensions? name priority?
    readModels records sniff
    extensions?: readonly string[]

    the file extensions this format is usually written with, lowercase and dotted. Documentation and tooling only: the loader never decides on a name.

    name: string

    how this format is named in diagnostics and in the tools; unique among registered formats

    priority?: number

    which format wins when more than one claims a document. Higher is stronger; the default is 0. NodeSet2 XML registers at -100 because it is the fallback: it claims anything no other format recognised, which is the behaviour the loader has always had.

    • whether this format claims the document that begins like this

      Parameters

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods