52 |
56 |
53 |
55 | circular_buffer_js
54 |
58 |
96 |
110 |
59 |
95 |
60 |
61 |
63 |
73 |
74 |
75 |
94 | Index
62 |
64 |
65 |
71 |
72 | Modules
66 |-
67 |
- circular_
buffer
68 | - generated/package_
version
69 |
111 |
113 |
114 |
115 |
116 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # circular_buffer_js
2 |
3 | [](https://github.com/StoneCypher/circular_buffer_js/blob/master/LICENSEs)
4 | []()
5 | []()
6 | [](https://github.com/StoneCypher/circular_buffer_js/issues)
7 | []()
8 |
9 | ```
10 | npm install --save-dev circular_buffer_js
11 | ```
12 |
13 | * [Documentation](https://stonecypher.github.io/circular_buffer_js/docs/)
14 | * [Main functional documentation](https://stonecypher.github.io/circular_buffer_js/docs/classes/circular_buffer.circular_buffer-1.html)
15 | * [Build history](https://github.com/StoneCypher/circular_buffer_js/actions)
16 |
17 | `Typescript` implementation of a circular buffer, and JS compiles to a es6
18 | module minified, es6 commonjs minified, es6 iife minified, and es6 iife full.
19 |
20 | 1. Well tested.
21 | * 100% coverage, 100% property coverage.
22 | 1. Tiny.
23 | * The `es6` minified module build is currently 1.4k.
24 | 1. Dependency-free.
25 | * Only dev-time deps like `typescript` are involved.
26 |
27 |
28 |
29 |
30 |
31 | Generated using TypeDoc
112 |32 | 33 | ## API 34 | 35 | You should consider viewing the 36 | [real documentation](https://stonecypher.github.io/circular_buffer_js/docs/classes/circular_buffer.circular_buffer-1.html), 37 | but: 38 | 39 | ```typescript 40 | // yields a buffer of fixed size `size` 41 | const cb = new circular_buffer(size), 42 | cb2 = circular_buffer.from([1,2,3]); 43 | 44 | cb.push(item); // inserts `item` at end of `cb`, then returns `item` 45 | cb.shove(item); // inserts `item` at end of `cb`; remove if needed, returns removed 46 | cb.pop(); // removes and returns first element 47 | cb.at(location); // shows the element at 0-indexed offset `location` 48 | cb.pos(location); // shows the element at run-indexed offset `location` 49 | cb.offset(); // shows the delta from 0-indexed to head 50 | cb.indexOf(item); // returns the index of the first `item`, or -1 51 | cb.find(pred); // return the the first match or undefined 52 | cb.every(pred); // tests if every queue element satisfies the predicate 53 | cb.some(pred); // tests if at least one element satisfies the predicate 54 | cb.fill(item); // maxes `length` and sets every element to `item` 55 | cb.clear(); // empties the container 56 | cb.reverse(); // reverses the container 57 | cb.resize(size,pE); // change to new size, truncating if required; pE to prefer end 58 | cb.toArray(); // return an array of the current contents of the queue 59 | 60 | cb.first; // returns the first value in the queue; throws when empty 61 | cb.last; // returns the last value in the queue; throws when empty 62 | cb.isFull; // returns `true` if no space left; `false` otherwise 63 | cb.isEmpty; // returns `true` if no space remains; `false` otherwise 64 | cb.available; // returns the number of spaces remaining currently 65 | cb.capacity; // returns the total `size` allocated 66 | cb.length; // returns the amount of space currently used 67 | ``` 68 | 69 | 70 | 71 | 72 | 73 |
74 | 75 | ## What is this? 76 | 77 | This is a circular buffer (or cycle buffer, ring queue, etc.) It was written 78 | because a library I wanted to use had a native buggy implementation, so I 79 | provided something more trustworthy. 80 | 81 | A circular buffer is a fixed size buffer that allows you to push and pop 82 | forever, as a first in first out queue-like structure. Circular buffers are 83 | more efficient than queues, but can overflow. 84 | 85 | 86 | 87 |
88 | 89 | ### Basic usage 90 | 91 | ```javascript 92 | import { circular_buffer } from 'circular_buffer_js'; 93 | 94 | const cb = new circular_buffer(3); // [ , , ] 95 | 96 | cb.push(1); // ok: [1, , ] 97 | cb.push(2); // ok: [1,2, ] 98 | cb.push(3); // ok: [1,2,3] 99 | 100 | cb.at(0); // 1 101 | cb.first; // 1 102 | cb.last; // 3 103 | 104 | cb.push(4); // throws - full! ; [1,2,3] 105 | 106 | cb.pop(); // 1: [2,3, ] 107 | cb.at(0); // 2: [2,3, ] 108 | 109 | cb.push(4); // ok: [2,3,4] 110 | cb.push(5); // throws - full! ; [2,3,4] 111 | 112 | cb.pop(); // 2: [3,4, ] 113 | cb.pop(); // 3: [4, , ] 114 | cb.pop(); // 4: [ , , ] 115 | 116 | cb.pop(); // throws - empty! ; [ , , ] 117 | ``` 118 | 119 | 120 | 121 |
122 | 123 | ### Typescript 124 | 125 | It's typescript, so you can also 126 | 127 | ```typescript 128 | import { circular_buffer } from 'circular_buffer_js'; 129 | const cb = new circular_buffer
135 | 136 | ### Node CommonJS 137 | 138 | And there's a CommonJS build, so you can 139 | 140 | ```javascript 141 | const cbuf = require('circular_buffer_js'), 142 | circular_buffer = new cbuf.circular_buffer; 143 | ``` 144 | 145 | 146 | 147 |
148 | 149 | ### Browser <script> 150 | 151 | There're also two `iife` builds - both regular and minified - so that you can 152 | use this in older browsers, or from CDN. 153 | 154 | ```html 155 | 156 | 170 | ``` 171 | 172 | 173 | 174 |
175 | 176 | ## Alternatives 177 | 178 | If this doesn't meet your needs, please try: 179 | 180 | * [ring-buffer-ts](https://www.npmjs.com/package/ring-buffer-ts) 181 | * [CBuffer](https://www.npmjs.com/package/CBuffer) 182 | * [ringbuffer.js](https://www.npmjs.com/package/ringbufferjs) 183 | * [qlist](https://www.npmjs.com/package/qlist) 184 | * [fixed-size-list](https://www.npmjs.com/package/fixed-size-list) 185 | * [circular-buffer](https://www.npmjs.com/package/circular-buffer) 186 | * [cyclist](https://www.npmjs.com/package/cyclist) 187 | * [cyclic-buffer](https://www.npmjs.com/package/cyclic-buffer) 188 | * [bsh-circular-buffer](https://www.npmjs.com/package/bsh-circular-buffer) 189 | * [cbarrick-circular-buffer](https://www.npmjs.com/package/cbarrick-circular-buffer) 190 | * [limited-cache](https://www.npmjs.com/package/limited-cache) 191 | -------------------------------------------------------------------------------- /docs/docs/modules/generated_package_version.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
52 |
64 |
53 |
61 |
63 | Module generated/package_version
62 |
66 |
133 |
147 |
67 |
132 |
68 |
69 |
71 |
81 |
82 |
83 |
85 |
86 |
94 |
95 |
96 |
104 |
105 |
106 |
131 | Index
70 |
72 |
73 |
79 |
80 | Variables
74 |-
75 |
- packagename 76 |
- version 77 |
Variables
84 |Const packagename
87 | 88 | 93 |Const version
97 | 98 | 103 |
148 |
150 |
151 |
152 |
153 |
--------------------------------------------------------------------------------
/dist/circular_buffer.iife.js:
--------------------------------------------------------------------------------
1 | var circular_buffer = (function (exports) {
2 | 'use strict';
3 |
4 | const version = '1.10.0';
5 |
6 | class circular_buffer {
7 | constructor(uCapacity) {
8 | if (!(Number.isInteger(uCapacity))) {
9 | throw new RangeError(`Capacity must be an integer, received ${uCapacity}`);
10 | }
11 | if (uCapacity < 0) {
12 | throw new RangeError(`Capacity must be a non-negative integer, received ${uCapacity}`);
13 | }
14 | this._values = new Array(uCapacity);
15 | this._capacity = uCapacity;
16 | this._cursor = 0;
17 | this._offset = 0;
18 | this._length = 0;
19 | }
20 | get capacity() {
21 | return this._capacity;
22 | }
23 | set capacity(newSize) {
24 | this.resize(newSize);
25 | }
26 | get length() {
27 | return this._length;
28 | }
29 | set length(newLength) {
30 | if (newLength > this._capacity) {
31 | throw new RangeError(`Requested new length [${newLength}] exceeds container capacity [${this._capacity}]`);
32 | }
33 | if (newLength < 0) {
34 | throw new RangeError(`Requested new length [${newLength}] cannot be negative`);
35 | }
36 | if (!(Number.isInteger(newLength))) {
37 | throw new RangeError(`Requested new length [${newLength}] must be an integer`);
38 | }
39 | if (this._length <= newLength) {
40 | return;
41 | }
42 | this._length = newLength;
43 | }
44 | get available() {
45 | return this._capacity - this._length;
46 | }
47 | get isEmpty() {
48 | return this._length === 0;
49 | }
50 | get isFull() {
51 | return this._length === this._capacity;
52 | }
53 | get first() {
54 | if (this.isEmpty) {
55 | throw new RangeError('Cannot return first element of an empty container');
56 | }
57 | return this.at(0);
58 | }
59 | get last() {
60 | if (this.isEmpty) {
61 | throw new RangeError('Cannot return last element of an empty container');
62 | }
63 | return this.at(this.length - 1);
64 | }
65 | static from(i, map_fn, t) {
66 | const new_array = map_fn
67 | ? Array.from(i, map_fn, t)
68 | : Array.from(i);
69 | const target_length = new_array.length;
70 | const ncb = new circular_buffer(target_length);
71 | ncb._values = new_array;
72 | ncb._length = target_length;
73 | return ncb;
74 | }
75 | push(v) {
76 | if (this.isFull) {
77 | throw new RangeError(`Cannot push, structure is full to capacity`);
78 | }
79 | this._values[(this._cursor + this._length++) % this._capacity] = v;
80 | return v;
81 | }
82 | shove(v) {
83 | let shoved;
84 | if (this._capacity === 0) {
85 | throw new RangeError(`Cannot shove, structure is zero-capacity`);
86 | }
87 | if (this.isFull) {
88 | shoved = this.pop();
89 | }
90 | this.push(v);
91 | return shoved;
92 | }
93 | fill(x) {
94 | for (let i = 0; i < this._capacity; i++) {
95 | this._values[i] = x;
96 | }
97 | this._length = this._capacity;
98 | return this._values;
99 | }
100 | indexOf(searchElement, fromIndex) {
101 | const normalized = this.toArray();
102 | return normalized.indexOf(searchElement, fromIndex);
103 | }
104 | find(predicate, thisArg) {
105 | return this.toArray().find(predicate, thisArg);
106 | }
107 | every(functor, thisArg) {
108 | const normalized = this.toArray(), res = normalized.every(functor, thisArg);
109 | this._values = normalized;
110 | this._values.length = this._capacity;
111 | this._cursor = 0;
112 | return res;
113 | }
114 | some(functor, thisArg) {
115 | const normalized = this.toArray(), res = normalized.some(functor, thisArg);
116 | this._values = normalized;
117 | this._values.length = this._capacity;
118 | this._cursor = 0;
119 | return res;
120 | }
121 | reverse() {
122 | const normalized = this.toArray();
123 | this._values = normalized.reverse();
124 | this._values.length = this._capacity;
125 | this._cursor = 0;
126 | return this;
127 | }
128 | clear() {
129 | const old = this.toArray();
130 | this._length = 0;
131 | return old;
132 | }
133 | pop() {
134 | if (this._length <= 0) {
135 | throw new RangeError(`Cannot pop, structure is empty`);
136 | }
137 | const cache = this.at(0);
138 | --this._length;
139 | ++this._offset;
140 | ++this._cursor;
141 | if (this._cursor >= this._capacity) {
142 | this._cursor -= this._capacity;
143 | }
144 | return cache;
145 | }
146 | at(i) {
147 | if (i < 0) {
148 | throw new RangeError(`circular_buffer does not support negative traversals; called at(${i})`);
149 | }
150 | if (!(Number.isInteger(i))) {
151 | throw new RangeError(`Accessors must be non-negative integers; called at(${i})`);
152 | }
153 | if (i >= this._capacity) {
154 | throw new RangeError(`Requested cell ${i} exceeds container permanent capacity`);
155 | }
156 | if (i >= this._length) {
157 | throw new RangeError(`Requested cell ${i} exceeds container current length`);
158 | }
159 | return this._values[(this._cursor + i) % this._capacity];
160 | }
161 | pos(i) {
162 | return this.at(i - this.offset());
163 | }
164 | offset() {
165 | return this._offset;
166 | }
167 | resize(newSize, preferEnd = false) {
168 | this._values = this.toArray();
169 | this._cursor = 0;
170 | const oldSize = this._length;
171 | this._length = Math.min(this._length, newSize);
172 | this._capacity = newSize;
173 | if (newSize >= oldSize) {
174 | this._values.length = newSize;
175 | }
176 | else {
177 | if (preferEnd) {
178 | const tmp = this._values.slice(oldSize - newSize);
179 | this._values = tmp;
180 | }
181 | else {
182 | this._values.length = newSize;
183 | }
184 | }
185 | }
186 | toArray() {
187 | const startPoint = this._cursor % this._capacity;
188 | if (this._capacity > (startPoint + this._length)) {
189 | return this._values.slice(startPoint, startPoint + this._length);
190 | }
191 | else {
192 | const base = this._values.slice(startPoint, this._capacity);
193 | base.push(...this._values.slice(0, this.length - (this._capacity - startPoint)));
194 | return base;
195 | }
196 | }
197 | }
198 |
199 | exports.circular_buffer = circular_buffer;
200 | exports.version = version;
201 |
202 | Object.defineProperty(exports, '__esModule', { value: true });
203 |
204 | return exports;
205 |
206 | }({}));
207 |
--------------------------------------------------------------------------------
/docs/docs/modules/circular_buffer.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | Generated using TypeDoc
149 |
52 |
64 |
53 |
61 |
63 | Module circular_buffer
62 |
66 |
178 |
192 |
67 |
177 |
68 |
69 |
71 |
92 |
93 |
94 |
96 |
97 |
100 |
101 |
102 |
104 |
105 | Traversal
106 |
107 |
112 |
146 |
147 |
148 |
176 | Index
70 |
72 |
73 |
78 |
79 |
84 |
85 |
90 |
91 | References
74 |-
75 |
- version 76 |
Classes
80 |-
81 |
- circular_
buffer
82 |
Type aliases
86 |-
87 |
- Traversal
Functor
88 |
References
95 |version
98 | Re-exports version 99 |Type aliases
103 |TraversalFunctor
106 |
107 |
112 | Type parameters
113 |-
114 |
-
115 |
T
116 |
117 |
119 |
145 | Type declaration
120 |-
121 |
-
122 |
-
123 |
124 |
-
126 |
-
127 |
Parameters
128 |-
129 |
-
130 |
_element: T
131 |
132 | -
133 |
Optional _index: number
134 |
135 | -
136 |
Optional _array: T[]
137 |
138 |
Returns unknown
140 |
141 | -
130 |
143 | -
127 |
193 |
195 |
196 |
197 |
198 |
--------------------------------------------------------------------------------
/docs/docs/assets/js/search.js:
--------------------------------------------------------------------------------
1 | window.searchData = {"kinds":{"1":"Module","32":"Variable","128":"Class","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","262144":"Accessor","4194304":"Type alias","16777216":"Reference"},"rows":[{"id":0,"kind":1,"name":"circular_buffer","url":"modules/circular_buffer.html","classes":"tsd-kind-module"},{"id":1,"kind":128,"name":"circular_buffer","url":"classes/circular_buffer.circular_buffer-1.html","classes":"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter","parent":"circular_buffer"},{"id":2,"kind":2048,"name":"from","url":"classes/circular_buffer.circular_buffer-1.html#from","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"circular_buffer.circular_buffer"},{"id":3,"kind":512,"name":"constructor","url":"classes/circular_buffer.circular_buffer-1.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter","parent":"circular_buffer.circular_buffer"},{"id":4,"kind":1024,"name":"_values","url":"classes/circular_buffer.circular_buffer-1.html#_values","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"circular_buffer.circular_buffer"},{"id":5,"kind":1024,"name":"_cursor","url":"classes/circular_buffer.circular_buffer-1.html#_cursor","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"circular_buffer.circular_buffer"},{"id":6,"kind":1024,"name":"_offset","url":"classes/circular_buffer.circular_buffer-1.html#_offset","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"circular_buffer.circular_buffer"},{"id":7,"kind":1024,"name":"_length","url":"classes/circular_buffer.circular_buffer-1.html#_length","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"circular_buffer.circular_buffer"},{"id":8,"kind":1024,"name":"_capacity","url":"classes/circular_buffer.circular_buffer-1.html#_capacity","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"circular_buffer.circular_buffer"},{"id":9,"kind":262144,"name":"capacity","url":"classes/circular_buffer.circular_buffer-1.html#capacity","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":10,"kind":262144,"name":"length","url":"classes/circular_buffer.circular_buffer-1.html#length","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":11,"kind":262144,"name":"available","url":"classes/circular_buffer.circular_buffer-1.html#available","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":12,"kind":262144,"name":"isEmpty","url":"classes/circular_buffer.circular_buffer-1.html#isEmpty","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":13,"kind":262144,"name":"isFull","url":"classes/circular_buffer.circular_buffer-1.html#isFull","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":14,"kind":262144,"name":"first","url":"classes/circular_buffer.circular_buffer-1.html#first","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":15,"kind":262144,"name":"last","url":"classes/circular_buffer.circular_buffer-1.html#last","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":16,"kind":2048,"name":"push","url":"classes/circular_buffer.circular_buffer-1.html#push","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":17,"kind":2048,"name":"shove","url":"classes/circular_buffer.circular_buffer-1.html#shove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":18,"kind":2048,"name":"fill","url":"classes/circular_buffer.circular_buffer-1.html#fill","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":19,"kind":2048,"name":"indexOf","url":"classes/circular_buffer.circular_buffer-1.html#indexOf","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":20,"kind":2048,"name":"find","url":"classes/circular_buffer.circular_buffer-1.html#find","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":21,"kind":2048,"name":"every","url":"classes/circular_buffer.circular_buffer-1.html#every","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":22,"kind":2048,"name":"some","url":"classes/circular_buffer.circular_buffer-1.html#some","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":23,"kind":2048,"name":"reverse","url":"classes/circular_buffer.circular_buffer-1.html#reverse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":24,"kind":2048,"name":"clear","url":"classes/circular_buffer.circular_buffer-1.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":25,"kind":2048,"name":"pop","url":"classes/circular_buffer.circular_buffer-1.html#pop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":26,"kind":2048,"name":"at","url":"classes/circular_buffer.circular_buffer-1.html#at","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":27,"kind":2048,"name":"pos","url":"classes/circular_buffer.circular_buffer-1.html#pos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":28,"kind":2048,"name":"offset","url":"classes/circular_buffer.circular_buffer-1.html#offset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":29,"kind":2048,"name":"resize","url":"classes/circular_buffer.circular_buffer-1.html#resize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":30,"kind":2048,"name":"toArray","url":"classes/circular_buffer.circular_buffer-1.html#toArray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"circular_buffer.circular_buffer"},{"id":31,"kind":4194304,"name":"TraversalFunctor","url":"modules/circular_buffer.html#TraversalFunctor","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter","parent":"circular_buffer"},{"id":32,"kind":65536,"name":"__type","url":"modules/circular_buffer.html#TraversalFunctor.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"circular_buffer.TraversalFunctor"},{"id":33,"kind":1,"name":"generated/package_version","url":"modules/generated_package_version.html","classes":"tsd-kind-module"},{"id":34,"kind":32,"name":"version","url":"modules/generated_package_version.html#version","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"generated/package_version"},{"id":35,"kind":32,"name":"packagename","url":"modules/generated_package_version.html#packagename","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"generated/package_version"},{"id":36,"kind":16777216,"name":"version","url":"modules/circular_buffer.html#version","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"circular_buffer"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,19.328]],["parent/0",[]],["name/1",[0,19.328]],["parent/1",[0,1.889]],["name/2",[1,32.321]],["parent/2",[2,0.247]],["name/3",[3,32.321]],["parent/3",[2,0.247]],["name/4",[4,32.321]],["parent/4",[2,0.247]],["name/5",[5,32.321]],["parent/5",[2,0.247]],["name/6",[6,32.321]],["parent/6",[2,0.247]],["name/7",[7,32.321]],["parent/7",[2,0.247]],["name/8",[8,32.321]],["parent/8",[2,0.247]],["name/9",[9,32.321]],["parent/9",[2,0.247]],["name/10",[10,32.321]],["parent/10",[2,0.247]],["name/11",[11,32.321]],["parent/11",[2,0.247]],["name/12",[12,32.321]],["parent/12",[2,0.247]],["name/13",[13,32.321]],["parent/13",[2,0.247]],["name/14",[14,32.321]],["parent/14",[2,0.247]],["name/15",[15,32.321]],["parent/15",[2,0.247]],["name/16",[16,32.321]],["parent/16",[2,0.247]],["name/17",[17,32.321]],["parent/17",[2,0.247]],["name/18",[18,32.321]],["parent/18",[2,0.247]],["name/19",[19,32.321]],["parent/19",[2,0.247]],["name/20",[20,32.321]],["parent/20",[2,0.247]],["name/21",[21,32.321]],["parent/21",[2,0.247]],["name/22",[22,32.321]],["parent/22",[2,0.247]],["name/23",[23,32.321]],["parent/23",[2,0.247]],["name/24",[24,32.321]],["parent/24",[2,0.247]],["name/25",[25,32.321]],["parent/25",[2,0.247]],["name/26",[26,32.321]],["parent/26",[2,0.247]],["name/27",[27,32.321]],["parent/27",[2,0.247]],["name/28",[28,32.321]],["parent/28",[2,0.247]],["name/29",[29,32.321]],["parent/29",[2,0.247]],["name/30",[30,32.321]],["parent/30",[2,0.247]],["name/31",[31,32.321]],["parent/31",[0,1.889]],["name/32",[32,32.321]],["parent/32",[33,3.158]],["name/33",[34,23.848]],["parent/33",[]],["name/34",[35,27.213]],["parent/34",[34,2.33]],["name/35",[36,32.321]],["parent/35",[34,2.33]],["name/36",[35,27.213]],["parent/36",[0,1.889]]],"invertedIndex":[["__type",{"_index":32,"name":{"32":{}},"parent":{}}],["_capacity",{"_index":8,"name":{"8":{}},"parent":{}}],["_cursor",{"_index":5,"name":{"5":{}},"parent":{}}],["_length",{"_index":7,"name":{"7":{}},"parent":{}}],["_offset",{"_index":6,"name":{"6":{}},"parent":{}}],["_values",{"_index":4,"name":{"4":{}},"parent":{}}],["at",{"_index":26,"name":{"26":{}},"parent":{}}],["available",{"_index":11,"name":{"11":{}},"parent":{}}],["capacity",{"_index":9,"name":{"9":{}},"parent":{}}],["circular_buffer",{"_index":0,"name":{"0":{},"1":{}},"parent":{"1":{},"31":{},"36":{}}}],["circular_buffer.circular_buffer",{"_index":2,"name":{},"parent":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{}}}],["circular_buffer.traversalfunctor",{"_index":33,"name":{},"parent":{"32":{}}}],["clear",{"_index":24,"name":{"24":{}},"parent":{}}],["constructor",{"_index":3,"name":{"3":{}},"parent":{}}],["every",{"_index":21,"name":{"21":{}},"parent":{}}],["fill",{"_index":18,"name":{"18":{}},"parent":{}}],["find",{"_index":20,"name":{"20":{}},"parent":{}}],["first",{"_index":14,"name":{"14":{}},"parent":{}}],["from",{"_index":1,"name":{"2":{}},"parent":{}}],["generated/package_version",{"_index":34,"name":{"33":{}},"parent":{"34":{},"35":{}}}],["indexof",{"_index":19,"name":{"19":{}},"parent":{}}],["isempty",{"_index":12,"name":{"12":{}},"parent":{}}],["isfull",{"_index":13,"name":{"13":{}},"parent":{}}],["last",{"_index":15,"name":{"15":{}},"parent":{}}],["length",{"_index":10,"name":{"10":{}},"parent":{}}],["offset",{"_index":28,"name":{"28":{}},"parent":{}}],["packagename",{"_index":36,"name":{"35":{}},"parent":{}}],["pop",{"_index":25,"name":{"25":{}},"parent":{}}],["pos",{"_index":27,"name":{"27":{}},"parent":{}}],["push",{"_index":16,"name":{"16":{}},"parent":{}}],["resize",{"_index":29,"name":{"29":{}},"parent":{}}],["reverse",{"_index":23,"name":{"23":{}},"parent":{}}],["shove",{"_index":17,"name":{"17":{}},"parent":{}}],["some",{"_index":22,"name":{"22":{}},"parent":{}}],["toarray",{"_index":30,"name":{"30":{}},"parent":{}}],["traversalfunctor",{"_index":31,"name":{"31":{}},"parent":{}}],["version",{"_index":35,"name":{"34":{},"36":{}},"parent":{}}]],"pipeline":[]}}
--------------------------------------------------------------------------------
/src/ts/tests/circular_buffer.spec.ts:
--------------------------------------------------------------------------------
1 |
2 | import { version, circular_buffer, TraversalFunctor } from '../circular_buffer';
3 |
4 |
5 |
6 |
7 |
8 | describe('[UNIT] version', () => {
9 | test('Version is present', () => expect(typeof version).toBe('string'));
10 | test('Version is non-empty', () => expect(version.length > 0).toBe(true));
11 | });
12 |
13 |
14 |
15 |
16 |
17 | describe('[UNIT] Zero size', () => {
18 |
19 | const cb = new circular_buffer(0);
20 |
21 | expect( cb.length ).toBe(0);
22 | expect( cb.available ).toBe(0);
23 | expect( cb.capacity ).toBe(0);
24 |
25 | expect( () => cb.first ).toThrow();
26 | expect( () => cb.last ).toThrow();
27 |
28 | expect( () => cb.push(1) ).toThrow();
29 | expect( () => cb.pop() ).toThrow();
30 |
31 | });
32 |
33 |
34 |
35 |
36 |
37 | describe('[UNIT] capacity setter', () => {
38 |
39 | // start with an empty 3-cap
40 |
41 | const cb = new circular_buffer(3);
42 |
43 | expect( cb.length ).toBe(0);
44 | expect( cb.available ).toBe(3);
45 | expect( cb.capacity ).toBe(3);
46 |
47 | // up cap to 5; still empty
48 |
49 | cb.capacity = 5;
50 |
51 | expect( cb.length ).toBe(0);
52 | expect( cb.available ).toBe(5);
53 | expect( cb.capacity ).toBe(5);
54 |
55 | // fill it
56 |
57 | cb.push(1);
58 | cb.push(2);
59 | cb.push(3);
60 | cb.push(4);
61 | cb.push(5);
62 |
63 | expect( cb.toArray() ).toEqual( [1,2,3,4,5] );
64 |
65 | // truncate by two; assert common sense
66 |
67 | cb.capacity = 3;
68 |
69 | expect( cb.toArray() ).toEqual( [1,2,3] );
70 |
71 | expect( cb.length ).toBe(3);
72 | expect( cb.available ).toBe(0);
73 | expect( cb.capacity ).toBe(3);
74 |
75 | });
76 |
77 |
78 |
79 |
80 |
81 | describe('[UNIT] length setter', () => {
82 |
83 | // start with an empty 3-cap
84 |
85 | const cb = new circular_buffer(3);
86 |
87 | expect( cb.length ).toBe(0);
88 | expect( cb.available ).toBe(3);
89 | expect( cb.capacity ).toBe(3);
90 |
91 | // up cap to 5; still empty
92 |
93 | cb.capacity = 5;
94 |
95 | expect( cb.length ).toBe(0);
96 | expect( cb.available ).toBe(5);
97 | expect( cb.capacity ).toBe(5);
98 |
99 | // fill it
100 |
101 | cb.push(1);
102 | cb.push(2);
103 | cb.push(3);
104 | cb.push(4);
105 | cb.push(5);
106 |
107 | expect( cb.toArray() ).toEqual( [1,2,3,4,5] );
108 |
109 | // truncate by two using length; assert common sense
110 |
111 | cb.length = 3;
112 |
113 | expect( cb.toArray() ).toEqual( [1,2,3] );
114 |
115 | expect( cb.length ).toBe(3);
116 | expect( cb.available ).toBe(2);
117 | expect( cb.capacity ).toBe(5);
118 |
119 | // test that the no-op catch for resize under capacity is reached
120 | cb.length = 4;
121 | expect( cb.toArray() ).toEqual( [1,2,3] );
122 |
123 | // cannot re-length to over capacity
124 | expect( () => cb.length = 6 ).toThrow();
125 |
126 | // cannot re-length to negative
127 | expect( () => cb.length = -1 ).toThrow();
128 |
129 | // cannot re-length to fraction
130 | expect( () => cb.length = 2.5 ).toThrow();
131 |
132 | });
133 |
134 |
135 |
136 |
137 |
138 | describe('[UNIT] Circular buffer', () => {
139 |
140 | const unit = (size: number) => {
141 |
142 | describe(`at capacity ${size.toLocaleString()}`, () => {
143 |
144 | test('constructor', () => {
145 | expect(() => new circular_buffer(size)).not.toThrow();
146 | });
147 |
148 | test('lifecycle', () => {
149 |
150 | const cb = new circular_buffer(size);
151 |
152 | expect(cb.capacity).toBe(size);
153 | expect(cb.length).toBe(0);
154 | expect(cb.available).toBe(size);
155 | expect(() => cb.first).toThrow();
156 | expect(() => cb.last).toThrow();
157 |
158 | expect(cb.push(1)).toBe(1);
159 | expect(cb.capacity).toBe(size);
160 | expect(cb.length).toBe(1);
161 | expect(cb.available).toBe(size-1);
162 | expect(cb.first).toBe(1);
163 | expect(cb.last).toBe(1);
164 |
165 | expect(cb.pop()).toBe(1);
166 | expect(cb.capacity).toBe(size);
167 | expect(cb.length).toBe(0);
168 | expect(cb.available).toBe(size);
169 | expect(() => cb.first).toThrow();
170 | expect(() => cb.last).toThrow();
171 |
172 | });
173 |
174 | test(`* push fill ${size.toLocaleString()}`, () => {
175 |
176 | const pf = new circular_buffer(size);
177 | for (let i=0; iGenerated using TypeDoc
194 |
52 |
56 |
53 |
55 | circular_buffer_js
54 |
58 |
248 |
262 |
59 |
247 |
60 |
227 |
246 |
61 |
62 |
140 | 141 |
170 | 171 |
178 | 179 |
186 | 187 |
226 | circular_buffer_js
63 | 64 |
65 | 
66 | 
67 | 
68 | 
npm install --save-dev circular_buffer_js
70 | -
72 |
- Documentation
-
73 |
- Main functional documentation 74 |
76 | - Build history 77 |
Typescript implementation of a circular buffer, and JS compiles to a es6
79 | module minified, es6 commonjs minified, es6 iife minified, and es6 iife full.
-
81 |
- Well tested.
-
82 |
- 100% coverage, 100% property coverage. 83 |
85 | - Tiny.
-
86 |
- The
es6minified module build is currently 1.4k.
87 |
89 | - The
- Dependency-free.
-
90 |
- Only dev-time deps like
typescriptare involved.
91 |
93 | - Only dev-time deps like
API
97 | 98 |You should consider viewing the 99 | real documentation, 100 | but:
101 |// yields a buffer of fixed size `size`
102 | const cb = new circular_buffer(size),
103 | cb2 = circular_buffer.from([1,2,3]);
104 |
105 | cb.push(item); // inserts `item` at end of `cb`, then returns `item`
106 | cb.shove(item); // inserts `item` at end of `cb`; remove if needed, returns removed
107 | cb.pop(); // removes and returns first element
108 | cb.at(location); // shows the element at 0-indexed offset `location`
109 | cb.pos(location); // shows the element at run-indexed offset `location`
110 | cb.offset(); // shows the delta from 0-indexed to head
111 | cb.indexOf(item); // returns the index of the first `item`, or -1
112 | cb.find(pred); // return the the first match or undefined
113 | cb.every(pred); // tests if every queue element satisfies the predicate
114 | cb.some(pred); // tests if at least one element satisfies the predicate
115 | cb.fill(item); // maxes `length` and sets every element to `item`
116 | cb.clear(); // empties the container
117 | cb.reverse(); // reverses the container
118 | cb.resize(size,pE); // change to new size, truncating if required; pE to prefer end
119 | cb.toArray(); // return an array of the current contents of the queue
120 |
121 | cb.first; // returns the first value in the queue; throws when empty
122 | cb.last; // returns the last value in the queue; throws when empty
123 | cb.isFull; // returns `true` if no space left; `false` otherwise
124 | cb.isEmpty; // returns `true` if no space remains; `false` otherwise
125 | cb.available; // returns the number of spaces remaining currently
126 | cb.capacity; // returns the total `size` allocated
127 | cb.length; // returns the amount of space currently used
128 | What is this?
132 | 133 |This is a circular buffer (or cycle buffer, ring queue, etc.) It was written 134 | because a library I wanted to use had a native buggy implementation, so I 135 | provided something more trustworthy.
136 |A circular buffer is a fixed size buffer that allows you to push and pop 137 | forever, as a first in first out queue-like structure. Circular buffers are 138 | more efficient than queues, but can overflow.
139 |140 | 141 |
Basic usage
142 | 143 |import { circular_buffer } from 'circular_buffer_js';
144 |
145 | const cb = new circular_buffer(3); // [ , , ]
146 |
147 | cb.push(1); // ok: [1, , ]
148 | cb.push(2); // ok: [1,2, ]
149 | cb.push(3); // ok: [1,2,3]
150 |
151 | cb.at(0); // 1
152 | cb.first; // 1
153 | cb.last; // 3
154 |
155 | cb.push(4); // throws - full! ; [1,2,3]
156 |
157 | cb.pop(); // 1: [2,3, ]
158 | cb.at(0); // 2: [2,3, ]
159 |
160 | cb.push(4); // ok: [2,3,4]
161 | cb.push(5); // throws - full! ; [2,3,4]
162 |
163 | cb.pop(); // 2: [3,4, ]
164 | cb.pop(); // 3: [4, , ]
165 | cb.pop(); // 4: [ , , ]
166 |
167 | cb.pop(); // throws - empty! ; [ , , ]
168 | 170 | 171 |
Typescript
172 | 173 |It's typescript, so you can also
174 |import { circular_buffer } from 'circular_buffer_js';
175 | const cb = new circular_buffer<number>(3);
176 | 178 | 179 |
Node CommonJS
180 | 181 |And there's a CommonJS build, so you can
182 |const cbuf = require('circular_buffer_js'),
183 | circular_buffer = new cbuf.circular_buffer;
184 | 186 | 187 |
Browser <script>
188 | 189 |There're also two iife builds - both regular and minified - so that you can
190 | use this in older browsers, or from CDN.
<script defer type="text/javascript" src="circular_buffer_js.min.js"></script>
192 | <script defer type="text/javascript">
193 |
194 | window.onload = () => {
195 |
196 | console.log(
197 | `Using circular buffer version ${circular_buffer.version}`
198 | );
199 |
200 | // package // class
201 | const mybuf = new circular_buffer.circular_buffer(5);
202 |
203 | };
204 |
205 | </script>
206 | Alternatives
210 | 211 |If this doesn't meet your needs, please try:
212 |-
213 |
- ring-buffer-ts 214 |
- CBuffer 215 |
- ringbuffer.js 216 |
- qlist 217 |
- fixed-size-list 218 |
- circular-buffer 219 |
- cyclist 220 |
- cyclic-buffer 221 |
- bsh-circular-buffer 222 |
- cbarrick-circular-buffer 223 |
- limited-cache 224 |
263 |
265 |
266 |
267 |
268 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | ### Changelog
2 |
3 | All notable changes to this project will be documented in this file. Dates are displayed in UTC.
4 |
5 | #### [Unreleased](https://github.com/StoneCypher/circular_buffer_js/compare/v1.8.2...HEAD)
6 |
7 | - 1.9.0 implement shove/1, fixes #55 [`#55`](https://github.com/StoneCypher/circular_buffer_js/issues/55)
8 | - Add release process. Re-achieve 100% double-coverage [`bb822c2`](https://github.com/StoneCypher/circular_buffer_js/commit/bb822c298fed01c8284188c65dfaa479c5dc96b9)
9 | - Minor improvements to the release process [`c789600`](https://github.com/StoneCypher/circular_buffer_js/commit/c789600d2edd17dbc400e5b3d4a4b3f9f93c2ba2)
10 |
11 | #### [v1.8.2](https://github.com/StoneCypher/circular_buffer_js/compare/v1.8.1...v1.8.2)
12 |
13 | > 26 February 2022
14 |
15 | #### [v1.8.1](https://github.com/StoneCypher/circular_buffer_js/compare/v1.8.0...v1.8.1)
16 |
17 | > 26 February 2022
18 |
19 | #### [v1.8.0](https://github.com/StoneCypher/circular_buffer_js/compare/v1.7.1...v1.8.0)
20 |
21 | > 26 February 2022
22 |
23 | - Add offset and pos [`#54`](https://github.com/StoneCypher/circular_buffer_js/pull/54)
24 | - stoch test in for .offset, fixes #52 .offset implemented, fixes #53 .offset tested [`#52`](https://github.com/StoneCypher/circular_buffer_js/issues/52) [`#53`](https://github.com/StoneCypher/circular_buffer_js/issues/53)
25 | - stoch test in for .pos, fixes #50 .pos implemented, fixes #51 .pos tested [`#50`](https://github.com/StoneCypher/circular_buffer_js/issues/50) [`#51`](https://github.com/StoneCypher/circular_buffer_js/issues/51)
26 | - Add tests for set .capacity, fixes #49 [`#49`](https://github.com/StoneCypher/circular_buffer_js/issues/49)
27 | - draft implementations [`0dd5d0f`](https://github.com/StoneCypher/circular_buffer_js/commit/0dd5d0f1c73b7752f22367f62e771978625e79c3)
28 | - unit tests [`3d2637f`](https://github.com/StoneCypher/circular_buffer_js/commit/3d2637f7548883daccb26328c698d3bace86306e)
29 | - SetLength test was wrong: it asserted that length matched what was set, which isn't true when setting a higher size [`60c7819`](https://github.com/StoneCypher/circular_buffer_js/commit/60c781994047822fb263c05764f7d7aa19791bbb)
30 | - SetLength is either a broken test or has found a bug [`172d926`](https://github.com/StoneCypher/circular_buffer_js/commit/172d926e6888bf02b3818971f5441e8667cef6f1)
31 |
32 | #### [v1.7.1](https://github.com/StoneCypher/circular_buffer_js/compare/v1.7.0...v1.7.1)
33 |
34 | > 29 July 2021
35 |
36 | - improve docblock [`37706f8`](https://github.com/StoneCypher/circular_buffer_js/commit/37706f8c53f9027d2024446f0aa8ba971a816e13)
37 |
38 | #### [v1.7.0](https://github.com/StoneCypher/circular_buffer_js/compare/v1.6.0...v1.7.0)
39 |
40 | > 26 July 2021
41 |
42 | - resize/1, fixes #3 [`#3`](https://github.com/StoneCypher/circular_buffer_js/issues/3)
43 |
44 | #### [v1.6.0](https://github.com/StoneCypher/circular_buffer_js/compare/v1.5.2...v1.6.0)
45 |
46 | > 26 July 2021
47 |
48 | - indexOf/1-2 [`d27166b`](https://github.com/StoneCypher/circular_buffer_js/commit/d27166b38f9a50d21f261057b0b1e8b789300d9a)
49 |
50 | #### [v1.5.2](https://github.com/StoneCypher/circular_buffer_js/compare/v1.5.1...v1.5.2)
51 |
52 | > 26 July 2021
53 |
54 | - better find test [`facf650`](https://github.com/StoneCypher/circular_buffer_js/commit/facf650b288660be70a441ab6c1debf529ad857b)
55 |
56 | #### [v1.5.1](https://github.com/StoneCypher/circular_buffer_js/compare/v1.5.0...v1.5.1)
57 |
58 | > 26 July 2021
59 |
60 | - readme mistake about find [`5acae2b`](https://github.com/StoneCypher/circular_buffer_js/commit/5acae2ba2f19060e58a5ad8802a7cd663a4d572b)
61 |
62 | #### [v1.5.0](https://github.com/StoneCypher/circular_buffer_js/compare/v1.3.0...v1.5.0)
63 |
64 | > 26 July 2021
65 |
66 | - find/1-2, fixes #15 [`#15`](https://github.com/StoneCypher/circular_buffer_js/issues/15)
67 | - some/1, fixes #46 [`#46`](https://github.com/StoneCypher/circular_buffer_js/issues/46)
68 | - Close a fairly gross line-left-behind bug causing unexpected reversals [`c18c0e2`](https://github.com/StoneCypher/circular_buffer_js/commit/c18c0e2c2513b793db29f41b515a79072abd8bee)
69 |
70 | #### [v1.3.0](https://github.com/StoneCypher/circular_buffer_js/compare/v1.2.0...v1.3.0)
71 |
72 | > 25 July 2021
73 |
74 | - every/1-2, fixes #45 [`#45`](https://github.com/StoneCypher/circular_buffer_js/issues/45)
75 |
76 | #### [v1.2.0](https://github.com/StoneCypher/circular_buffer_js/compare/v1.1.0...v1.2.0)
77 |
78 | > 25 July 2021
79 |
80 | - reverse/0 [`765c58b`](https://github.com/StoneCypher/circular_buffer_js/commit/765c58b809df6aa481de8601f3b3df492d6e7263)
81 |
82 | #### [v1.1.0](https://github.com/StoneCypher/circular_buffer_js/compare/v1.0.1...v1.1.0)
83 |
84 | > 25 July 2021
85 |
86 | - from/1-3, fixes #9 [`#9`](https://github.com/StoneCypher/circular_buffer_js/issues/9)
87 |
88 | #### [v1.0.1](https://github.com/StoneCypher/circular_buffer_js/compare/v1.0.0...v1.0.1)
89 |
90 | > 19 July 2021
91 |
92 | - Fix badges [`7e19481`](https://github.com/StoneCypher/circular_buffer_js/commit/7e19481a6671949a2ee8a1d768e2e02b5eb6cd37)
93 |
94 | ### [v1.0.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.25.0...v1.0.0)
95 |
96 | > 19 July 2021
97 |
98 | - Declare 1.0.0 [`4c2c630`](https://github.com/StoneCypher/circular_buffer_js/commit/4c2c6305b291afc3b2c9940b665e7a974a7baadd)
99 |
100 | #### [v0.25.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.24.1...v0.25.0)
101 |
102 | > 19 July 2021
103 |
104 | - tagging done [`40ab035`](https://github.com/StoneCypher/circular_buffer_js/commit/40ab0358768a4a9fa48129f55f7f9c220ae3ddc3)
105 | - prep for 1.0.0 underway, gonna go tag a lot of things [`c5aee62`](https://github.com/StoneCypher/circular_buffer_js/commit/c5aee629ddf93ba2bba4b03fffdfc1c2b80eee11)
106 |
107 | #### [v0.24.1](https://github.com/StoneCypher/circular_buffer_js/compare/v0.24.0...v0.24.1)
108 |
109 | > 19 July 2021
110 |
111 | - we do need a few steenking badges [`6f3cbe0`](https://github.com/StoneCypher/circular_buffer_js/commit/6f3cbe023bd75c20bdb5bff0a19b1af356c66c0a)
112 |
113 | #### [v0.24.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.23.1...v0.24.0)
114 |
115 | > 19 July 2021
116 |
117 | - Create landing page, fixes #32 [`#32`](https://github.com/StoneCypher/circular_buffer_js/issues/32)
118 |
119 | #### [v0.23.1](https://github.com/StoneCypher/circular_buffer_js/compare/v0.23.0...v0.23.1)
120 |
121 | > 19 July 2021
122 |
123 | - lcov path [`ea41e13`](https://github.com/StoneCypher/circular_buffer_js/commit/ea41e13714df743274c3ef1a961a65ec512c3c1d)
124 |
125 | #### [v0.23.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.22.0...v0.23.0)
126 |
127 | > 19 July 2021
128 |
129 | - eslint [`#44`](https://github.com/StoneCypher/circular_buffer_js/pull/44)
130 | - Setting up coveralls [`20d395a`](https://github.com/StoneCypher/circular_buffer_js/commit/20d395a0390afc15873ac15a731055c58397a4e3)
131 | - Setting up coveralls with correct package number [`52de726`](https://github.com/StoneCypher/circular_buffer_js/commit/52de7264afe5a760ec89e8e85812294854a0b349)
132 |
133 | #### [v0.22.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.21.3...v0.22.0)
134 |
135 | > 19 July 2021
136 |
137 | - Write the changelog to disk [`#43`](https://github.com/StoneCypher/circular_buffer_js/pull/43)
138 | - Add changelog [`#42`](https://github.com/StoneCypher/circular_buffer_js/pull/42)
139 | - eslint [`1caa887`](https://github.com/StoneCypher/circular_buffer_js/commit/1caa88768b99bddf4615e19aad129fdeae334fc4)
140 |
141 | #### [v0.21.3](https://github.com/StoneCypher/circular_buffer_js/compare/v0.21.2...v0.21.3)
142 |
143 | > 19 July 2021
144 |
145 | - Write the changelog to disk [`2d035c2`](https://github.com/StoneCypher/circular_buffer_js/commit/2d035c24cfc9db52656c9294be86ca9645e043fa)
146 | - Okay changelogs are semi-automated now [`1e54733`](https://github.com/StoneCypher/circular_buffer_js/commit/1e547331e509d22d184225418d107bf5425805cf)
147 | - Okay, NPM standard doesn't work here [`1ad912b`](https://github.com/StoneCypher/circular_buffer_js/commit/1ad912b2bc7c5d6c674a85e4b2cb5dd761bf9251)
148 |
149 | #### [v0.21.2](https://github.com/StoneCypher/circular_buffer_js/compare/v0.21.1...v0.21.2)
150 |
151 | > 19 July 2021
152 |
153 | - Automating the build system [`52eb471`](https://github.com/StoneCypher/circular_buffer_js/commit/52eb4712e7c01ea5e0be9c4c1e78c74b2c2d8066)
154 | - Automating the bump system [`2923f64`](https://github.com/StoneCypher/circular_buffer_js/commit/2923f64969fcbdfec1add6970e2c06888bdec57b)
155 |
156 | #### [v0.21.1](https://github.com/StoneCypher/circular_buffer_js/compare/v0.20.1...v0.21.1)
157 |
158 | > 19 July 2021
159 |
160 | - Setting up a changelog tagging toolchain [`456e34f`](https://github.com/StoneCypher/circular_buffer_js/commit/456e34fca7bfa876009c497a917530221b1ad322)
161 |
162 | #### [v0.20.1](https://github.com/StoneCypher/circular_buffer_js/compare/v0.19.0...v0.20.1)
163 |
164 | > 19 July 2021
165 |
166 | - clear/0 now returns toArray/0, fixes #39 [`#39`](https://github.com/StoneCypher/circular_buffer_js/issues/39)
167 | - toArray/0, simpler .pop/0, fixes #8 [`#8`](https://github.com/StoneCypher/circular_buffer_js/issues/8)
168 |
169 | #### [v0.19.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.18.1...v0.19.0)
170 |
171 | > 19 July 2021
172 |
173 | - There, wrote some basic documentation, fixes #41 [`#41`](https://github.com/StoneCypher/circular_buffer_js/issues/41)
174 |
175 | #### [v0.18.1](https://github.com/StoneCypher/circular_buffer_js/compare/v0.18.0...v0.18.1)
176 |
177 | > 19 July 2021
178 |
179 | - we're putting the docs in the repo now [`85bf3f4`](https://github.com/StoneCypher/circular_buffer_js/commit/85bf3f4ba1176f13a17e3eddaec2b4c011b35d8e)
180 | - rebuild for putting the docs in the repo [`a35ae5b`](https://github.com/StoneCypher/circular_buffer_js/commit/a35ae5bd38bfa2353e1622cda56209dc0c93b999)
181 |
182 | #### [v0.18.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.17.0...v0.18.0)
183 |
184 | > 19 July 2021
185 |
186 | - implements .first and .last, fixes #40 [`#40`](https://github.com/StoneCypher/circular_buffer_js/issues/40)
187 | - narrow the example code so comments fit on npm [`f0f2eb8`](https://github.com/StoneCypher/circular_buffer_js/commit/f0f2eb8c9f30b78ca749b9ce68dd6f4057ec85cd)
188 | - change the api in the readme [`810babe`](https://github.com/StoneCypher/circular_buffer_js/commit/810babe1cf56c8b191ca38023d97def98120ea70)
189 | - and the api [`83e8edb`](https://github.com/StoneCypher/circular_buffer_js/commit/83e8edbad820a1ab5ee45b65fc6c9f9dcaa979f8)
190 |
191 | #### [v0.17.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.16.0...v0.17.0)
192 |
193 | > 19 July 2021
194 |
195 | - .npmignore to reduce the package, improve test labels [`464bf40`](https://github.com/StoneCypher/circular_buffer_js/commit/464bf40b814b8f42e8f6247a22602b6561090688)
196 | - changes methods to getters, camelcases booleans to disambiguate [`c44cdb4`](https://github.com/StoneCypher/circular_buffer_js/commit/c44cdb4ee23830b4c606e7345631b2963e127bdb)
197 |
198 | #### [v0.16.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.15.15...v0.16.0)
199 |
200 | > 19 July 2021
201 |
202 | - implements clear/0 [`#38`](https://github.com/StoneCypher/circular_buffer_js/pull/38)
203 | - readme improvements [`a6b608d`](https://github.com/StoneCypher/circular_buffer_js/commit/a6b608d0dc9272c31cfb3548730e52723f804dec)
204 |
205 | #### [v0.15.15](https://github.com/StoneCypher/circular_buffer_js/compare/v0.15.11...v0.15.15)
206 |
207 | > 19 July 2021
208 |
209 | - sets ref to docs in readme, fixes #33; .nojekyll fixes #34; small readme tips; adds fill/1 to api list in readme [`#33`](https://github.com/StoneCypher/circular_buffer_js/issues/33) [`#34`](https://github.com/StoneCypher/circular_buffer_js/issues/34)
210 | - better github action only calls macs once, improves node range [`d428fbd`](https://github.com/StoneCypher/circular_buffer_js/commit/d428fbd2a6da533a1637424a2ca42e153bbe6875)
211 | - more .nojekyll in more directories because le sigh [`5a573e4`](https://github.com/StoneCypher/circular_buffer_js/commit/5a573e4dc2cc43aa33792517b5251f32fbb0bd22)
212 |
213 | #### [v0.15.11](https://github.com/StoneCypher/circular_buffer_js/compare/v0.15.8...v0.15.11)
214 |
215 | > 19 July 2021
216 |
217 | - Should close both issues - module path in package was missing dist, didn't copy subordinate .d.ts - fixes #31 [`#31`](https://github.com/StoneCypher/circular_buffer_js/issues/31)
218 | - Indicate types in package.json, fixes #30; fill stoch coverage defect in fill/1 [`#30`](https://github.com/StoneCypher/circular_buffer_js/issues/30)
219 | - lawdy. @drohen catching me screwing the pooch left and right. really need to automate the ci build to npm [`b9f6d25`](https://github.com/StoneCypher/circular_buffer_js/commit/b9f6d25747b06a4eba3816fabcd4e8a2a3ac9e45)
220 | - bump and rebuild [`38f1661`](https://github.com/StoneCypher/circular_buffer_js/commit/38f1661249e37b87e49f9e5aae5d7aa14666c60d)
221 | - merge error in readme apparently [`fbb1a4f`](https://github.com/StoneCypher/circular_buffer_js/commit/fbb1a4ffe759a3043f70953ce8ac66baec6bead7)
222 |
223 | #### [v0.15.8](https://github.com/StoneCypher/circular_buffer_js/compare/v0.15.0...v0.15.8)
224 |
225 | > 19 July 2021
226 |
227 | - Fill [`#26`](https://github.com/StoneCypher/circular_buffer_js/pull/26)
228 | - build wasn't up to date (gross) fixes #28 [`#28`](https://github.com/StoneCypher/circular_buffer_js/issues/28)
229 | - fixes #17 [`#17`](https://github.com/StoneCypher/circular_buffer_js/issues/17)
230 | - fixes #17 - Adjusted comments, fixed off-by-one error, 'any' to 'T' patch [`#17`](https://github.com/StoneCypher/circular_buffer_js/issues/17)
231 | - fixes #17 [`#17`](https://github.com/StoneCypher/circular_buffer_js/issues/17)
232 | - merging with master [`f6e988f`](https://github.com/StoneCypher/circular_buffer_js/commit/f6e988fda337953b95e967ca44a3523f54f33f27)
233 | - test for fill/partial/3 [`bbf9dd6`](https://github.com/StoneCypher/circular_buffer_js/commit/bbf9dd6409b258002d826246cfa98a09063cac99)
234 | - testing fill [`d4711ec`](https://github.com/StoneCypher/circular_buffer_js/commit/d4711ec69b1e60e5628879ff4f2ead495b90fd6a)
235 | - catching up -nothing to see here [`87eccd6`](https://github.com/StoneCypher/circular_buffer_js/commit/87eccd65ea1b5475785b47afe3371bfe6c71017c)
236 | - try, try again [`e184841`](https://github.com/StoneCypher/circular_buffer_js/commit/e1848414e607fde139548b48e21f96b6e133fa52)
237 | - ... [`b1ad533`](https://github.com/StoneCypher/circular_buffer_js/commit/b1ad533afd865fce40ff9e66995be097edddd801)
238 | - fix that ts-jest was a dep instead of a devdep; readme; disable failing docs path [`53afc6a`](https://github.com/StoneCypher/circular_buffer_js/commit/53afc6ac8f27b8185b783d9fdf0cd0af499c89ad)
239 | - better readme [`769dfbe`](https://github.com/StoneCypher/circular_buffer_js/commit/769dfbe2b421cf7f4e6b94edb931295eb5eb16f1)
240 | - Let's try auto-docs again [`9c40f37`](https://github.com/StoneCypher/circular_buffer_js/commit/9c40f376941fac6c7ecdd34053f0df57fde3372c)
241 | - dix for length and fill/full test [`b4386ae`](https://github.com/StoneCypher/circular_buffer_js/commit/b4386aecb2a32465bed432ca3872c600a17fbea0)
242 | - Let's take another stab at auto-docs [`feca402`](https://github.com/StoneCypher/circular_buffer_js/commit/feca4020cd3ff2d841e76acd5042e095467a17fa)
243 | - local [`dd2b989`](https://github.com/StoneCypher/circular_buffer_js/commit/dd2b98940237a220a5ca05d7bb9252b17acf15fc)
244 | - Update README.md [`3dac9ec`](https://github.com/StoneCypher/circular_buffer_js/commit/3dac9ecdace9de079efb3cb226d4ae02fdda0bf2)
245 | - putting fill where it belongs? [`3b4051e`](https://github.com/StoneCypher/circular_buffer_js/commit/3b4051e77ff12e26dc509090aaf5b86b294db941)
246 | - Update README.md [`562eb0b`](https://github.com/StoneCypher/circular_buffer_js/commit/562eb0b74a9f7d6b793bb7b8d35de30bb8116fd4)
247 | - initial setup [`09f426b`](https://github.com/StoneCypher/circular_buffer_js/commit/09f426b6a10df0cb11407dc453dc67614826a4f0)
248 | - converted toStrictEqual to toEqual [`1539e27`](https://github.com/StoneCypher/circular_buffer_js/commit/1539e27ef75c55b220dacaf33808033d280e3651)
249 | - regen [`ec02720`](https://github.com/StoneCypher/circular_buffer_js/commit/ec02720be251cc8ace2ac0671f372d62c50004da)
250 | - second attempt withut the golfing [`92d087e`](https://github.com/StoneCypher/circular_buffer_js/commit/92d087ea971822ea0c5fd89a7bc2eb58412a2f10)
251 | - sync with main [`e693d7f`](https://github.com/StoneCypher/circular_buffer_js/commit/e693d7f38758b432823a0679fb276fd747a7b648)
252 | - resolving conflicts [`d0b995f`](https://github.com/StoneCypher/circular_buffer_js/commit/d0b995f859bdc377e1d8fe24e3182612e2fcdb73)
253 | - autodoc yaml fixes? [`9b83b01`](https://github.com/StoneCypher/circular_buffer_js/commit/9b83b01d4354504df65fa5946658b58f041911f1)
254 | - added rangeError [`a4d8448`](https://github.com/StoneCypher/circular_buffer_js/commit/a4d8448a42009ef7c2dc64b308c9aee4401377eb)
255 | - conflicting files [`2b71ab5`](https://github.com/StoneCypher/circular_buffer_js/commit/2b71ab52ed94623838986d52212ee765d464a6ab)
256 | - spacing [`851e491`](https://github.com/StoneCypher/circular_buffer_js/commit/851e491a386f9167234ea80e1ab5dda81010559e)
257 | - actually since we know it's ubuntu, we can do it directly there [`6f6a361`](https://github.com/StoneCypher/circular_buffer_js/commit/6f6a3615ec8533b52225cf13c3f4dd1ffef89334)
258 | - add needs clause to enforce seriality; fix script location in yaml [`09e1ca7`](https://github.com/StoneCypher/circular_buffer_js/commit/09e1ca7fe0fb40c0b90374a0f1c776e90bc745b6)
259 | - resolving the other two conflicting branches [`b804a28`](https://github.com/StoneCypher/circular_buffer_js/commit/b804a28d2c677106d5fca51aa4cdb445cd7ccaaa)
260 | - Let's try auto-docs ... AGAIN. Trying to cope with rimraf install now [`f91de5d`](https://github.com/StoneCypher/circular_buffer_js/commit/f91de5d6196df00afdf6f5da634225c7e4987cf2)
261 | - spacing [`7e140a9`](https://github.com/StoneCypher/circular_buffer_js/commit/7e140a9f2ecfdce0a302beed4df46b9f3716edad)
262 | - stray rimraf ref [`b3e2720`](https://github.com/StoneCypher/circular_buffer_js/commit/b3e2720e6e60f17855fa10035d2e94173fa79ad4)
263 | - adding a cache of package, installed rimraf in pages thread [`e5e832d`](https://github.com/StoneCypher/circular_buffer_js/commit/e5e832d7790dd9526892c71dde052cd4bd677b33)
264 | - fill function attempt 1 [`4f345ac`](https://github.com/StoneCypher/circular_buffer_js/commit/4f345ac56bd59ebf72a3d4dddb8e098cdce9a30a)
265 | - trigger build without causing a fault [`8c7bc7b`](https://github.com/StoneCypher/circular_buffer_js/commit/8c7bc7bc139681a0effd8841d0c62e60ea66bdc1)
266 | - trigger build [`67b789f`](https://github.com/StoneCypher/circular_buffer_js/commit/67b789f7173d71f948a446ecca9129a96fb298c4)
267 | - Update README.md [`c3c1974`](https://github.com/StoneCypher/circular_buffer_js/commit/c3c1974d3f2a79c8c4c5718106a0045a0ac29259)
268 | - fix for stray blank line [`d427252`](https://github.com/StoneCypher/circular_buffer_js/commit/d427252ba3bc75cc3524bc2c397e9e8a9c1084e9)
269 | - Update README.md [`1e4c0bc`](https://github.com/StoneCypher/circular_buffer_js/commit/1e4c0bc892984be60f2148f0cee0b5c5fa934141)
270 |
271 | #### [v0.15.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.13.2...v0.15.0)
272 |
273 | > 19 July 2021
274 |
275 | - main and module fields. re-add dist. disable underway doc stuff [`2c15cd3`](https://github.com/StoneCypher/circular_buffer_js/commit/2c15cd3e883bae1f14873ab7cfebe012cef0ef7e)
276 | - move archival script to appropriate branch; place warning dummies [`e9da39b`](https://github.com/StoneCypher/circular_buffer_js/commit/e9da39b37c0264bfd9e3baf8dee0406505c6d93b)
277 | - Attempting automatic doc archival [`3ed2e08`](https://github.com/StoneCypher/circular_buffer_js/commit/3ed2e085c33188fb6c8cce397645a359a44dba05)
278 | - maybe that error is actually about the following line [`0561b59`](https://github.com/StoneCypher/circular_buffer_js/commit/0561b59fd749efd86ecaa93f45eb01a6145ef086)
279 | - trying a slightly more detailed approach [`c0e1aed`](https://github.com/StoneCypher/circular_buffer_js/commit/c0e1aedaebc7e803f5604dfb934644804366e12b)
280 | - right, that package doesn't exist anymore, do it directly [`e1d3643`](https://github.com/StoneCypher/circular_buffer_js/commit/e1d36430e7a5871959b1a5df0ff5f59677516d5e)
281 | - maybe ... maybe that's a string? [`18eba1e`](https://github.com/StoneCypher/circular_buffer_js/commit/18eba1e6f5def424e0f9393c99bcb4c4f65be7fc)
282 |
283 | #### [v0.13.2](https://github.com/StoneCypher/circular_buffer_js/compare/v0.13.1...v0.13.2)
284 |
285 | > 19 July 2021
286 |
287 | - 100% spec, 100% stoch [`e14a0d0`](https://github.com/StoneCypher/circular_buffer_js/commit/e14a0d071935a4554c7d295052d19cceb6505675)
288 |
289 | #### [v0.13.1](https://github.com/StoneCypher/circular_buffer_js/compare/v0.13.0...v0.13.1)
290 |
291 | > 19 July 2021
292 |
293 | - More serious stochastics. Separate stoch coverage fdrom spec coverage [`84987d6`](https://github.com/StoneCypher/circular_buffer_js/commit/84987d635116edd08ca2e1b8511d7a56695f2e7b)
294 |
295 | #### [v0.13.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.12.0...v0.13.0)
296 |
297 | > 19 July 2021
298 |
299 | - stoch testing :D [`9e68192`](https://github.com/StoneCypher/circular_buffer_js/commit/9e6819289769e1424fd72175ca6220c00b9bb48b)
300 |
301 | #### [v0.12.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.11.2...v0.12.0)
302 |
303 | > 19 July 2021
304 |
305 | - empty/0, full/0, tests [`75d622f`](https://github.com/StoneCypher/circular_buffer_js/commit/75d622f6ef32a0fcd7e2056767e6117789d02b89)
306 |
307 | #### [v0.11.2](https://github.com/StoneCypher/circular_buffer_js/compare/v0.11.0...v0.11.2)
308 |
309 | > 19 July 2021
310 |
311 | - early 100% coverage, no stoch yet [`bcfd509`](https://github.com/StoneCypher/circular_buffer_js/commit/bcfd509669e4c3c79515e25a3accf7c515318efd)
312 | - weird testing thing [`0f9c917`](https://github.com/StoneCypher/circular_buffer_js/commit/0f9c91725d07281a45412b7494db7ba2d104ed28)
313 | - Much improve the spec. Rename it to not be topic specific. [`1fbaaa8`](https://github.com/StoneCypher/circular_buffer_js/commit/1fbaaa89f8dd197d425ce2618c63fbe6d5043156)
314 |
315 | #### [v0.11.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.10.0...v0.11.0)
316 |
317 | > 19 July 2021
318 |
319 | - first steps towards basic unit tests [`92f1d67`](https://github.com/StoneCypher/circular_buffer_js/commit/92f1d673a94df8a67fb194da38c5d85035d66349)
320 |
321 | #### [v0.10.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.9.0...v0.10.0)
322 |
323 | > 19 July 2021
324 |
325 | - working fast-check in jest, and in build [`4e3de2c`](https://github.com/StoneCypher/circular_buffer_js/commit/4e3de2c416a5c7d85991fdbb08daefdd9c641889)
326 |
327 | #### [v0.9.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.8.0...v0.9.0)
328 |
329 | > 19 July 2021
330 |
331 | - working trivial jest [`74e005e`](https://github.com/StoneCypher/circular_buffer_js/commit/74e005ea5aeeca0547bdedff05f5f02263adbef3)
332 |
333 | #### [v0.8.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.7.0...v0.8.0)
334 |
335 | > 19 July 2021
336 |
337 | - servicable pop/0 [`aaaabf8`](https://github.com/StoneCypher/circular_buffer_js/commit/aaaabf8d78929c4c6ea8c88bd536afae29d311e4)
338 |
339 | #### [v0.7.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.6.0...v0.7.0)
340 |
341 | > 19 July 2021
342 |
343 | - Move docs to a branch to reduce install size. Remove docs from main entirely. Remove versioning scheme from main. Expect to recreate in CI [`f61c05b`](https://github.com/StoneCypher/circular_buffer_js/commit/f61c05bd943bd47c6c31680df31173151521898c)
344 | - servicable at/1, push/1 [`a7ae11a`](https://github.com/StoneCypher/circular_buffer_js/commit/a7ae11a0c7587a3bbe76f7f4df22957da0cccbd0)
345 | - first steps at ci automation [`99e265c`](https://github.com/StoneCypher/circular_buffer_js/commit/99e265ca9ef6a402009e5a8f14fe8b9ea77b5945)
346 | - vestige of old docs directory [`24c3fff`](https://github.com/StoneCypher/circular_buffer_js/commit/24c3ffffa09d6cb0ddd88af9329c942c9c09f9b6)
347 | - Add CI script and push to trigger [`49ae90f`](https://github.com/StoneCypher/circular_buffer_js/commit/49ae90f70ebc36f704a1f97814369eac638f4077)
348 |
349 | #### [v0.6.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.5.0...v0.6.0)
350 |
351 | > 19 July 2021
352 |
353 | - Minification. Moved verbose targets to non-tracked build. Minified into dist instead. Kept unminified iife only. [`edbadd8`](https://github.com/StoneCypher/circular_buffer_js/commit/edbadd84715838e260ea89fc47b08d10faa023fe)
354 |
355 | #### [v0.5.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.4.0...v0.5.0)
356 |
357 | > 19 July 2021
358 |
359 | - Versioned documentation build now works :D [`95b65de`](https://github.com/StoneCypher/circular_buffer_js/commit/95b65debd12d61790fa410ec58421c6fdbc1ca93)
360 | - Rollup bundling. Output is unminified esm, iife, cjs. [`7f0c630`](https://github.com/StoneCypher/circular_buffer_js/commit/7f0c630ee7608a100e6bc249dfcb3a68c14b5205)
361 |
362 | #### [v0.4.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.3.0...v0.4.0)
363 |
364 | > 19 July 2021
365 |
366 | - docs directory set up. typedoc extracting to current directory [`b320512`](https://github.com/StoneCypher/circular_buffer_js/commit/b3205126fb2d0417d7aca9f14bc6bf0adbff46d1)
367 |
368 | #### [v0.3.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.2.0...v0.3.0)
369 |
370 | > 19 July 2021
371 |
372 | - typescript now installed, building. version now part of build [`e9304d3`](https://github.com/StoneCypher/circular_buffer_js/commit/e9304d3b4433f59594955ba3e125a74101632695)
373 |
374 | #### [v0.2.0](https://github.com/StoneCypher/circular_buffer_js/compare/v0.1.0...v0.2.0)
375 |
376 | > 19 July 2021
377 |
378 | - build and clean processes; version number file generated [`57e4227`](https://github.com/StoneCypher/circular_buffer_js/commit/57e422739723e4ab85830aaacf7c8e264052447e)
379 |
380 | #### v0.1.0
381 |
382 | > 19 July 2021
383 |
384 | - Initial commit [`3675cd8`](https://github.com/StoneCypher/circular_buffer_js/commit/3675cd88609d5518474c5c55bd64843380f1364f)
385 | - npm init and npm install [`c93c939`](https://github.com/StoneCypher/circular_buffer_js/commit/c93c93930a92587506b6047188a13b7da836e16b)
386 |
--------------------------------------------------------------------------------
/src/ts/circular_buffer.ts:
--------------------------------------------------------------------------------
1 |
2 | import { version } from './generated/package_version';
3 |
4 |
5 |
6 |
7 |
8 | type TraversalFunctorGenerated using TypeDoc
264 |