@loaders.gl/netcdf 3.1.0-alpha.4 → 3.1.0-beta.3

package/dist/esm/netcdfjs/read-type.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/netcdfjs/read-type.ts"],"names":["TYPES","BYTE","CHAR","SHORT","INT","FLOAT","DOUBLE","readType","buffer","type","size","readBytes","trimNull","readChars","readNumber","readInt16","bind","readInt32","readFloat32","readFloat64","Error","num2str","Number","num2bytes","str2num","String","bufferReader","numbers","Array","i","value","charCodeAt","length","substring"],"mappings":"AAEA,OAAO,MAAMA,KAAK,GAAG;AACnBC,EAAAA,IAAI,EAAE,CADa;AAEnBC,EAAAA,IAAI,EAAE,CAFa;AAGnBC,EAAAA,KAAK,EAAE,CAHY;AAInBC,EAAAA,GAAG,EAAE,CAJc;AAKnBC,EAAAA,KAAK,EAAE,CALY;AAMnBC,EAAAA,MAAM,EAAE;AANW,CAAd;AAgBP,OAAO,SAASC,QAAT,CACLC,MADK,EAELC,IAFK,EAGLC,IAHK,EAIoC;AACzC,UAAQD,IAAR;AACE,SAAKT,KAAK,CAACC,IAAX;AACE,aAAOO,MAAM,CAACG,SAAP,CAAiBD,IAAjB,CAAP;;AACF,SAAKV,KAAK,CAACE,IAAX;AACE,aAAOU,QAAQ,CAACJ,MAAM,CAACK,SAAP,CAAiBH,IAAjB,CAAD,CAAf;;AACF,SAAKV,KAAK,CAACG,KAAX;AACE,aAAOW,UAAU,CAACJ,IAAD,EAAOF,MAAM,CAACO,SAAP,CAAiBC,IAAjB,CAAsBR,MAAtB,CAAP,CAAjB;;AACF,SAAKR,KAAK,CAACI,GAAX;AACE,aAAOU,UAAU,CAACJ,IAAD,EAAOF,MAAM,CAACS,SAAP,CAAiBD,IAAjB,CAAsBR,MAAtB,CAAP,CAAjB;;AACF,SAAKR,KAAK,CAACK,KAAX;AACE,aAAOS,UAAU,CAACJ,IAAD,EAAOF,MAAM,CAACU,WAAP,CAAmBF,IAAnB,CAAwBR,MAAxB,CAAP,CAAjB;;AACF,SAAKR,KAAK,CAACM,MAAX;AACE,aAAOQ,UAAU,CAACJ,IAAD,EAAOF,MAAM,CAACW,WAAP,CAAmBH,IAAnB,CAAwBR,MAAxB,CAAP,CAAjB;;AAEF;AACE,YAAM,IAAIY,KAAJ,CAAW,0BAAyBX,IAAK,EAAzC,CAAN;AAfJ;AAiBD;AAOD,OAAO,SAASY,OAAT,CAAiBZ,IAAjB,EAAuC;AAC5C,UAAQa,MAAM,CAACb,IAAD,CAAd;AACE,SAAKT,KAAK,CAACC,IAAX;AACE,aAAO,MAAP;;AACF,SAAKD,KAAK,CAACE,IAAX;AACE,aAAO,MAAP;;AACF,SAAKF,KAAK,CAACG,KAAX;AACE,aAAO,OAAP;;AACF,SAAKH,KAAK,CAACI,GAAX;AACE,aAAO,KAAP;;AACF,SAAKJ,KAAK,CAACK,KAAX;AACE,aAAO,OAAP;;AACF,SAAKL,KAAK,CAACM,MAAX;AACE,aAAO,QAAP;;AAEF;AACE,aAAO,WAAP;AAfJ;AAiBD;AAOD,OAAO,SAASiB,SAAT,CAAmBd,IAAnB,EAAyC;AAC9C,UAAQa,MAAM,CAACb,IAAD,CAAd;AACE,SAAKT,KAAK,CAACC,IAAX;AACE,aAAO,CAAP;;AACF,SAAKD,KAAK,CAACE,IAAX;AACE,aAAO,CAAP;;AACF,SAAKF,KAAK,CAACG,KAAX;AACE,aAAO,CAAP;;AACF,SAAKH,KAAK,CAACI,GAAX;AACE,aAAO,CAAP;;AACF,SAAKJ,KAAK,CAACK,KAAX;AACE,aAAO,CAAP;;AACF,SAAKL,KAAK,CAACM,MAAX;AACE,aAAO,CAAP;;AAEF;AACE,aAAO,CAAC,CAAR;AAfJ;AAiBD;AAOD,OAAO,SAASkB,OAAT,CAAiBf,IAAjB,EAAuC;AAC5C,UAAQgB,MAAM,CAAChB,IAAD,CAAd;AACE,SAAK,MAAL;AACE,aAAOT,KAAK,CAACC,IAAb;;AACF,SAAK,MAAL;AACE,aAAOD,KAAK,CAACE,IAAb;;AACF,SAAK,OAAL;AACE,aAAOF,KAAK,CAACG,KAAb;;AACF,SAAK,KAAL;AACE,aAAOH,KAAK,CAACI,GAAb;;AACF,SAAK,OAAL;AACE,aAAOJ,KAAK,CAACK,KAAb;;AACF,SAAK,QAAL;AACE,aAAOL,KAAK,CAACM,MAAb;;AAEF;AACE,aAAO,CAAC,CAAR;AAfJ;AAiBD;;AAQD,SAASQ,UAAT,CAAoBJ,IAApB,EAAkCgB,YAAlC,EAAiF;AAC/E,MAAIhB,IAAI,KAAK,CAAb,EAAgB;AACd,UAAMiB,OAAO,GAAG,IAAIC,KAAJ,CAAUlB,IAAV,CAAhB;;AACA,SAAK,IAAImB,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGnB,IAApB,EAA0BmB,CAAC,EAA3B,EAA+B;AAC7BF,MAAAA,OAAO,CAACE,CAAD,CAAP,GAAaH,YAAY,EAAzB;AACD;;AACD,WAAOC,OAAP;AACD;;AACD,SAAOD,YAAY,EAAnB;AACD;;AAOD,SAASd,QAAT,CAAkBkB,KAAlB,EAAyC;AACvC,MAAIA,KAAK,CAACC,UAAN,CAAiBD,KAAK,CAACE,MAAN,GAAe,CAAhC,MAAuC,CAA3C,EAA8C;AAC5C,WAAOF,KAAK,CAACG,SAAN,CAAgB,CAAhB,EAAmBH,KAAK,CAACE,MAAN,GAAe,CAAlC,CAAP;AACD;;AACD,SAAOF,KAAP;AACD","sourcesContent":["import {IOBuffer} from '../iobuffer/iobuffer';\n\nexport const TYPES = {\n  BYTE: 1,\n  CHAR: 2,\n  SHORT: 3,\n  INT: 4,\n  FLOAT: 5,\n  DOUBLE: 6\n};\n\n/**\n * Given a type and a size reads the next element\n * @param buffer - Buffer for the file data\n * @param type - Type of the data to read\n * @param size - Size of the element to read\n * @return\n */\nexport function readType(\n  buffer: IOBuffer,\n  type: number,\n  size: number\n): string | number | number[] | Uint8Array {\n  switch (type) {\n    case TYPES.BYTE:\n      return buffer.readBytes(size);\n    case TYPES.CHAR:\n      return trimNull(buffer.readChars(size));\n    case TYPES.SHORT:\n      return readNumber(size, buffer.readInt16.bind(buffer));\n    case TYPES.INT:\n      return readNumber(size, buffer.readInt32.bind(buffer));\n    case TYPES.FLOAT:\n      return readNumber(size, buffer.readFloat32.bind(buffer));\n    case TYPES.DOUBLE:\n      return readNumber(size, buffer.readFloat64.bind(buffer));\n    /* istanbul ignore next */\n    default:\n      throw new Error(`NetCDF: non valid type ${type}`);\n  }\n}\n\n/**\n * Parse a number into their respective type\n * @param type - integer that represents the type\n * @return parsed value of the type\n */\nexport function num2str(type: number): string {\n  switch (Number(type)) {\n    case TYPES.BYTE:\n      return 'byte';\n    case TYPES.CHAR:\n      return 'char';\n    case TYPES.SHORT:\n      return 'short';\n    case TYPES.INT:\n      return 'int';\n    case TYPES.FLOAT:\n      return 'float';\n    case TYPES.DOUBLE:\n      return 'double';\n    /* istanbul ignore next */\n    default:\n      return 'undefined';\n  }\n}\n\n/**\n * Parse a number type identifier to his size in bytes\n * @param type - integer that represents the type\n * @return size of the type\n */\nexport function num2bytes(type: number): number {\n  switch (Number(type)) {\n    case TYPES.BYTE:\n      return 1;\n    case TYPES.CHAR:\n      return 1;\n    case TYPES.SHORT:\n      return 2;\n    case TYPES.INT:\n      return 4;\n    case TYPES.FLOAT:\n      return 4;\n    case TYPES.DOUBLE:\n      return 8;\n    /* istanbul ignore next */\n    default:\n      return -1;\n  }\n}\n\n/**\n * Reverse search of num2str\n * @param type string that represents the type\n * @return parsed value of the type\n */\nexport function str2num(type: string): number {\n  switch (String(type)) {\n    case 'byte':\n      return TYPES.BYTE;\n    case 'char':\n      return TYPES.CHAR;\n    case 'short':\n      return TYPES.SHORT;\n    case 'int':\n      return TYPES.INT;\n    case 'float':\n      return TYPES.FLOAT;\n    case 'double':\n      return TYPES.DOUBLE;\n    /* istanbul ignore next */\n    default:\n      return -1;\n  }\n}\n\n/**\n * Auxiliary function to read numeric data\n * @param size - Size of the element to read\n * @param bufferReader - Function to read next value\n * @return\n */\nfunction readNumber(size: number, bufferReader: () => number): number | number[] {\n  if (size !== 1) {\n    const numbers = new Array(size);\n    for (let i = 0; i < size; i++) {\n      numbers[i] = bufferReader();\n    }\n    return numbers;\n  }\n  return bufferReader();\n}\n\n/**\n * Removes null terminate value\n * @param value - String to trim\n * @return - Trimmed string\n */\nfunction trimNull(value: string): string {\n  if (value.charCodeAt(value.length - 1) === 0) {\n    return value.substring(0, value.length - 1);\n  }\n  return value;\n}\n"],"file":"read-type.js"}
+{"version":3,"sources":["../../../src/netcdfjs/read-type.ts"],"names":["TYPES","BYTE","CHAR","SHORT","INT","FLOAT","DOUBLE","readType","buffer","type","size","readBytes","trimNull","readChars","readNumber","readInt16","bind","readInt32","readFloat32","readFloat64","Error","num2str","Number","num2bytes","str2num","String","bufferReader","numbers","Array","i","value","charCodeAt","length","substring"],"mappings":"AAEA,OAAO,MAAMA,KAAK,GAAG;AACnBC,EAAAA,IAAI,EAAE,CADa;AAEnBC,EAAAA,IAAI,EAAE,CAFa;AAGnBC,EAAAA,KAAK,EAAE,CAHY;AAInBC,EAAAA,GAAG,EAAE,CAJc;AAKnBC,EAAAA,KAAK,EAAE,CALY;AAMnBC,EAAAA,MAAM,EAAE;AANW,CAAd;AAgBP,OAAO,SAASC,QAAT,CACLC,MADK,EAELC,IAFK,EAGLC,IAHK,EAIoC;AACzC,UAAQD,IAAR;AACE,SAAKT,KAAK,CAACC,IAAX;AACE,aAAOO,MAAM,CAACG,SAAP,CAAiBD,IAAjB,CAAP;;AACF,SAAKV,KAAK,CAACE,IAAX;AACE,aAAOU,QAAQ,CAACJ,MAAM,CAACK,SAAP,CAAiBH,IAAjB,CAAD,CAAf;;AACF,SAAKV,KAAK,CAACG,KAAX;AACE,aAAOW,UAAU,CAACJ,IAAD,EAAOF,MAAM,CAACO,SAAP,CAAiBC,IAAjB,CAAsBR,MAAtB,CAAP,CAAjB;;AACF,SAAKR,KAAK,CAACI,GAAX;AACE,aAAOU,UAAU,CAACJ,IAAD,EAAOF,MAAM,CAACS,SAAP,CAAiBD,IAAjB,CAAsBR,MAAtB,CAAP,CAAjB;;AACF,SAAKR,KAAK,CAACK,KAAX;AACE,aAAOS,UAAU,CAACJ,IAAD,EAAOF,MAAM,CAACU,WAAP,CAAmBF,IAAnB,CAAwBR,MAAxB,CAAP,CAAjB;;AACF,SAAKR,KAAK,CAACM,MAAX;AACE,aAAOQ,UAAU,CAACJ,IAAD,EAAOF,MAAM,CAACW,WAAP,CAAmBH,IAAnB,CAAwBR,MAAxB,CAAP,CAAjB;;AAEF;AACE,YAAM,IAAIY,KAAJ,kCAAoCX,IAApC,EAAN;AAfJ;AAiBD;AAOD,OAAO,SAASY,OAAT,CAAiBZ,IAAjB,EAAuC;AAC5C,UAAQa,MAAM,CAACb,IAAD,CAAd;AACE,SAAKT,KAAK,CAACC,IAAX;AACE,aAAO,MAAP;;AACF,SAAKD,KAAK,CAACE,IAAX;AACE,aAAO,MAAP;;AACF,SAAKF,KAAK,CAACG,KAAX;AACE,aAAO,OAAP;;AACF,SAAKH,KAAK,CAACI,GAAX;AACE,aAAO,KAAP;;AACF,SAAKJ,KAAK,CAACK,KAAX;AACE,aAAO,OAAP;;AACF,SAAKL,KAAK,CAACM,MAAX;AACE,aAAO,QAAP;;AAEF;AACE,aAAO,WAAP;AAfJ;AAiBD;AAOD,OAAO,SAASiB,SAAT,CAAmBd,IAAnB,EAAyC;AAC9C,UAAQa,MAAM,CAACb,IAAD,CAAd;AACE,SAAKT,KAAK,CAACC,IAAX;AACE,aAAO,CAAP;;AACF,SAAKD,KAAK,CAACE,IAAX;AACE,aAAO,CAAP;;AACF,SAAKF,KAAK,CAACG,KAAX;AACE,aAAO,CAAP;;AACF,SAAKH,KAAK,CAACI,GAAX;AACE,aAAO,CAAP;;AACF,SAAKJ,KAAK,CAACK,KAAX;AACE,aAAO,CAAP;;AACF,SAAKL,KAAK,CAACM,MAAX;AACE,aAAO,CAAP;;AAEF;AACE,aAAO,CAAC,CAAR;AAfJ;AAiBD;AAOD,OAAO,SAASkB,OAAT,CAAiBf,IAAjB,EAAuC;AAC5C,UAAQgB,MAAM,CAAChB,IAAD,CAAd;AACE,SAAK,MAAL;AACE,aAAOT,KAAK,CAACC,IAAb;;AACF,SAAK,MAAL;AACE,aAAOD,KAAK,CAACE,IAAb;;AACF,SAAK,OAAL;AACE,aAAOF,KAAK,CAACG,KAAb;;AACF,SAAK,KAAL;AACE,aAAOH,KAAK,CAACI,GAAb;;AACF,SAAK,OAAL;AACE,aAAOJ,KAAK,CAACK,KAAb;;AACF,SAAK,QAAL;AACE,aAAOL,KAAK,CAACM,MAAb;;AAEF;AACE,aAAO,CAAC,CAAR;AAfJ;AAiBD;;AAQD,SAASQ,UAAT,CAAoBJ,IAApB,EAAkCgB,YAAlC,EAAiF;AAC/E,MAAIhB,IAAI,KAAK,CAAb,EAAgB;AACd,UAAMiB,OAAO,GAAG,IAAIC,KAAJ,CAAUlB,IAAV,CAAhB;;AACA,SAAK,IAAImB,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGnB,IAApB,EAA0BmB,CAAC,EAA3B,EAA+B;AAC7BF,MAAAA,OAAO,CAACE,CAAD,CAAP,GAAaH,YAAY,EAAzB;AACD;;AACD,WAAOC,OAAP;AACD;;AACD,SAAOD,YAAY,EAAnB;AACD;;AAOD,SAASd,QAAT,CAAkBkB,KAAlB,EAAyC;AACvC,MAAIA,KAAK,CAACC,UAAN,CAAiBD,KAAK,CAACE,MAAN,GAAe,CAAhC,MAAuC,CAA3C,EAA8C;AAC5C,WAAOF,KAAK,CAACG,SAAN,CAAgB,CAAhB,EAAmBH,KAAK,CAACE,MAAN,GAAe,CAAlC,CAAP;AACD;;AACD,SAAOF,KAAP;AACD","sourcesContent":["import {IOBuffer} from '../iobuffer/iobuffer';\n\nexport const TYPES = {\n  BYTE: 1,\n  CHAR: 2,\n  SHORT: 3,\n  INT: 4,\n  FLOAT: 5,\n  DOUBLE: 6\n};\n\n/**\n * Given a type and a size reads the next element\n * @param buffer - Buffer for the file data\n * @param type - Type of the data to read\n * @param size - Size of the element to read\n * @return\n */\nexport function readType(\n  buffer: IOBuffer,\n  type: number,\n  size: number\n): string | number | number[] | Uint8Array {\n  switch (type) {\n    case TYPES.BYTE:\n      return buffer.readBytes(size);\n    case TYPES.CHAR:\n      return trimNull(buffer.readChars(size));\n    case TYPES.SHORT:\n      return readNumber(size, buffer.readInt16.bind(buffer));\n    case TYPES.INT:\n      return readNumber(size, buffer.readInt32.bind(buffer));\n    case TYPES.FLOAT:\n      return readNumber(size, buffer.readFloat32.bind(buffer));\n    case TYPES.DOUBLE:\n      return readNumber(size, buffer.readFloat64.bind(buffer));\n    /* istanbul ignore next */\n    default:\n      throw new Error(`NetCDF: non valid type ${type}`);\n  }\n}\n\n/**\n * Parse a number into their respective type\n * @param type - integer that represents the type\n * @return parsed value of the type\n */\nexport function num2str(type: number): string {\n  switch (Number(type)) {\n    case TYPES.BYTE:\n      return 'byte';\n    case TYPES.CHAR:\n      return 'char';\n    case TYPES.SHORT:\n      return 'short';\n    case TYPES.INT:\n      return 'int';\n    case TYPES.FLOAT:\n      return 'float';\n    case TYPES.DOUBLE:\n      return 'double';\n    /* istanbul ignore next */\n    default:\n      return 'undefined';\n  }\n}\n\n/**\n * Parse a number type identifier to his size in bytes\n * @param type - integer that represents the type\n * @return size of the type\n */\nexport function num2bytes(type: number): number {\n  switch (Number(type)) {\n    case TYPES.BYTE:\n      return 1;\n    case TYPES.CHAR:\n      return 1;\n    case TYPES.SHORT:\n      return 2;\n    case TYPES.INT:\n      return 4;\n    case TYPES.FLOAT:\n      return 4;\n    case TYPES.DOUBLE:\n      return 8;\n    /* istanbul ignore next */\n    default:\n      return -1;\n  }\n}\n\n/**\n * Reverse search of num2str\n * @param type string that represents the type\n * @return parsed value of the type\n */\nexport function str2num(type: string): number {\n  switch (String(type)) {\n    case 'byte':\n      return TYPES.BYTE;\n    case 'char':\n      return TYPES.CHAR;\n    case 'short':\n      return TYPES.SHORT;\n    case 'int':\n      return TYPES.INT;\n    case 'float':\n      return TYPES.FLOAT;\n    case 'double':\n      return TYPES.DOUBLE;\n    /* istanbul ignore next */\n    default:\n      return -1;\n  }\n}\n\n/**\n * Auxiliary function to read numeric data\n * @param size - Size of the element to read\n * @param bufferReader - Function to read next value\n * @return\n */\nfunction readNumber(size: number, bufferReader: () => number): number | number[] {\n  if (size !== 1) {\n    const numbers = new Array(size);\n    for (let i = 0; i < size; i++) {\n      numbers[i] = bufferReader();\n    }\n    return numbers;\n  }\n  return bufferReader();\n}\n\n/**\n * Removes null terminate value\n * @param value - String to trim\n * @return - Trimmed string\n */\nfunction trimNull(value: string): string {\n  if (value.charCodeAt(value.length - 1) === 0) {\n    return value.substring(0, value.length - 1);\n  }\n  return value;\n}\n"],"file":"read-type.js"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { NetCDFReader } from './netcdfjs/netcdf-reader';
+export { NetCDFLoader } from './netcdf-loader';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAEtD,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetCDFLoader = exports.NetCDFReader = void 0;
+var netcdf_reader_1 = require("./netcdfjs/netcdf-reader");
+Object.defineProperty(exports, "NetCDFReader", { enumerable: true, get: function () { return netcdf_reader_1.NetCDFReader; } });
+var netcdf_loader_1 = require("./netcdf-loader");
+Object.defineProperty(exports, "NetCDFLoader", { enumerable: true, get: function () { return netcdf_loader_1.NetCDFLoader; } });

package/dist/iobuffer/iobuffer.d.ts

@@ -0,0 +1,254 @@
+/// <reference types="node" />
+declare type InputData = number | ArrayBufferLike | ArrayBufferView | IOBuffer | Buffer;
+interface IOBufferOptions {
+    /**
+     * Ignore the first n bytes of the ArrayBuffer.
+     */
+    offset?: number;
+}
+export declare class IOBuffer {
+    /**
+     * Reference to the internal ArrayBuffer object.
+     */
+    buffer: ArrayBufferLike;
+    /**
+     * Byte length of the internal ArrayBuffer.
+     */
+    byteLength: number;
+    /**
+     * Byte offset of the internal ArrayBuffer.
+     */
+    byteOffset: number;
+    /**
+     * Byte length of the internal ArrayBuffer.
+     */
+    length: number;
+    /**
+     * The current offset of the buffer's pointer.
+     */
+    offset: number;
+    private lastWrittenByte;
+    private littleEndian;
+    private _data;
+    private _mark;
+    private _marks;
+    private textDecoder;
+    private textEncoder;
+    /**
+     * @param data - The data to construct the IOBuffer with.
+     * If data is a number, it will be the new buffer's length<br>
+     * If data is `undefined`, the buffer will be initialized with a default length of 8Kb<br>
+     * If data is an ArrayBuffer, SharedArrayBuffer, an ArrayBufferView (Typed Array), an IOBuffer instance,
+     * or a Node.js Buffer, a view will be created over the underlying ArrayBuffer.
+     * @param options
+     */
+    constructor(data?: InputData, options?: IOBufferOptions);
+    /**
+     * Checks if the memory allocated to the buffer is sufficient to store more
+     * bytes after the offset.
+     * @param byteLength - The needed memory in bytes.
+     * @returns `true` if there is sufficient space and `false` otherwise.
+     */
+    available(byteLength?: number): boolean;
+    /**
+     * Check if little-endian mode is used for reading and writing multi-byte
+     * values.
+     * @returns `true` if little-endian mode is used, `false` otherwise.
+     */
+    isLittleEndian(): boolean;
+    /**
+     * Set little-endian mode for reading and writing multi-byte values.
+     */
+    setLittleEndian(): this;
+    /**
+     * Check if big-endian mode is used for reading and writing multi-byte values.
+     * @returns `true` if big-endian mode is used, `false` otherwise.
+     */
+    isBigEndian(): boolean;
+    /**
+     * Switches to big-endian mode for reading and writing multi-byte values.
+     */
+    setBigEndian(): this;
+    /**
+     * Move the pointer n bytes forward.
+     * @param n - Number of bytes to skip.
+     */
+    skip(n?: number): this;
+    /**
+     * Move the pointer to the given offset.
+     * @param offset
+     */
+    seek(offset: number): this;
+    /**
+     * Store the current pointer offset.
+     * @see {@link IOBuffer#reset}
+     */
+    mark(): this;
+    /**
+     * Move the pointer back to the last pointer offset set by mark.
+     * @see {@link IOBuffer#mark}
+     */
+    reset(): this;
+    /**
+     * Push the current pointer offset to the mark stack.
+     * @see {@link IOBuffer#popMark}
+     */
+    pushMark(): this;
+    /**
+     * Pop the last pointer offset from the mark stack, and set the current
+     * pointer offset to the popped value.
+     * @see {@link IOBuffer#pushMark}
+     */
+    popMark(): this;
+    /**
+     * Move the pointer offset back to 0.
+     */
+    rewind(): this;
+    /**
+     * Make sure the buffer has sufficient memory to write a given byteLength at
+     * the current pointer offset.
+     * If the buffer's memory is insufficient, this method will create a new
+     * buffer (a copy) with a length that is twice (byteLength + current offset).
+     * @param byteLength
+     */
+    ensureAvailable(byteLength?: number): this;
+    /**
+     * Read a byte and return false if the byte's value is 0, or true otherwise.
+     * Moves pointer forward by one byte.
+     */
+    readBoolean(): boolean;
+    /**
+     * Read a signed 8-bit integer and move pointer forward by 1 byte.
+     */
+    readInt8(): number;
+    /**
+     * Read an unsigned 8-bit integer and move pointer forward by 1 byte.
+     */
+    readUint8(): number;
+    /**
+     * Alias for {@link IOBuffer#readUint8}.
+     */
+    readByte(): number;
+    /**
+     * Read `n` bytes and move pointer forward by `n` bytes.
+     */
+    readBytes(n?: number): Uint8Array;
+    /**
+     * Read a 16-bit signed integer and move pointer forward by 2 bytes.
+     */
+    readInt16(): number;
+    /**
+     * Read a 16-bit unsigned integer and move pointer forward by 2 bytes.
+     */
+    readUint16(): number;
+    /**
+     * Read a 32-bit signed integer and move pointer forward by 4 bytes.
+     */
+    readInt32(): number;
+    /**
+     * Read a 32-bit unsigned integer and move pointer forward by 4 bytes.
+     */
+    readUint32(): number;
+    /**
+     * Read a 32-bit floating number and move pointer forward by 4 bytes.
+     */
+    readFloat32(): number;
+    /**
+     * Read a 64-bit floating number and move pointer forward by 8 bytes.
+     */
+    readFloat64(): number;
+    /**
+     * Read a 1-byte ASCII character and move pointer forward by 1 byte.
+     */
+    readChar(): string;
+    /**
+     * Read `n` 1-byte ASCII characters and move pointer forward by `n` bytes.
+     */
+    readChars(n?: number): string;
+    /**
+     * Read the next `n` bytes, return a UTF-8 decoded string and move pointer
+     * forward by `n` bytes.
+     */
+    readUtf8(n?: number): string;
+    /**
+     * Write 0xff if the passed value is truthy, 0x00 otherwise and move pointer
+     * forward by 1 byte.
+     */
+    writeBoolean(value: unknown): this;
+    /**
+     * Write `value` as an 8-bit signed integer and move pointer forward by 1 byte.
+     */
+    writeInt8(value: number): this;
+    /**
+     * Write `value` as an 8-bit unsigned integer and move pointer forward by 1
+     * byte.
+     */
+    writeUint8(value: number): this;
+    /**
+     * An alias for {@link IOBuffer#writeUint8}.
+     */
+    writeByte(value: number): this;
+    /**
+     * Write all elements of `bytes` as uint8 values and move pointer forward by
+     * `bytes.length` bytes.
+     */
+    writeBytes(bytes: ArrayLike<number>): this;
+    /**
+     * Write `value` as a 16-bit signed integer and move pointer forward by 2
+     * bytes.
+     */
+    writeInt16(value: number): this;
+    /**
+     * Write `value` as a 16-bit unsigned integer and move pointer forward by 2
+     * bytes.
+     */
+    writeUint16(value: number): this;
+    /**
+     * Write `value` as a 32-bit signed integer and move pointer forward by 4
+     * bytes.
+     */
+    writeInt32(value: number): this;
+    /**
+     * Write `value` as a 32-bit unsigned integer and move pointer forward by 4
+     * bytes.
+     */
+    writeUint32(value: number): this;
+    /**
+     * Write `value` as a 32-bit floating number and move pointer forward by 4
+     * bytes.
+     */
+    writeFloat32(value: number): this;
+    /**
+     * Write `value` as a 64-bit floating number and move pointer forward by 8
+     * bytes.
+     */
+    writeFloat64(value: number): this;
+    /**
+     * Write the charCode of `str`'s first character as an 8-bit unsigned integer
+     * and move pointer forward by 1 byte.
+     */
+    writeChar(str: string): this;
+    /**
+     * Write the charCodes of all `str`'s characters as 8-bit unsigned integers
+     * and move pointer forward by `str.length` bytes.
+     */
+    writeChars(str: string): this;
+    /**
+     * UTF-8 encode and write `str` to the current pointer offset and move pointer
+     * forward according to the encoded length.
+     */
+    writeUtf8(str: string): this;
+    /**
+     * Export a Uint8Array view of the internal buffer.
+     * The view starts at the byte offset and its length
+     * is calculated to stop at the last written byte or the original length.
+     */
+    toArray(): Uint8Array;
+    /**
+     * Update the last written byte offset
+     * @private
+     */
+    private _updateLastWrittenByte;
+}
+export {};
+//# sourceMappingURL=iobuffer.d.ts.map

package/dist/iobuffer/iobuffer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iobuffer.d.ts","sourceRoot":"","sources":["../../src/iobuffer/iobuffer.ts"],"names":[],"mappings":";AAEA,aAAK,SAAS,GAAG,MAAM,GAAG,eAAe,GAAG,eAAe,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEhF,UAAU,eAAe;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,QAAQ;IACnB;;OAEG;IACI,MAAM,EAAE,eAAe,CAAC;IAE/B;;OAEG;IACI,UAAU,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACI,UAAU,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACI,MAAM,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,YAAY,CAAU;IAE9B,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,MAAM,CAAW;IAEzB,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,WAAW,CAAqB;IAExC;;;;;;;OAOG;gBACgB,IAAI,GAAE,SAA+B,EAAE,OAAO,GAAE,eAAoB;IAkCvF;;;;;OAKG;IACI,SAAS,CAAC,UAAU,SAAI,GAAG,OAAO;IAIzC;;;;OAIG;IACI,cAAc,IAAI,OAAO;IAIhC;;OAEG;IACI,eAAe,IAAI,IAAI;IAK9B;;;OAGG;IACI,WAAW,IAAI,OAAO;IAI7B;;OAEG;IACI,YAAY,IAAI,IAAI;IAK3B;;;OAGG;IACI,IAAI,CAAC,CAAC,SAAI,GAAG,IAAI;IAKxB;;;OAGG;IACI,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKjC;;;OAGG;IACI,IAAI,IAAI,IAAI;IAKnB;;;OAGG;IACI,KAAK,IAAI,IAAI;IAKpB;;;OAGG;IACI,QAAQ,IAAI,IAAI;IAKvB;;;;OAIG;IACI,OAAO,IAAI,IAAI;IAStB;;OAEG;IACI,MAAM,IAAI,IAAI;IAKrB;;;;;;OAMG;IACI,eAAe,CAAC,UAAU,SAAI,GAAG,IAAI;IAa5C;;;OAGG;IACI,WAAW,IAAI,OAAO;IAI7B;;OAEG;IACI,QAAQ,IAAI,MAAM;IAIzB;;OAEG;IACI,SAAS,IAAI,MAAM;IAI1B;;OAEG;IACI,QAAQ,IAAI,MAAM;IAIzB;;OAEG;IACI,SAAS,CAAC,CAAC,SAAI,GAAG,UAAU;IAQnC;;OAEG;IACI,SAAS,IAAI,MAAM;IAM1B;;OAEG;IACI,UAAU,IAAI,MAAM;IAM3B;;OAEG;IACI,SAAS,IAAI,MAAM;IAM1B;;OAEG;IACI,UAAU,IAAI,MAAM;IAM3B;;OAEG;IACI,WAAW,IAAI,MAAM;IAM5B;;OAEG;IACI,WAAW,IAAI,MAAM;IAM5B;;OAEG;IACI,QAAQ,IAAI,MAAM;IAIzB;;OAEG;IACI,SAAS,CAAC,CAAC,SAAI,GAAG,MAAM;IAQ/B;;;OAGG;IACI,QAAQ,CAAC,CAAC,SAAI,GAAG,MAAM;IAI9B;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAKzC;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOrC;;;OAGG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOtC;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIrC;;;OAGG;IACI,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI;IASjD;;;OAGG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQtC;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQvC;;;OAGG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQtC;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQxC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQxC;;;OAGG;IACI,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAInC;;;OAGG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAOpC;;;OAGG;IACI,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKnC;;;;OAIG;IACI,OAAO,IAAI,UAAU;IAI5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;CAK/B"}