Class Bitfield

Hierarchy

  • Uint32Array
    • Bitfield

Constructors

  • Creates a new Bitfield

    Parameters

    • size: number

      the number of bits in the array

    Returns Bitfield

Properties

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

[toStringTag]: "Uint32Array"
buffer: ArrayBufferLike

The ArrayBuffer instance referenced by the array.

byteLength: number

The length in bytes of the array.

byteOffset: number

The offset in bytes of the array.

length: number

The length of the array.

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

Accessors

Methods

  • Returns IterableIterator<number>

  • Returns the item located at the specified index.

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

    Returns undefined | number

  • Returns

    a new Bitfield based on this one with toggled bits

    Type Parameters

    • T

    Parameters

    • key: keyof T
    • sources: T[]

    Returns Bitfield

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns Bitfield

  • Returns an array of key, value pairs for every entry in the array

    Returns IterableIterator<[number, number]>

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: ((value: number, index: number, array: Uint32Array) => unknown)

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        • (value: number, index: number, array: Uint32Array): unknown
        • Parameters

          • value: number
          • index: number
          • array: Uint32Array

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

  • Changes all array elements from start to end index to a static value and returns the modified array

    Parameters

    • value: number

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns Bitfield

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • predicate: ((value: number, index: number, array: Uint32Array) => any)

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

        • (value: number, index: number, array: Uint32Array): any
        • Parameters

          • value: number
          • index: number
          • array: Uint32Array

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns Uint32Array

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Parameters

    • predicate: ((value: number, index: number, obj: Uint32Array) => boolean)

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (value: number, index: number, obj: Uint32Array): boolean
        • Parameters

          • value: number
          • index: number
          • obj: Uint32Array

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns undefined | number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: ((value: number, index: number, obj: Uint32Array) => boolean)

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: number, index: number, obj: Uint32Array): boolean
        • Parameters

          • value: number
          • index: number
          • obj: Uint32Array

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: ((value: number, index: number, array: Uint32Array) => void)

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: number, index: number, array: Uint32Array): void
        • Parameters

          • value: number
          • index: number
          • array: Uint32Array

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

  • Returns

    the index and position of a bit in the bitfield

    Parameters

    • bit: number

    Returns {
        index: number;
        position: number;
    }

    • index: number
    • position: number
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: number

      The element to search for.

    • Optional fromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: number

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

  • Returns

    true if a given bit is set in the Bitfield or null on error

    Parameters

    • bit: number

    Returns null | boolean

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

  • Returns an list of keys in the array

    Returns IterableIterator<number>

  • Returns the index of the last occurrence of a value in an array.

    Parameters

    • searchElement: number

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Parameters

    • callbackfn: ((value: number, index: number, array: Uint32Array) => number)

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: number, index: number, array: Uint32Array): number
        • Parameters

          • value: number
          • index: number
          • array: Uint32Array

          Returns number

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Uint32Array

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Uint32Array) => number)

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: number, currentValue: number, currentIndex: number, array: Uint32Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Uint32Array

          Returns number

    Returns number

  • Parameters

    • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Uint32Array) => number)
        • (previousValue: number, currentValue: number, currentIndex: number, array: Uint32Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Uint32Array

          Returns number

    • initialValue: number

    Returns number

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type Parameters

    • U

    Parameters

    • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Uint32Array) => U)

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: number, currentIndex: number, array: Uint32Array): U
        • Parameters

          • previousValue: U
          • currentValue: number
          • currentIndex: number
          • array: Uint32Array

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Uint32Array) => number)

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: number, currentValue: number, currentIndex: number, array: Uint32Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Uint32Array

          Returns number

    Returns number

  • Parameters

    • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Uint32Array) => number)
        • (previousValue: number, currentValue: number, currentIndex: number, array: Uint32Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Uint32Array

          Returns number

    • initialValue: number

    Returns number

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type Parameters

    • U

    Parameters

    • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Uint32Array) => U)

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: number, currentIndex: number, array: Uint32Array): U
        • Parameters

          • previousValue: U
          • currentValue: number
          • currentIndex: number
          • array: Uint32Array

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

  • Reverses the elements in an Array.

    Returns Uint32Array

  • Sets a value or an array of values.

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

    • Optional offset: number

      The index in the current array at which the values are to be written.

    Returns void

  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns Uint32Array

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: ((value: number, index: number, array: Uint32Array) => unknown)

      A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

        • (value: number, index: number, array: Uint32Array): unknown
        • Parameters

          • value: number
          • index: number
          • array: Uint32Array

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

  • Sorts an array.

    Parameters

    • Optional compareFn: ((a: number, b: number) => number)

      Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

      [11,2,22,1].sort((a, b) => a - b)
      
        • (a: number, b: number): number
        • Parameters

          • a: number
          • b: number

          Returns number

    Returns Bitfield

  • Gets a new Uint32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

    Parameters

    • Optional begin: number

      The index of the beginning of the array.

    • Optional end: number

      The index of the end of the array.

    Returns Uint32Array

  • Converts a number to a string by using the current locale.

    Returns string

  • Returns a string representation of an array.

    Returns string

  • Toggle a bit in the Bitfield

    Returns

    the resulting state of the bit or null if error

    Parameters

    • bit: number

    Returns null | boolean

  • Returns the primitive value of the specified object.

    Returns Uint32Array

  • Returns an list of values in the array

    Returns IterableIterator<number>

  • Creates an array from an array-like or iterable object.

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

    Returns Uint32Array

  • Creates an array from an array-like or iterable object.

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

    • mapfn: ((v: T, k: number) => number)

      A mapping function to call on every element of the array.

        • (v: T, k: number): number
        • Parameters

          • v: T
          • k: number

          Returns number

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns Uint32Array

  • Creates an array from an array-like or iterable object.

    Parameters

    • arrayLike: Iterable<number>

      An array-like or iterable object to convert to an array.

    • Optional mapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

        • (v: number, k: number): number
        • Parameters

          • v: number
          • k: number

          Returns number

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns Uint32Array

  • Create a new Bitfield from an array of objects

    Example

    // Creating 32 bit bitfield from <T extends { id: number }>:
    Bitfield.fromObjects(32, "id", [{ id: 0, ... }, ...]);

    Type Parameters

    • T

    Parameters

    • size: number

      the number of bits in the bitfield

    • key: keyof T

      the key of the property to use for the bitfield's indexes

    • objs: T[]

      an array of objects which have the key as an index to a number

    Returns Bitfield

  • Returns

    the number of set bits in a given value

    Parameters

    • value: number

    Returns number

  • Returns

    the index of a bit in a bitfield

    Parameters

    • bit: number

    Returns number

  • Returns a new array from a set of elements.

    Parameters

    • Rest ...items: number[]

      A set of elements to include in the new array object.

    Returns Uint32Array

Generated using TypeDoc