Class QuantitySnak

constructor

• new QuantitySnak(snak: QuantitySnak): 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: undefined | 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: undefined | 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: undefined | number): void

• Parameters

  • number: undefined | number

    The number that the upperBound will be set to.

  Returns void

equals

• equals(other: QuantitySnak): 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 the snak as JSON.

  Returns QuantitySnak

  The snak as JSON.

  Example

  const json = quantitySnak.toJSON();
  Copy

StaticfromNumbers

• fromNumbers(
      property: `P${number}`,
      quantity: number,
      lowerBound?: null | number,
      upperBound?: null | number,
      unit?: `Q${number}`,
  ): 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.
  • OptionallowerBound: null | number

    LowerBound of the quantity.
  • OptionalupperBound: null | number

    UpperBound of the quantity.
  • Optionalunit: `Q${number}`

    Unit of the quantity.

  Returns QuantitySnak

  A snak with the given properties.

  Static

  Example

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