@loaders.gl/netcdf 4.2.0-alpha.4 → 4.2.0-alpha.6

package/dist/iobuffer/iobuffer.js

@@ -1,269 +1,448 @@
 const DEFAULT_BYTE_LENGTH = 1024 * 8;
 export class IOBuffer {
-  constructor() {
-    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_BYTE_LENGTH;
-    let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    this.buffer = void 0;
-    this.byteLength = void 0;
-    this.byteOffset = void 0;
-    this.length = void 0;
-    this.offset = void 0;
-    this.lastWrittenByte = void 0;
-    this.littleEndian = void 0;
-    this._data = void 0;
-    this._mark = void 0;
-    this._marks = void 0;
-    this.textDecoder = new TextDecoder();
-    this.textEncoder = new TextEncoder();
-    let dataIsGiven = false;
-    if (typeof data === 'number') {
-      data = new ArrayBuffer(data);
-    } else {
-      dataIsGiven = true;
-      this.lastWrittenByte = data.byteLength;
-    }
-    const offset = options.offset ? options.offset >>> 0 : 0;
-    const byteLength = data.byteLength - offset;
-    let dvOffset = offset;
-    if (ArrayBuffer.isView(data) || data instanceof IOBuffer) {
-      if (data.byteLength !== data.buffer.byteLength) {
-        dvOffset = data.byteOffset + offset;
-      }
-      data = data.buffer;
-    }
-    if (dataIsGiven) {
-      this.lastWrittenByte = byteLength;
-    } else {
-      this.lastWrittenByte = 0;
-    }
-    this.buffer = data;
-    this.length = byteLength;
-    this.byteLength = byteLength;
-    this.byteOffset = dvOffset;
-    this.offset = 0;
-    this.littleEndian = true;
-    this._data = new DataView(this.buffer, dvOffset, byteLength);
-    this._mark = 0;
-    this._marks = [];
-  }
-  available() {
-    let byteLength = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
-    return this.offset + byteLength <= this.length;
-  }
-  isLittleEndian() {
-    return this.littleEndian;
-  }
-  setLittleEndian() {
-    this.littleEndian = true;
-    return this;
-  }
-  isBigEndian() {
-    return !this.littleEndian;
-  }
-  setBigEndian() {
-    this.littleEndian = false;
-    return this;
-  }
-  skip() {
-    let n = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
-    this.offset += n;
-    return this;
-  }
-  seek(offset) {
-    this.offset = offset;
-    return this;
-  }
-  mark() {
-    this._mark = this.offset;
-    return this;
-  }
-  reset() {
-    this.offset = this._mark;
-    return this;
-  }
-  pushMark() {
-    this._marks.push(this.offset);
-    return this;
-  }
-  popMark() {
-    const offset = this._marks.pop();
-    if (offset === undefined) {
-      throw new Error('Mark stack empty');
-    }
-    this.seek(offset);
-    return this;
-  }
-  rewind() {
-    this.offset = 0;
-    return this;
-  }
-  ensureAvailable() {
-    let byteLength = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
-    if (!this.available(byteLength)) {
-      const lengthNeeded = this.offset + byteLength;
-      const newLength = lengthNeeded * 2;
-      const newArray = new Uint8Array(newLength);
-      newArray.set(new Uint8Array(this.buffer));
-      this.buffer = newArray.buffer;
-      this.length = this.byteLength = newLength;
-      this._data = new DataView(this.buffer);
-    }
-    return this;
-  }
-  readBoolean() {
-    return this.readUint8() !== 0;
-  }
-  readInt8() {
-    return this._data.getInt8(this.offset++);
-  }
-  readUint8() {
-    return this._data.getUint8(this.offset++);
-  }
-  readByte() {
-    return this.readUint8();
-  }
-  readBytes() {
-    let n = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
-    const bytes = new Uint8Array(n);
-    for (let i = 0; i < n; i++) {
-      bytes[i] = this.readByte();
-    }
-    return bytes;
-  }
-  readInt16() {
-    const value = this._data.getInt16(this.offset, this.littleEndian);
-    this.offset += 2;
-    return value;
-  }
-  readUint16() {
-    const value = this._data.getUint16(this.offset, this.littleEndian);
-    this.offset += 2;
-    return value;
-  }
-  readInt32() {
-    const value = this._data.getInt32(this.offset, this.littleEndian);
-    this.offset += 4;
-    return value;
-  }
-  readUint32() {
-    const value = this._data.getUint32(this.offset, this.littleEndian);
-    this.offset += 4;
-    return value;
-  }
-  readFloat32() {
-    const value = this._data.getFloat32(this.offset, this.littleEndian);
-    this.offset += 4;
-    return value;
-  }
-  readFloat64() {
-    const value = this._data.getFloat64(this.offset, this.littleEndian);
-    this.offset += 8;
-    return value;
-  }
-  readChar() {
-    return String.fromCharCode(this.readInt8());
-  }
-  readChars() {
-    let n = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
-    let result = '';
-    for (let i = 0; i < n; i++) {
-      result += this.readChar();
-    }
-    return result;
-  }
-  readUtf8() {
-    let n = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
-    return this.textDecoder.decode(this.readBytes(n));
-  }
-  writeBoolean(value) {
-    this.writeUint8(value ? 0xff : 0x00);
-    return this;
-  }
-  writeInt8(value) {
-    this.ensureAvailable(1);
-    this._data.setInt8(this.offset++, value);
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeUint8(value) {
-    this.ensureAvailable(1);
-    this._data.setUint8(this.offset++, value);
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeByte(value) {
-    return this.writeUint8(value);
-  }
-  writeBytes(bytes) {
-    this.ensureAvailable(bytes.length);
-    for (let i = 0; i < bytes.length; i++) {
-      this._data.setUint8(this.offset++, bytes[i]);
-    }
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeInt16(value) {
-    this.ensureAvailable(2);
-    this._data.setInt16(this.offset, value, this.littleEndian);
-    this.offset += 2;
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeUint16(value) {
-    this.ensureAvailable(2);
-    this._data.setUint16(this.offset, value, this.littleEndian);
-    this.offset += 2;
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeInt32(value) {
-    this.ensureAvailable(4);
-    this._data.setInt32(this.offset, value, this.littleEndian);
-    this.offset += 4;
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeUint32(value) {
-    this.ensureAvailable(4);
-    this._data.setUint32(this.offset, value, this.littleEndian);
-    this.offset += 4;
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeFloat32(value) {
-    this.ensureAvailable(4);
-    this._data.setFloat32(this.offset, value, this.littleEndian);
-    this.offset += 4;
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeFloat64(value) {
-    this.ensureAvailable(8);
-    this._data.setFloat64(this.offset, value, this.littleEndian);
-    this.offset += 8;
-    this._updateLastWrittenByte();
-    return this;
-  }
-  writeChar(str) {
-    return this.writeUint8(str.charCodeAt(0));
-  }
-  writeChars(str) {
-    for (let i = 0; i < str.length; i++) {
-      this.writeUint8(str.charCodeAt(i));
-    }
-    return this;
-  }
-  writeUtf8(str) {
-    const bytes = this.textEncoder.encode(str);
-    return this.writeBytes(bytes);
-  }
-  toArray() {
-    return new Uint8Array(this.buffer, this.byteOffset, this.lastWrittenByte);
-  }
-  _updateLastWrittenByte() {
-    if (this.offset > this.lastWrittenByte) {
-      this.lastWrittenByte = this.offset;
-    }
-  }
+    /**
+     * Reference to the internal ArrayBuffer object.
+     */
+    buffer;
+    /**
+     * Byte length of the internal ArrayBuffer.
+     */
+    byteLength;
+    /**
+     * Byte offset of the internal ArrayBuffer.
+     */
+    byteOffset;
+    /**
+     * Byte length of the internal ArrayBuffer.
+     */
+    length;
+    /**
+     * The current offset of the buffer's pointer.
+     */
+    offset;
+    lastWrittenByte;
+    littleEndian;
+    _data;
+    _mark;
+    _marks;
+    textDecoder = new TextDecoder();
+    textEncoder = new 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 = DEFAULT_BYTE_LENGTH, options = {}) {
+        let dataIsGiven = false;
+        if (typeof data === 'number') {
+            data = new ArrayBuffer(data);
+        }
+        else {
+            dataIsGiven = true;
+            this.lastWrittenByte = data.byteLength;
+        }
+        const offset = options.offset ? options.offset >>> 0 : 0;
+        const byteLength = data.byteLength - offset;
+        let dvOffset = offset;
+        if (ArrayBuffer.isView(data) || data instanceof IOBuffer) {
+            if (data.byteLength !== data.buffer.byteLength) {
+                dvOffset = data.byteOffset + offset;
+            }
+            data = data.buffer;
+        }
+        if (dataIsGiven) {
+            this.lastWrittenByte = byteLength;
+        }
+        else {
+            this.lastWrittenByte = 0;
+        }
+        this.buffer = data;
+        this.length = byteLength;
+        this.byteLength = byteLength;
+        this.byteOffset = dvOffset;
+        this.offset = 0;
+        this.littleEndian = true;
+        this._data = new DataView(this.buffer, dvOffset, byteLength);
+        this._mark = 0;
+        this._marks = [];
+    }
+    /**
+     * 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 = 1) {
+        return this.offset + byteLength <= this.length;
+    }
+    /**
+     * 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() {
+        return this.littleEndian;
+    }
+    /**
+     * Set little-endian mode for reading and writing multi-byte values.
+     */
+    setLittleEndian() {
+        this.littleEndian = true;
+        return 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() {
+        return !this.littleEndian;
+    }
+    /**
+     * Switches to big-endian mode for reading and writing multi-byte values.
+     */
+    setBigEndian() {
+        this.littleEndian = false;
+        return this;
+    }
+    /**
+     * Move the pointer n bytes forward.
+     * @param n - Number of bytes to skip.
+     */
+    skip(n = 1) {
+        this.offset += n;
+        return this;
+    }
+    /**
+     * Move the pointer to the given offset.
+     * @param offset
+     */
+    seek(offset) {
+        this.offset = offset;
+        return this;
+    }
+    /**
+     * Store the current pointer offset.
+     * @see {@link IOBuffer#reset}
+     */
+    mark() {
+        this._mark = this.offset;
+        return this;
+    }
+    /**
+     * Move the pointer back to the last pointer offset set by mark.
+     * @see {@link IOBuffer#mark}
+     */
+    reset() {
+        this.offset = this._mark;
+        return this;
+    }
+    /**
+     * Push the current pointer offset to the mark stack.
+     * @see {@link IOBuffer#popMark}
+     */
+    pushMark() {
+        this._marks.push(this.offset);
+        return 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() {
+        const offset = this._marks.pop();
+        if (offset === undefined) {
+            throw new Error('Mark stack empty');
+        }
+        this.seek(offset);
+        return this;
+    }
+    /**
+     * Move the pointer offset back to 0.
+     */
+    rewind() {
+        this.offset = 0;
+        return 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 = 1) {
+        if (!this.available(byteLength)) {
+            const lengthNeeded = this.offset + byteLength;
+            const newLength = lengthNeeded * 2;
+            const newArray = new Uint8Array(newLength);
+            newArray.set(new Uint8Array(this.buffer));
+            this.buffer = newArray.buffer;
+            this.length = this.byteLength = newLength;
+            this._data = new DataView(this.buffer);
+        }
+        return this;
+    }
+    /**
+     * Read a byte and return false if the byte's value is 0, or true otherwise.
+     * Moves pointer forward by one byte.
+     */
+    readBoolean() {
+        return this.readUint8() !== 0;
+    }
+    /**
+     * Read a signed 8-bit integer and move pointer forward by 1 byte.
+     */
+    readInt8() {
+        return this._data.getInt8(this.offset++);
+    }
+    /**
+     * Read an unsigned 8-bit integer and move pointer forward by 1 byte.
+     */
+    readUint8() {
+        return this._data.getUint8(this.offset++);
+    }
+    /**
+     * Alias for {@link IOBuffer#readUint8}.
+     */
+    readByte() {
+        return this.readUint8();
+    }
+    /**
+     * Read `n` bytes and move pointer forward by `n` bytes.
+     */
+    readBytes(n = 1) {
+        const bytes = new Uint8Array(n);
+        for (let i = 0; i < n; i++) {
+            bytes[i] = this.readByte();
+        }
+        return bytes;
+    }
+    /**
+     * Read a 16-bit signed integer and move pointer forward by 2 bytes.
+     */
+    readInt16() {
+        const value = this._data.getInt16(this.offset, this.littleEndian);
+        this.offset += 2;
+        return value;
+    }
+    /**
+     * Read a 16-bit unsigned integer and move pointer forward by 2 bytes.
+     */
+    readUint16() {
+        const value = this._data.getUint16(this.offset, this.littleEndian);
+        this.offset += 2;
+        return value;
+    }
+    /**
+     * Read a 32-bit signed integer and move pointer forward by 4 bytes.
+     */
+    readInt32() {
+        const value = this._data.getInt32(this.offset, this.littleEndian);
+        this.offset += 4;
+        return value;
+    }
+    /**
+     * Read a 32-bit unsigned integer and move pointer forward by 4 bytes.
+     */
+    readUint32() {
+        const value = this._data.getUint32(this.offset, this.littleEndian);
+        this.offset += 4;
+        return value;
+    }
+    /**
+     * Read a 32-bit floating number and move pointer forward by 4 bytes.
+     */
+    readFloat32() {
+        const value = this._data.getFloat32(this.offset, this.littleEndian);
+        this.offset += 4;
+        return value;
+    }
+    /**
+     * Read a 64-bit floating number and move pointer forward by 8 bytes.
+     */
+    readFloat64() {
+        const value = this._data.getFloat64(this.offset, this.littleEndian);
+        this.offset += 8;
+        return value;
+    }
+    /**
+     * Read a 1-byte ASCII character and move pointer forward by 1 byte.
+     */
+    readChar() {
+        return String.fromCharCode(this.readInt8());
+    }
+    /**
+     * Read `n` 1-byte ASCII characters and move pointer forward by `n` bytes.
+     */
+    readChars(n = 1) {
+        let result = '';
+        for (let i = 0; i < n; i++) {
+            result += this.readChar();
+        }
+        return result;
+    }
+    /**
+     * Read the next `n` bytes, return a UTF-8 decoded string and move pointer
+     * forward by `n` bytes.
+     */
+    readUtf8(n = 1) {
+        return this.textDecoder.decode(this.readBytes(n));
+    }
+    /**
+     * Write 0xff if the passed value is truthy, 0x00 otherwise and move pointer
+     * forward by 1 byte.
+     */
+    writeBoolean(value) {
+        this.writeUint8(value ? 0xff : 0x00);
+        return this;
+    }
+    /**
+     * Write `value` as an 8-bit signed integer and move pointer forward by 1 byte.
+     */
+    writeInt8(value) {
+        this.ensureAvailable(1);
+        this._data.setInt8(this.offset++, value);
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * Write `value` as an 8-bit unsigned integer and move pointer forward by 1
+     * byte.
+     */
+    writeUint8(value) {
+        this.ensureAvailable(1);
+        this._data.setUint8(this.offset++, value);
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * An alias for {@link IOBuffer#writeUint8}.
+     */
+    writeByte(value) {
+        return this.writeUint8(value);
+    }
+    /**
+     * Write all elements of `bytes` as uint8 values and move pointer forward by
+     * `bytes.length` bytes.
+     */
+    writeBytes(bytes) {
+        this.ensureAvailable(bytes.length);
+        for (let i = 0; i < bytes.length; i++) {
+            this._data.setUint8(this.offset++, bytes[i]);
+        }
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * Write `value` as a 16-bit signed integer and move pointer forward by 2
+     * bytes.
+     */
+    writeInt16(value) {
+        this.ensureAvailable(2);
+        this._data.setInt16(this.offset, value, this.littleEndian);
+        this.offset += 2;
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * Write `value` as a 16-bit unsigned integer and move pointer forward by 2
+     * bytes.
+     */
+    writeUint16(value) {
+        this.ensureAvailable(2);
+        this._data.setUint16(this.offset, value, this.littleEndian);
+        this.offset += 2;
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * Write `value` as a 32-bit signed integer and move pointer forward by 4
+     * bytes.
+     */
+    writeInt32(value) {
+        this.ensureAvailable(4);
+        this._data.setInt32(this.offset, value, this.littleEndian);
+        this.offset += 4;
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * Write `value` as a 32-bit unsigned integer and move pointer forward by 4
+     * bytes.
+     */
+    writeUint32(value) {
+        this.ensureAvailable(4);
+        this._data.setUint32(this.offset, value, this.littleEndian);
+        this.offset += 4;
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * Write `value` as a 32-bit floating number and move pointer forward by 4
+     * bytes.
+     */
+    writeFloat32(value) {
+        this.ensureAvailable(4);
+        this._data.setFloat32(this.offset, value, this.littleEndian);
+        this.offset += 4;
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * Write `value` as a 64-bit floating number and move pointer forward by 8
+     * bytes.
+     */
+    writeFloat64(value) {
+        this.ensureAvailable(8);
+        this._data.setFloat64(this.offset, value, this.littleEndian);
+        this.offset += 8;
+        this._updateLastWrittenByte();
+        return this;
+    }
+    /**
+     * Write the charCode of `str`'s first character as an 8-bit unsigned integer
+     * and move pointer forward by 1 byte.
+     */
+    writeChar(str) {
+        return this.writeUint8(str.charCodeAt(0));
+    }
+    /**
+     * Write the charCodes of all `str`'s characters as 8-bit unsigned integers
+     * and move pointer forward by `str.length` bytes.
+     */
+    writeChars(str) {
+        for (let i = 0; i < str.length; i++) {
+            this.writeUint8(str.charCodeAt(i));
+        }
+        return this;
+    }
+    /**
+     * UTF-8 encode and write `str` to the current pointer offset and move pointer
+     * forward according to the encoded length.
+     */
+    writeUtf8(str) {
+        const bytes = this.textEncoder.encode(str);
+        return this.writeBytes(bytes);
+    }
+    /**
+     * 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() {
+        return new Uint8Array(this.buffer, this.byteOffset, this.lastWrittenByte);
+    }
+    /**
+     * Update the last written byte offset
+     * @private
+     */
+    _updateLastWrittenByte() {
+        if (this.offset > this.lastWrittenByte) {
+            this.lastWrittenByte = this.offset;
+        }
+    }
 }
-//# sourceMappingURL=iobuffer.js.map