Class QuantitySnak

constructor

• new QuantitySnak(snak): QuantitySnak

• Parameters

  • snak: QuantitySnak

    the snak for this class in json format

  Returns QuantitySnak

  Throws

  if the upperBound is smaller than the amount or the lowerBound is bigger than the amount

  Example

  const snak = new QuantitySnak(json);
  Copy

datatype

unit

amount

• get amount(): undefined | number

• Returns undefined | number

  the amount of the quantity
• set amount(number): void

• Parameters

  • number: undefined | number

    the number that the amount will be set to

  Returns void

lowerBound

• get lowerBound(): undefined | number

• Returns undefined | number

  the lowerBound of the quantity
• set lowerBound(number): void

• Parameters

  • number: undefined | number

    the number that the lowerBound will be set to

  Returns void

upperBound

• get upperBound(): undefined | number

• Returns undefined | number

  the upperBound of the quantity
• set upperBound(number): void

• Parameters

  • number: undefined | number

    the number that the upperBound will be set to

  Returns void

equals

• equals(other): boolean

• this function checks if two snaks are equal

  Parameters

  • other: QuantitySnak

    the other snak

  Returns boolean

  true if the snaks are equal

  Example

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

toJSON

• toJSON(): QuantitySnak

• Returns QuantitySnak

  the snak as json

  Example

  const json = quantitySnak.toJson();
  Copy

Static fromNumbers

• fromNumbers(property, quantity, lowerBound?, upperBound?, unit?): QuantitySnak

• create a snak from some basic data

  Parameters

  • property: `P${number}`

    the property of the snak in 'P-form'

  • quantity: number

    amount of the quantity

  • Optional lowerBound: null | number

    lowerBound of the quantity

  • Optional upperBound: null | number

    upperBound of the quantity

  • Optional unit: `Q${number}`

    unit of the quantity

  Returns QuantitySnak

  a snak with the given properties

  Static

  Example

  const snak = QuantitySnak.fromNumbers('P1215', 1);
  Copy