buffer-backed-object - npm Package Compare versions

Comparing version 0.1.2 to 0.2.0

buffer-backed-object.js

@@ -134,7 +134,7 @@ /**
 ].forEach((name) => {
-  BufferBackedObject[name] = ({ endianess = "big" } = {}) => {
-    if (endianess !== "big" && endianess !== "little") {
-      throw Error("Endianess needs to be either 'big' or 'little'");
+  BufferBackedObject[name] = ({ endianess: endianness = "big" } = {}) => {
+    if (endianness !== "big" && endianness !== "little") {
+      throw Error("Endianness needs to be either 'big' or 'little'");
     }
-    const littleEndian = endianess === "little";
+    const littleEndian = endianness === "little";
     return {
@@ -141,0 +141,0 @@ size: globalThis[`${name}Array`].BYTES_PER_ELEMENT,

package.json

 {
   "name": "buffer-backed-object",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "",
@@ -8,5 +8,10 @@ "source": "buffer-backed-object.js",
   "main": "dist/buffer-backed-object.umd.js",
+  "types": "dist/buffer-backed-object.d.ts",
   "scripts": {
-    "build": "microbundle -f modern && microbundle -f umd",
-    "test": "karmatic"
+    "build": "run-p build:*",
+    "build:bundle": "microbundle -f modern && microbundle -f umd",
+    "build:types": "cp buffer-backed-object.d.ts dist/",
+    "test": "run-p test:*",
+    "test:unit": "karmatic",
+    "test:types": "tsc --noEmit buffer-backed-object.type-test.ts"
   },
@@ -16,2 +21,3 @@ "author": "Surma <[e-mail]>",
   "devDependencies": {
+    "conditional-type-checks": "^1.0.5",
     "husky": "^4.2.3",
@@ -21,2 +27,3 @@ "karmatic": "^1.4.0",
     "microbundle": "^0.12.0-next.8",
+    "npm-run-all": "^4.1.5",
     "prettier": "^2.0.4",
@@ -23,0 +30,0 @@ "webpack": "^4.42.1"

README.md

@@ -26,3 +26,3 @@ # `BufferBackedObject`
 const view = new BufferBackedObject(buffer, {
-  id: BufferBackedObject.Uint16({ endianess: "little" }),
+  id: BufferBackedObject.Uint16({ endianness: "little" }),
   position: BufferBackedObject.NestedBufferBackedObject({
@@ -58,3 +58,3 @@ x: BufferBackedObject.Float32(),
 const view = new ArrayOfBufferBackedObjects(buffer, {
-  id: BufferBackedObject.Uint16({ endianess: "little" }),
+  id: BufferBackedObject.Uint16({ endianness: "little" }),
   position: BufferBackedObject.NestedBufferBackedObject({
@@ -100,10 +100,10 @@ x: BufferBackedObject.Float32(),
 - `BufferBackedObject.Uint8()`: An 8-bit unsigned integer
-- `BufferBackedObject.Int16({endianess = 'big'})`: An 16-bit signed integer
-- `BufferBackedObject.Uint16({endianess = 'big'})`: An 16-bit unsigned integer
-- `BufferBackedObject.Int32({endianess = 'big'})`: An 32-bit signed integer
-- `BufferBackedObject.Uint32({endianess = 'big'})`: An 32-bit unsigned integer
-- `BufferBackedObject.BigInt64({endianess = 'big'})`: An 64-bit signed [`BigInt`][bigint]
-- `BufferBackedObject.BigUint64({endianess = 'big'})`: An 64-bit unsigned [`BigInt`][bigint]
-- `BufferBackedObject.Float32({endianess = 'big'})`: An 32-bit IEEE754 float
-- `BufferBackedObject.Float64({endianess = 'big'})`: An 64-bit IEEE754 float (“double”)
+- `BufferBackedObject.Int16({endianness = 'big'})`: An 16-bit signed integer
+- `BufferBackedObject.Uint16({endianness = 'big'})`: An 16-bit unsigned integer
+- `BufferBackedObject.Int32({endianness = 'big'})`: An 32-bit signed integer
+- `BufferBackedObject.Uint32({endianness = 'big'})`: An 32-bit unsigned integer
+- `BufferBackedObject.BigInt64({endianness = 'big'})`: An 64-bit signed [`BigInt`][bigint]
+- `BufferBackedObject.BigUint64({endianness = 'big'})`: An 64-bit unsigned [`BigInt`][bigint]
+- `BufferBackedObject.Float32({endianness = 'big'})`: An 32-bit IEEE754 float
+- `BufferBackedObject.Float64({endianness = 'big'})`: An 64-bit IEEE754 float (“double”)
 - `BufferBackedObject.UTF8String(maxBytes)`: A UTF-8 encoded string with the given maximum number of bytes. Trailing NULL bytes will be trimmed after decoding.
@@ -110,0 +110,0 @@ - `BufferBackedObject.ArrayBuffer(size)`: An `ArrayBuffer` of the given size

No alert changes

Improved metrics

Total package byte prevSize

68626

increased by10.29%

Number of package files

15

increased by25%

Lines of code

616

increased by34.2%

Worsened metrics

Dev dependency count

8

increased by33.33%

No dependency changes