Class Description

constructor

• new Description(label: LabelAndDescription): Description

• Constructor for the Description class.

  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: LabelAndDescription): boolean

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

• Convert the Description to a JSON format.

  Returns LabelAndDescription

  The Description in JSON format.

  Example

  const json = description.toJSON();
  Copy

StaticfromString

• fromString(language: LabelLanguages, value: string): 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