numcodecs - npm Package Compare versions

Comparing version 0.0.15 to 0.1.0

package.json

 {
   "name": "numcodecs",
   "author": "Trevor James Manz",
-  "version": "0.0.15",
+  "version": "0.1.0",
   "description": "Buffer compression and transformation codecs for use in data storage and communication applications.",
@@ -6,0 +6,0 @@ "types": "dist/types/src/index.d.ts",

README.md

@@ -1,30 +0,52 @@
-# numcodecs
+# numcodecs.js
 
+Buffer compression and transformation codecs for use in [Zarr.js](https://github.com/gzuidhof/zarr.js/) and beyond...
 
-Examples:
+### Installation
 
-Some experiments with Node.js 14.1 [package exports](https://nodejs.org/api/modules.html).
+```bash
+npm install numcodecs
+```
+
+### Usage
+
 ```javascript
-// Rollup & webpack don't have great support for exports so the easiest
-// way to import from the main (since the lib is completely tree shakeable)
-import { GZip } from 'numcodecs';
+import { Blosc } from 'numcodecs';
 
-// Node 14 conditional exports
+const codec = new Blosc();
 
-// index.mjs
-import { GZip } from 'numcodecs';
-import GZip from 'numcodecs/gzip';
+const size = 100000;
+const arr = new Uint32Array(size);
+for (let i = 0; i < size; i++) {
+  arr[i] = i;
+}
 
-// index.js
-const GZip = require('numcodecs').GZip;
-const GZip = require('numcodecs/gzip');
+const bytes = new Uint8Array(arr.buffer);
+console.log(bytes);
+// Uint8Array(400000) [0, 0, 0, 0,  1, 0, 0, 0,  2, 0, 0, 0, ... ]
 
-const codec = GZip.fromConfig({ level: 1 }); // or new GZip(1);
+const encoded = await codec.encode(bytes);
+console.log(encoded);
+// Uint8Array(3744) [2, 1, 33, 4, 128, 26, 6, 0, 0, 0, 4, 0, ... ]
 
-// Usage
-const arr = new Float32Array([1, 2, 3, 4, 5, 6]);
-const encoded = codec.encode(new Uint8Array(arr.buffer));
-const decoded = coded.decode(encoded);
-console.log(new Float32Array(decoded.buffer));
-// Float32Array(6) [ 1, 2, 3, 4, 5, 6 ]
+const decoded = await coded.decode(encoded);
+console.log(new Uint32Array(decoded.buffer));
+// Uint32Array(100000) [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,  ... ]
 ```
+
+### Author's note
+
+This project is intended as a Typescript implementation of the buffer compression library [`numcodecs`](https://github.com/zarr-developers/numcodecs) which supports [`zarr-python`](https://github.com/zarr-developers/zarr-python). Currently only `blosc`, `zlib`, and `gzip` compressors are supported. No other compressors are implemented, but contributions are welcome!
+
+
+### Conditional exports
+
+Each compressor is bundled as a separate entrypoint and exported as a package submodule using Node's [conditional exports](https://nodejs.org/api/modules.html). This means that compressors can be imported as independent modules. We hope this will afford an option to have a more dynamic and configurable compressor registry in Zarr.js in the future.
+
+```javascript
+// index.js
+const Zlib = require('numcodecs/zlib');
+
+// index.mjs
+import { Zlib } from 'numcodecs/zlib';
+```

No alert changes

Improved metrics

Number of lines in readme file

53

increased by70.97%

Worsened metrics

Total package byte prevSize

1760282

decreased by-50.29%

Number of package files

21

decreased by-32.26%

Lines of code

17483

decreased by-0.06%

No dependency changes