Class Alias

constructor

• new Alias(alias: LabelAndDescription): Alias

• Constructor for Alias.

  Parameters

  • alias: LabelAndDescription

    The alias in JSON format.

  Returns Alias

  Example

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

language

value

internalID

• get internalID(): string

• Create a unique ID for the Alias.

  Returns string

  The ID.

equals

• equals(other: LabelAndDescription): boolean

• Check if two Aliases are equal.

  Parameters

  • other: LabelAndDescription

    The other alias.

  Returns boolean

  True if the aliases are equal.

  Example

  const alias1 = new Alias({ language: 'en', value: 'foo' });
     const alias2 = new Alias({ language: 'en', value: 'bar' });
  
     alias1.equals(alias2); // false
  Copy

toJSON

• toJSON(): LabelAndDescription

• Convert the alias to a JSON format.

  Returns LabelAndDescription

  The alias in JSON format.

  Example

  const json = alias.toJSON();
  Copy

StaticfromString

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

• Create an Alias from a language and a value.

  Parameters

  • language: LabelLanguages

    The language of the Alias.
  • value: string

    The value of the Alias.

  Returns Alias

  The Alias object.

  Example

  const alias = Alias.fromString('en', 'Douglas Adams');
  Copy