swiing / bit-typedarray Goto Github PK

> import BitArray from "@bitarray/typedarray"
undefined
> let d = new BitArray([0,1,1], 0, 10)
<repl>.ts:5:31 - error TS2554: Expected 1 arguments, but got 3.

BitArray doesn't seem to support both buffer, byteOffset and length in the constructor, as other TypedArrays do:

new TypedArray(buffer, byteOffset, length)

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray#constructor

Current code only partially implements standard features of typed arrays. This issue provides a place to track progress and view it all in one shot.

PRs welcome!

Constructor

• new TypedArray()
• new TypedArray(length)
• new TypedArray(typedArray)
• new TypedArray(object)
• new TypedArray(buffer): see here

Unrelevant (= won't implement)

• new TypedArray(buffer, byteOffset): see here
• new TypedArray(buffer, byteOffset, length): see here

Static properties

• BYTES_PER_ELEMENT
• name
• get BitArray[@@species]

Static methods

• from()
• of()

Instance properties

• buffer
• byteLength
• byteOffset
• length

Instance methods

• at(): see here for discussion
• copyWithin()
• entries()
• every()
• fill()
• filter()
• find()
• findIndex()
• forEach()
• includes()
• indexOf()
• join()
• keys()
• lastIndexOf()
• map()
• reduce()
• reduceRight()
• reverse()
• set()
• slice()
• some()
• sort()
• subarray()
• values()
• toString(): see here for note on implementation.
• [@@iterator]()

Irrelevant (= won't implement)

• toLocaleString(): there is no local variation to displaying 1s or 0s.

Typed array constructors can take an ArrayBuffer instance as single argument. E.g.:

let buffer = new ArrayBuffer(12);
new Uint32Array(buffer);

The length of the typed array is the length of the buffer, divided by the TypedArray.BYTES_PER_ELEMENT.

If applied to BitArrays, that would imply the length of BitArrays can only be multiple of 8. However, there is no reason that length of bit arrays should be so. Hence, I have written:

I have not yet made my mind whether it makes sense to construct a BitArray by passing an array buffer to the constructor.

This issue is created to open the discussion.