NM-1.0 ▶ NM ▶ Range

constructor

• new Range(start: number | bigint, end: number | bigint): NM.Range

  Parameters

  • start: number | bigint
  • end: number | bigint

  Returns NM.Range

Static$gtype

Since 1.42cmp

• cmp(b: NM.Range): number

  Compare two ranges.

  Parameters

  • b: NM.Range

    another NM.Range

  Returns number

  zero if the two instances are equivalent or a non-zero integer otherwise. This defines a total ordering over the ranges.

  Since

  1.42

Since 1.42get_range

• get_range(): [boolean, number, number]

  Gets the start and end values for the range.

  Returns [boolean, number, number]

  true if the range contains more than one element, false otherwise.

  Since

  1.42

Since 1.42ref

• ref(): NM.Range

  Increases the reference count of the object. This is thread-safe.

  Returns NM.Range

  the input argument range object.

  Since

  1.42

Since 1.42to_str

• to_str(): string

  Convert a %NMRange to a string.

  Returns string

  a string representing the range.

  Since

  1.42

Since 1.42unref

• unref(): void

  Decreases the reference count of the object. If the reference count reaches zero the object will be destroyed. This is thread-safe.

  Returns void

  Since

  1.42

StaticSince 1.42from_str

• from_str(str: string): NM.Range

  Parses the string representation of the range to create a %NMRange instance.

  Parameters

  • str: string

    the string representation of a range

  Returns NM.Range

  Since

  1.42

Staticnew

• new(start: number | bigint, end: number | bigint): NM.Range

  Parameters

  • start: number | bigint
  • end: number | bigint

  Returns NM.Range