Class EntitySchemaSnak

constructor

• new EntitySchemaSnak(snak: EntitySchemaSnak): EntitySchemaSnak

• Parameters

  • snak: EntitySchemaSnak

    The snak for this class in JSON format.

  Returns EntitySchemaSnak

  Example

  const snak = new EntitySchemaSnak(json);
  Copy

datatype

id

• get id(): undefined | string

• The value will be prefixed with E.

  Returns undefined | string

  The value of the snak.

  Alias

  id

• set id(value: undefined | string): void

• Parameters

  • value: undefined | string

    The value of the snak.

  Returns void

  Alias

  id

numericID

• get numericID(): undefined | number

• Returns undefined | number

  The value of the snak.

  Alias

  numericID

• set numericID(value: undefined | number): void

• Parameters

  • value: undefined | number

    The value of the snak.

  Returns void

  Alias

  numericID

equals

• equals(other: EntitySchemaSnak): boolean

• This function checks if two snaks are equal.

  Parameters

  • other: EntitySchemaSnak

    The other snak.

  Returns boolean

  True if the snaks are equal.

  Example

  if (snak.equals(other)) {
      // do something
    }
  Copy

toJSON

• toJSON(): EntitySchemaSnak

• Returns EntitySchemaSnak

  The snak as JSON.

  Example

  const json = EntitySchemaSnak.toJSON();
  Copy

StaticfromID

• fromID(property: `P${number}`, id: `E${number}`): EntitySchemaSnak

• Create a snak from a property and an ID string.

  Parameters

  • property: `P${number}`

    The property of the snak in 'P-form'.
  • id: `E${number}`

    The entity schema ID.

  Returns EntitySchemaSnak

  A snak with the given properties.

  Static

  Example

  const snak = EntitySchemaSnak.fromID('P698', 'E12345678');
  Copy