Class Definition

defContents

defGroup

defTag

name

placeholder

equivalent

• equivalent(other: any): boolean

  Return true if this definition is the same as the other.

  Parameters

  • other: any

    Another definition to compare with this one.

  Returns boolean

  True if the definitions are equivalent

evaluateDefinition

• evaluateDefinition(
      tag: ParsedHedTag,
      hedSchema: Schemas,
      placeholderAllowed: boolean,
  ): any[]

  Return the evaluated definition contents and any issues.

  Parameters

  • tag: ParsedHedTag

    The parsed HED tag whose details should be checked.

  • hedSchema: Schemas

    The HED schemas used to validate against.

  • placeholderAllowed: boolean

    If true then placeholder is allowed in the def tag.

  Returns any[]

  A tuple [string|null, Issue[], Issue[]] containing the evaluated normalized definition string and any issues in the evaluation,

StaticcreateDefinition

• createDefinition(hedString: string, hedSchemas: Schemas): any[]

  Create a list of Definition objects from a list of strings.

  Parameters

  • hedString: string

    A string representing a definition.

  • hedSchemas: Schemas

    The HED schemas to use in creation.

  Returns any[]

  A tuple [Definition|null, Issue[], Issue[]] with the definition and any issues.

StaticcreateDefinitionFromGroup

• createDefinitionFromGroup(group: ParsedHedGroup): any[]

  Create a definition from a ParsedHedGroup.

  Parameters

  • group: ParsedHedGroup

    The group to create a definition from.

  Returns any[]

  A tuple [Definition|null, Issue[], Issue[]] with the definition and any issues. (The definition will be null if issues.)