Class Description

constructor

• new Description(label): Description

• Parameters

  • label: LabelAndDescription

    the label in json format

  Returns Description

  Example

  const Description = new Description({ language: 'en', value: 'Douglas Adams' });
  Copy

language

value

internalID

• get internalID(): string

• create a unique id for the Description

  Returns string

  the id

equals

• equals(other): boolean

• this function checks if two descriptions are equal

  Parameters

  • other: LabelAndDescription

    the other Label

  Returns boolean

  true if the descriptions are equal

  Example

  const description1 = new Description({ language: 'en', value: 'foo' });
    const description2 = new Description({ language: 'en', value: 'bar' });
  
    description1.equals(description2); // false
  Copy

toJSON

• toJSON(): LabelAndDescription

• Returns LabelAndDescription

  the Description in a json format

  Example

  const json = description.toJson();
  Copy

Static fromString

• fromString(language, value): Description

• create a Description from a language and a value

  Parameters

  • language: LabelLanguages

    the language of the Description

  • value: string

    the value of the Description

  Returns Description

  the Description object

  Example

  const Description = Description.fromString('en', 'Douglas Adams')
  Copy