Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NumericRange

  subscribe now with sterfive to access the online-user manual

Hierarchy

  • NumericRange

Implements

  • NumericalRange1

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns NumericRange

  • Parameters

    • value: string

    Returns NumericRange

  • Parameters

    • value: number
    • Optional secondValue: number

    Returns NumericRange

  • Parameters

    • value: number[]

    Returns NumericRange

  • Parameters

    • value: number[]
    • secondValue: number[]

    Returns NumericRange

Properties

type

type: NumericRangeType

value

value: NumericalRangeValueType

Static NumericRangeType

NumericRangeType: typeof NumericRangeType

Static coerce

coerce: (value: any | string | NumericRange | null | number[]) => NumericRange

Type declaration

Static Readonly empty

empty: NumericalRange0

Static schema

schema: { coerce: (value: any | string | NumericRange | null | number[]) => NumericRange; decode: (stream: BinaryStream, _value?: NumericRange) => NumericRange; encode: (numericRange: NumericRange, stream: OutputBinaryStream) => void; name: string; subType: string; defaultValue: any; random: any }

Type declaration

Methods

extract_values

  • extract_values<U, T>(array: T, dimensions?: number[]): ExtractResult<T>
  • method

    extract_values

    Type parameters

    • U

    • T: ArrayLike<U, T>

    Parameters

    • array: T

      flat array containing values or string

    • Optional dimensions: number[]

    Returns ExtractResult<T>

isDefined

  • isDefined(): boolean

  • Returns boolean

isEmpty

  • isEmpty(): boolean

  • Returns boolean

isValid

  • isValid(): boolean

  • Returns boolean

set_values

  • set_values(arrayToAlter: Buffer | [], newValues: Buffer | []): { array: Buffer | []; statusCode: StatusCode }

  • Parameters

    • arrayToAlter: Buffer | []
    • newValues: Buffer | []

    Returns { array: Buffer | []; statusCode: StatusCode }

set_values_matrix

  • set_values_matrix(sourceToAlter: { dimensions: number[]; matrix: Buffer | [] }, newMatrix: Buffer | []): { matrix: Buffer | []; statusCode: StatusCode }

  • Parameters

    • sourceToAlter: { dimensions: number[]; matrix: Buffer | [] }
      • dimensions: number[]
      • matrix: Buffer | []
    • newMatrix: Buffer | []

    Returns { matrix: Buffer | []; statusCode: StatusCode }

toEncodeableString

  • toEncodeableString(): string

  • Returns string

toJSON

  • toJSON(): string

  • Returns string

toString

  • toString(): string

  • Returns string

Static overlap

  • overlap(nr1?: NumericalRange0, nr2?: NumericalRange0): boolean

  • Parameters

    • Optional nr1: NumericalRange0
    • Optional nr2: NumericalRange0

    Returns boolean

Generated using TypeDoc