✨ feat: Add alloc, malloc, and _calloc.

Author: make-github-pseudonymous-again

.commitlintrc.js renamed to .commitlintrc.cjs

@@ -1,15 +1,17 @@
 :seat: [@array-like/alloc](https://array-like.github.io/alloc)
 ==
 
-ArrayLike allocation helper functions for JavaScript.
+`ArrayLike` allocation helper functions for JavaScript.
 See [docs](https://array-like.github.io/alloc/index.html).
 
-> :building_construction: Caveat emptor! This is work in progress. Code may be
-> working. Documentation may be present. Coherence may be. Maybe.
+```js
+import {alloc, malloc, _calloc} from '@array-like/alloc';
 
-> :warning: Depending on your environment, the code may require
-> `regeneratorRuntime` to be defined, for instance by importing
-> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
+alloc(10); // Array
+malloc(10); // ArrayBuffer
+const calloc = _calloc(Int32Array);
+calloc(10); // Int32Array
+```
 
 [![License](https://img.shields.io/github/license/array-like/alloc.svg)](https://raw.githubusercontent.com/array-like/alloc/main/LICENSE)
 [![Version](https://img.shields.io/npm/v/@array-like/alloc.svg)](https://www.npmjs.org/package/@array-like/alloc)

README.md

@@ -1,17 +1,6 @@
 # Usage
 
-> :warning: Depending on your environment, the code may require
-> `regeneratorRuntime` to be defined, for instance by importing
-> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
-
-First, require the polyfill at the entry point of your application
-```js
-await import('regenerator-runtime/runtime.js');
-// or
-import 'regenerator-runtime/runtime.js';
-```
-
-Then, import the library where needed
+Import the library where needed
 ```js
 const alloc = await import('@array-like/alloc');
 // or

doc/manual/usage.md

@@ -199,6 +199,7 @@
       "unicorn"
     ],
     "rules": {
+      "unicorn/no-new-array": "off",
       "unicorn/filename-case": [
         "error",
         {

package.json

@@ -0,0 +1,8 @@
+/**
+ * Method that creates an allocator from an array constructor.
+ *
+ * @param {any} ArrayConstructor
+ * @return {Function}
+ */
+const _calloc = (ArrayConstructor) => (n) => new ArrayConstructor(n);
+export default _calloc;

src/_calloc.js

@@ -0,0 +1,8 @@
+/**
+ * Method that allocates an Array.
+ *
+ * @param {number} n
+ * @return {Array}
+ */
+const alloc = (n) => new Array(n);
+export default alloc;

src/alloc.js

@@ -1,2 +1,3 @@
-const answer = 42;
-export default answer;
+export {default as _calloc} from './_calloc.js';
+export {default as alloc} from './alloc.js';
+export {default as malloc} from './malloc.js';

src/index.js

@@ -0,0 +1,8 @@
+/**
+ * Method that allocates an ArrayBuffer.
+ *
+ * @param {number} n
+ * @return {ArrayBuffer}
+ */
+const malloc = (n) => new ArrayBuffer(n);
+export default malloc;

src/malloc.js

@@ -0,0 +1,10 @@
+import test from 'ava';
+
+import {alloc} from '../../src/index.js';
+
+test('alloc', (t) => {
+	const a = alloc(10);
+
+	t.is(a.length, 10, 'check length');
+	t.true(Array.isArray(a), 'check type');
+});

test/src/alloc.js

@@ -0,0 +1,19 @@
+import test from 'ava';
+
+import {_calloc} from '../../src/index.js';
+
+const macro = (t, TypedArray, n) => {
+	const calloc = _calloc(TypedArray);
+
+	const a = calloc(n);
+
+	t.is(a.length, n, 'check length');
+	t.true(a instanceof TypedArray, 'check type');
+};
+
+macro.title = (title, TypedArray, n) =>
+	title ?? `_calloc(${TypedArray.name})(${n})`;
+
+test(macro, Uint8Array, 10);
+test(macro, Uint16Array, 133);
+test(macro, Int32Array, 27);

test/src/api.js

@@ -0,0 +1,10 @@
+import test from 'ava';
+
+import {malloc} from '../../src/index.js';
+
+test('malloc', (t) => {
+	const a = malloc(10);
+
+	t.is(a.byteLength, 10, 'check length');
+	t.true(a instanceof ArrayBuffer, 'check type');
+});