HED JavaScript Library
    Preparing search index...

    A generic schema entry with schema attributes.

    Hierarchy (View Summary)

    Index
    • Constructor.

      Parameters

      • name: string

        The name of this schema entry.

      • description: string | undefined

        The description of this schema entry.

      • booleanAttributes: Set<SchemaAttribute>

        The boolean attributes for this schema entry.

      • valueAttributes: Map<SchemaAttribute, string[]>

        The value attributes for this schema entry.

      Returns default

    _description: string | undefined

    The description of this schema entry.

    _name: string

    The name of this schema entry.

    booleanAttributeNames: Set<string>

    The set of boolean attribute names this schema entry has.

    booleanAttributes: Set<SchemaAttribute>

    The set of boolean attributes this schema entry has.

    valueAttributeNames: Map<string, string[]>

    The collection of value attribute names this schema entry has.

    valueAttributes: Map<SchemaAttribute, string[]>

    The collection of value attributes this schema entry has.

    IGNORED_ATTRIBUTES: Set<string> = ...

    The attributes ignored when comparing two declarations of an element: inLibrary names the declaring library and hedId differs between schemas by construction.

    • get description(): string | undefined

      The description of this schema entry.

      Returns string | undefined

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

      Entries with attributes are equivalent if they have the same name, description, boolean attributes, and value attributes (by name, values in any order), ignoring inLibrary and hedId.

      Parameters

      • other: any

        A schema entry to compare with this one.

      Returns boolean

      Whether the other entry is equivalent to this schema entry.

    • Retrieve all values of a value attribute (by name) on this schema entry.

      Parameters

      • attributeName: string

        The attribute whose value should be returned.

      Returns string[] | undefined

      The values of the attribute.

    • Retrieve a single value of a value attribute (by name) on this schema entry, throwing an error if more than one value exists.

      Parameters

      • attributeName: string

        The attribute whose value should be returned.

      Returns string | undefined

      The value of the attribute.

      If the attribute has more than one value.

    • Whether this schema entry has this attribute (by name).

      Parameters

      • attributeName: string

        The attribute to check for.

      Returns boolean

      Whether this schema entry has this attribute.