HED JavaScript Library
    Preparing search index...

    Class SchemaSpec

    A schema version specification.

    Index
    • Constructor.

      Parameters

      • prefix: string

        The prefix of this schema.

      • version: string

        The version of this schema.

      • Optionallibrary: string = ''

        The library name of this schema.

      • OptionallocalPath: string = ''

        The local path for this schema.

      Returns SchemaSpec

    library: string

    The library name of this schema.

    localPath: string

    The local path for this schema.

    prefix: string

    The prefix of this schema.

    version: string

    The version of this schema.

    • get localName(): string

      Compute the name for the bundled copy of this schema.

      Returns string

    • Determine if this schema specification is equivalent to another schema specification.

      Schema specifications are equivalent if either of the following is true:

      • They have the same localPath
      • They have the same prefix, version, and library.

      Parameters

      • other: any

        A schema specification to compare with this one.

      Returns boolean

      Whether the other schema specification is equivalent to this one.

    • Compute the canonical form of this specification.

      Returns string

      "library_version", or the version alone for a standard schema.

    • Parse a single schema specification string into a SchemaSpec object.

      Parameters

      • versionSpec: string

        A schema version specification string (e.g., "nickname:library_version").

      Returns SchemaSpec

      A schema specification object with parsed nickname, library, and version.

      If the schema specification format is invalid.