pointer-set - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

dist/cjs/index.d.ts

@@ -7,5 +7,17 @@ declare const max16 = 65536;
 declare const mask24 = 16777215;
+/**
+ * error raised when trying to access a pointer value as raw uint32
+ */
 export declare const errPointerAsRaw: (f: string) => TypeError;
+/**
+ * error raised when trying to access a raw uint32 value as a pointer
+ */
 export declare const errRawAsPointer: (f: string) => TypeError;
+/**
+ * error raised when attempting to access an unknown raw field
+ */
 export declare const errUnknownRawField: (f: string) => TypeError;
+/**
+ * error raised when attempting to access an unknown pointer field
+ */
 export declare const errUnknownPointerField: (f: string) => TypeError;
@@ -29,2 +41,3 @@ type ArrayValues<K extends readonly string[]> = K[number];
  * Type representing a Pointer.
+ *
  * An unsigned 32-bit integer, where the low 8 or 16 bytes represent
@@ -273,4 +286,4 @@ * the index within the stack (8 if the block size is 256 or lower,
 /**
- * Public interface to create a PointerSet, also represents the
- * initial block of data.
+ * Class representing the root block of and public interface to a
+ * PointerSet block store.
  */
@@ -296,2 +309,6 @@ export declare class PointerSet<T extends {} | null, K extends readonly string[], R extends readonly string[] = []> extends PointerSetBase<T, K, R> implements PointerSetBlock<T, K, R> {
     freeList: Stack;
+    /**
+     * Public interface to create a PointerSet, also representing the
+     * first block of data.
+     */
     constructor(fields: K, blockSize?: number, rawFields?: R);
@@ -325,2 +342,9 @@ }
     blockSize: BlockSize;
+    /**
+     * Class representing an expanded block in a PointerSet data store.
+     * These are created on demand, they are NOT intended to be instantiated
+     * directly.
+     *
+     * Exported for the benefit of type checking and extension use cases.
+     */
     constructor(blocks: PointerSetBlock<T, K, R>[], blocksAvail: Set<PointerSetBlock<T, K, R>>, names: {
@@ -327,0 +351,0 @@ [k in FieldName<K> | FieldName<R>]: FieldId;

dist/cjs/index.js

@@ -11,8 +11,20 @@ "use strict";
 const mask24 = 16777215;
+/**
+ * error raised when trying to access a pointer value as raw uint32
+ */
 const errPointerAsRaw = (f) => new TypeError('cannot access pointer field as raw uint32: ' + f);
 exports.errPointerAsRaw = errPointerAsRaw;
+/**
+ * error raised when trying to access a raw uint32 value as a pointer
+ */
 const errRawAsPointer = (f) => new TypeError('cannot access raw uint32 field as pointer: ' + f);
 exports.errRawAsPointer = errRawAsPointer;
+/**
+ * error raised when attempting to access an unknown raw field
+ */
 const errUnknownRawField = (f) => new TypeError('unknown raw uint32 field: ' + f);
 exports.errUnknownRawField = errUnknownRawField;
+/**
+ * error raised when attempting to access an unknown pointer field
+ */
 const errUnknownPointerField = (f) => new TypeError('unknown pointer field: ' + f);
@@ -509,4 +521,4 @@ exports.errUnknownPointerField = errUnknownPointerField;
 /**
- * Public interface to create a PointerSet, also represents the
- * initial block of data.
+ * Class representing the root block of and public interface to a
+ * PointerSet block store.
  */
@@ -533,2 +545,6 @@ class PointerSet extends PointerSetBase {
     freeList;
+    /**
+     * Public interface to create a PointerSet, also representing the
+     * first block of data.
+     */
     constructor(fields, blockSize = 256, rawFields) {
@@ -602,2 +618,9 @@ super();
     blockSize;
+    /**
+     * Class representing an expanded block in a PointerSet data store.
+     * These are created on demand, they are NOT intended to be instantiated
+     * directly.
+     *
+     * Exported for the benefit of type checking and extension use cases.
+     */
     constructor(blocks, blocksAvail, names, wordSize, shift, mask, blockIdMask, blockSize) {
@@ -604,0 +627,0 @@ super();

dist/mjs/index.d.ts

@@ -7,5 +7,17 @@ declare const max16 = 65536;
 declare const mask24 = 16777215;
+/**
+ * error raised when trying to access a pointer value as raw uint32
+ */
 export declare const errPointerAsRaw: (f: string) => TypeError;
+/**
+ * error raised when trying to access a raw uint32 value as a pointer
+ */
 export declare const errRawAsPointer: (f: string) => TypeError;
+/**
+ * error raised when attempting to access an unknown raw field
+ */
 export declare const errUnknownRawField: (f: string) => TypeError;
+/**
+ * error raised when attempting to access an unknown pointer field
+ */
 export declare const errUnknownPointerField: (f: string) => TypeError;
@@ -29,2 +41,3 @@ type ArrayValues<K extends readonly string[]> = K[number];
  * Type representing a Pointer.
+ *
  * An unsigned 32-bit integer, where the low 8 or 16 bytes represent
@@ -273,4 +286,4 @@ * the index within the stack (8 if the block size is 256 or lower,
 /**
- * Public interface to create a PointerSet, also represents the
- * initial block of data.
+ * Class representing the root block of and public interface to a
+ * PointerSet block store.
  */
@@ -296,2 +309,6 @@ export declare class PointerSet<T extends {} | null, K extends readonly string[], R extends readonly string[] = []> extends PointerSetBase<T, K, R> implements PointerSetBlock<T, K, R> {
     freeList: Stack;
+    /**
+     * Public interface to create a PointerSet, also representing the
+     * first block of data.
+     */
     constructor(fields: K, blockSize?: number, rawFields?: R);
@@ -325,2 +342,9 @@ }
     blockSize: BlockSize;
+    /**
+     * Class representing an expanded block in a PointerSet data store.
+     * These are created on demand, they are NOT intended to be instantiated
+     * directly.
+     *
+     * Exported for the benefit of type checking and extension use cases.
+     */
     constructor(blocks: PointerSetBlock<T, K, R>[], blocksAvail: Set<PointerSetBlock<T, K, R>>, names: {
@@ -327,0 +351,0 @@ [k in FieldName<K> | FieldName<R>]: FieldId;

dist/mjs/index.js

@@ -8,5 +8,17 @@ const max8 = 256;
 const mask24 = 16777215;
+/**
+ * error raised when trying to access a pointer value as raw uint32
+ */
 export const errPointerAsRaw = (f) => new TypeError('cannot access pointer field as raw uint32: ' + f);
+/**
+ * error raised when trying to access a raw uint32 value as a pointer
+ */
 export const errRawAsPointer = (f) => new TypeError('cannot access raw uint32 field as pointer: ' + f);
+/**
+ * error raised when attempting to access an unknown raw field
+ */
 export const errUnknownRawField = (f) => new TypeError('unknown raw uint32 field: ' + f);
+/**
+ * error raised when attempting to access an unknown pointer field
+ */
 export const errUnknownPointerField = (f) => new TypeError('unknown pointer field: ' + f);
@@ -502,4 +514,4 @@ const getWordSize = (max) => (max <= max8 ? 1 : max <= max16 ? 2 : 4);
 /**
- * Public interface to create a PointerSet, also represents the
- * initial block of data.
+ * Class representing the root block of and public interface to a
+ * PointerSet block store.
  */
@@ -526,2 +538,6 @@ export class PointerSet extends PointerSetBase {
     freeList;
+    /**
+     * Public interface to create a PointerSet, also representing the
+     * first block of data.
+     */
     constructor(fields, blockSize = 256, rawFields) {
@@ -594,2 +610,9 @@ super();
     blockSize;
+    /**
+     * Class representing an expanded block in a PointerSet data store.
+     * These are created on demand, they are NOT intended to be instantiated
+     * directly.
+     *
+     * Exported for the benefit of type checking and extension use cases.
+     */
     constructor(blocks, blocksAvail, names, wordSize, shift, mask, blockIdMask, blockSize) {
@@ -596,0 +619,0 @@ super();

package.json

 {
   "name": "pointer-set",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "set of values with pointers to other entries, backed by auto=-expanding UintArray slabs",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

138630

increased by2.11%

Lines of code

2363

increased by4.14%

No dependency changes