HED JavaScript Library
    Preparing search index...

    Class default

    A schema unit modifier.

    Hierarchy (View Summary)

    Index
    constructor
    _description _name booleanAttributeNames booleanAttributes valueAttributeNames valueAttributes IGNORED_ATTRIBUTES
    description name
    equivalent getAttributeValues getSingleAttributeValue hasAttribute hasBooleanAttribute sortByName

    • 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

    _description: string | undefined

    The description of this schema entry.

    _name

    _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 unit modifier is equivalent to another schema unit modifier.

      Schema unit modifiers are equivalent if they have the same name, description, and attributes.

      Parameters

      • other: any

        A schema unit modifier to compare with this one.

      Returns boolean

      Whether the other unit modifier is equivalent to this schema unit modifier.

    • 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.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods