HED JavaScript Library
    Preparing search index...

    A schema attribute.

    Hierarchy (View Summary)

    Index
    • Constructor.

      Parameters

      • name: string

        The name of the schema attribute.

      • description: string | undefined

        The description of the schema attribute.

      • properties: Set<SchemaProperty>

        The properties assigned to this schema attribute.

      • recursive: boolean

        Whether this attribute is recursive.

      Returns default

    _description: string | undefined

    The description of this schema entry.

    _name: string

    The name of this schema entry.

    _properties: Set<SchemaProperty>

    The properties assigned to this schema attribute, one for each property name written in its declaration (a name the schema does not define is an unregistered property of that name).

    _recursive: boolean

    Whether this attribute is recursive.

    • get description(): string | undefined

      The description of this schema entry.

      Returns string | undefined

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

      Schema attributes are equivalent if they have the same name, description, and property names, including names the schema does not define (specification 3.1.2.4).

      Parameters

      • other: any

        A schema attribute to compare with this one.

      Returns boolean

      Whether the other attribute is equivalent to this schema attribute.

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

      This method is a stub to be overridden in SchemaEntryWithAttributes.

      Parameters

      • attributeName: string

        The attribute to check for.

      Returns boolean

      Whether this schema entry has this attribute.