1
1
# bit-array
2
2
3
+ ** License** :
4
+ [ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
5
+ ** Branches, Functions, Lines, Statements** :
6
+ ![ Coverage Branches] ( ./coverage/badge-branches.svg )
7
+ ![ Coverage Functions] ( ./coverage/badge-functions.svg )
8
+ ![ Coverage Lines] ( ./coverage/badge-lines.svg )
9
+ ![ Coverage Statements] ( ./coverage/badge-statements.svg )
10
+
3
11
Save memory space by using a BitArray! Behind the scene, the library stores bits within elements of a ` Uint8Array ` resulting in memory space savings.
4
12
5
13
``` typescript
@@ -65,7 +73,7 @@ Method | Description
65
73
--- | ---
66
74
** ` pushAll(values: Array<bit>) ` ** | Pushes a an array of bits onto the array
67
75
** ` push(value: bit) ` ** | Pushes a single bit onto the array
68
- ** ` atIndex(index: number) ` ** | Gets the bit at a given index.
76
+ ** ` atIndex(index: number) ` ** | Gets the bit at a given index
69
77
** ` atIndexRange(index: number, count?: number) ` ** | Gets count bits at a given index. If count is null, the range goes to the end of the array
70
78
** ` set(index: number, value: bit) ` ** | Sets a specified bit at an index of the array
71
79
@@ -87,3 +95,6 @@ Initial release
87
95
Added method set and made count parameter optional for atIndexRange
88
96
- ` set(index: number, value: bit) `
89
97
- ` atIndexRange(index: number, count?: number) `
98
+
99
+ ### 1.2.0
100
+ Added code coverage badge creation on running tests
0 commit comments