Class default

constructor

• new default(
      name: string,
      description: string | undefined,
      booleanAttributes: Set<SchemaAttribute>,
      valueAttributes: Map<SchemaAttribute, string[]>,
      allowedNames?: string[],
  ): default

  Constructor.

  Parameters

  • name: string

    The name of this value class.

  • description: string | undefined

    The description of this value class.

  • booleanAttributes: Set<SchemaAttribute>

    The boolean attributes for this value class.

  • valueAttributes: Map<SchemaAttribute, string[]>

    The value attributes for this value class.

  • allowedNames: string[] = []

    The character set names that define the class's characters.

  Returns default

_wordRegex

allowedNames

equivalent

• equivalent(other: any): boolean

  Determine if this schema value class is equivalent to another schema value class.

  Value classes are equivalent if they have the same name, description, attributes, and allowed characters (in any order, as for the attribute values).

  Parameters

  • other: any

    A schema value class to compare with this one.

  Returns boolean

  Whether the other value class is equivalent to this schema value class.

validateValue

• validateValue(value: string): boolean

  Determine if a value is valid according to this value class.

  Parameters

  • value: string

    A HED value.

  Returns boolean

  Whether the value conforms to this value class.

valueProblem

• valueProblem(
      value: string,
  ): { rule: true } | { characters: [number, string][] } | null

  Say why a value fails this class, checking the whole-value rule before the characters, as hed-python does.

  Parameters

  • value: string

    A HED value.

  Returns { rule: true } | { characters: [number, string][] } | null

  null if the value is valid; {rule: true} if it is empty, breaks the class's whole-value rule, or (dateTimeClass) names a date that does not exist; otherwise the characters the class does not allow, as [index, character] pairs.