Class Label

constructor

• new Label(label: LabelAndDescription): Label

• Parameters

  • label: LabelAndDescription

    The label for this class in JSON format.

  Returns Label

  Example

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

language

value

internalID

• get internalID(): string

• Create a unique ID for the Label.

  Returns string

  The ID.

equals

• equals(other: LabelAndDescription): boolean

• This function checks if two Labels are equal.

  Parameters

  • other: LabelAndDescription

    The other Label.

  Returns boolean

  True if the Labels are equal.

  Example

  const label1 = new Label({ language: 'en', value: 'foo' });
      const label2 = new Label({ language: 'en', value: 'bar' });
  
      label1.equals(label2); // false
  Copy

toJSON

• toJSON(): LabelAndDescription

• Returns LabelAndDescription

  The label as JSON.

  Example

  const json = label.toJSON();
  Copy

StaticfromString

• fromString(language: LabelLanguages, value: string): Label

• Create a label from a language and a value.

  Parameters

  • language: LabelLanguages

    The language of the label.
  • value: string

    The value of the label.

  Returns Label

  The label object.

  Example

  const label = Label.fromString('en', 'Douglas Adams');
  Copy