bson 4.0.4 → 4.2.2

package/lib/uuid.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseUUID = void 0;
+/**
+ * UUID regular expression pattern copied from `uuid` npm module.
+ * @see https://github.com/uuidjs/uuid/blob/master/src/regex.js
+ */
+const UUID_RX = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i;
+/**
+ * Parser function copied from `uuid` npm module.
+ * @see https://github.com/uuidjs/uuid/blob/master/src/parse.js
+ * @internal
+ */
+function parseUUID(uuid) {
+    if (typeof uuid !== 'string') {
+        throw new TypeError('Invalid type for UUID, expected string but got ' + typeof uuid);
+    }
+    if (!UUID_RX.test(uuid)) {
+        throw new TypeError('Invalid format for UUID: ' + uuid);
+    }
+    let v;
+    const arr = new Uint8Array(16);
+    // Parse ########-....-....-....-............
+    arr[0] = (v = parseInt(uuid.slice(0, 8), 16)) >>> 24;
+    arr[1] = (v >>> 16) & 0xff;
+    arr[2] = (v >>> 8) & 0xff;
+    arr[3] = v & 0xff;
+    // Parse ........-####-....-....-............
+    arr[4] = (v = parseInt(uuid.slice(9, 13), 16)) >>> 8;
+    arr[5] = v & 0xff;
+    // Parse ........-....-####-....-............
+    arr[6] = (v = parseInt(uuid.slice(14, 18), 16)) >>> 8;
+    arr[7] = v & 0xff;
+    // Parse ........-....-....-####-............
+    arr[8] = (v = parseInt(uuid.slice(19, 23), 16)) >>> 8;
+    arr[9] = v & 0xff;
+    // Parse ........-....-....-....-############
+    // (Use "/" to avoid 32-bit truncation when bit-shifting high-order bytes)
+    arr[10] = ((v = parseInt(uuid.slice(24, 36), 16)) / 0x10000000000) & 0xff;
+    arr[11] = (v / 0x100000000) & 0xff;
+    arr[12] = (v >>> 24) & 0xff;
+    arr[13] = (v >>> 16) & 0xff;
+    arr[14] = (v >>> 8) & 0xff;
+    arr[15] = v & 0xff;
+    return arr;
+}
+exports.parseUUID = parseUUID;
+//# sourceMappingURL=uuid.js.map

package/lib/uuid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.js","sourceRoot":"","sources":["../src/uuid.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAM,OAAO,GAAG,qHAAqH,CAAC;AAOtI;;;;GAIG;AACH,SAAgB,SAAS,CAAC,IAAY;IACpC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,MAAM,IAAI,SAAS,CAAC,iDAAiD,GAAG,OAAO,IAAI,CAAC,CAAC;KACtF;IAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACvB,MAAM,IAAI,SAAS,CAAC,2BAA2B,GAAG,IAAI,CAAC,CAAC;KACzD;IAED,IAAI,CAAC,CAAC;IACN,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAE/B,6CAA6C;IAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;IACrD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC1B,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAElB,6CAA6C;IAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACrD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAElB,6CAA6C;IAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACtD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAElB,6CAA6C;IAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACtD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAElB,6CAA6C;IAC7C,0EAA0E;IAC1E,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,aAAa,CAAC,GAAG,IAAI,CAAC;IAC1E,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,IAAI,CAAC;IACnC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAC5B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAC5B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC3B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAEnB,OAAO,GAAG,CAAC;AACb,CAAC;AAxCD,8BAwCC"}

package/lib/validate_utf8.js

@@ -1,48 +1,47 @@
-'use strict';
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUtf8 = void 0;
 const FIRST_BIT = 0x80;
 const FIRST_TWO_BITS = 0xc0;
 const FIRST_THREE_BITS = 0xe0;
 const FIRST_FOUR_BITS = 0xf0;
 const FIRST_FIVE_BITS = 0xf8;
-
 const TWO_BIT_CHAR = 0xc0;
 const THREE_BIT_CHAR = 0xe0;
 const FOUR_BIT_CHAR = 0xf0;
 const CONTINUING_CHAR = 0x80;
-
 /**
  * Determines if the passed in bytes are valid utf8
- * @param {Buffer|Uint8Array} bytes An array of 8-bit bytes. Must be indexable and have length property
- * @param {Number} start The index to start validating
- * @param {Number} end The index to end validating
- * @returns {boolean} True if valid utf8
+ * @param bytes - An array of 8-bit bytes. Must be indexable and have length property
+ * @param start - The index to start validating
+ * @param end - The index to end validating
  */
 function validateUtf8(bytes, start, end) {
-  let continuation = 0;
-
-  for (let i = start; i < end; i += 1) {
-    const byte = bytes[i];
-
-    if (continuation) {
-      if ((byte & FIRST_TWO_BITS) !== CONTINUING_CHAR) {
-        return false;
-      }
-      continuation -= 1;
-    } else if (byte & FIRST_BIT) {
-      if ((byte & FIRST_THREE_BITS) === TWO_BIT_CHAR) {
-        continuation = 1;
-      } else if ((byte & FIRST_FOUR_BITS) === THREE_BIT_CHAR) {
-        continuation = 2;
-      } else if ((byte & FIRST_FIVE_BITS) === FOUR_BIT_CHAR) {
-        continuation = 3;
-      } else {
-        return false;
-      }
+    let continuation = 0;
+    for (let i = start; i < end; i += 1) {
+        const byte = bytes[i];
+        if (continuation) {
+            if ((byte & FIRST_TWO_BITS) !== CONTINUING_CHAR) {
+                return false;
+            }
+            continuation -= 1;
+        }
+        else if (byte & FIRST_BIT) {
+            if ((byte & FIRST_THREE_BITS) === TWO_BIT_CHAR) {
+                continuation = 1;
+            }
+            else if ((byte & FIRST_FOUR_BITS) === THREE_BIT_CHAR) {
+                continuation = 2;
+            }
+            else if ((byte & FIRST_FIVE_BITS) === FOUR_BIT_CHAR) {
+                continuation = 3;
+            }
+            else {
+                return false;
+            }
+        }
     }
-  }
-
-  return !continuation;
+    return !continuation;
 }
-
-module.exports.validateUtf8 = validateUtf8;
+exports.validateUtf8 = validateUtf8;
+//# sourceMappingURL=validate_utf8.js.map

package/lib/validate_utf8.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate_utf8.js","sourceRoot":"","sources":["../src/validate_utf8.ts"],"names":[],"mappings":";;;AAAA,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,MAAM,eAAe,GAAG,IAAI,CAAC;AAE7B,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,aAAa,GAAG,IAAI,CAAC;AAC3B,MAAM,eAAe,GAAG,IAAI,CAAC;AAE7B;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,KAAkC,EAClC,KAAa,EACb,GAAW;IAEX,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE;QACnC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEtB,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,eAAe,EAAE;gBAC/C,OAAO,KAAK,CAAC;aACd;YACD,YAAY,IAAI,CAAC,CAAC;SACnB;aAAM,IAAI,IAAI,GAAG,SAAS,EAAE;YAC3B,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC,KAAK,YAAY,EAAE;gBAC9C,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,KAAK,cAAc,EAAE;gBACtD,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,KAAK,aAAa,EAAE;gBACrD,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM;gBACL,OAAO,KAAK,CAAC;aACd;SACF;KACF;IAED,OAAO,CAAC,YAAY,CAAC;AACvB,CAAC;AA7BD,oCA6BC"}

package/package.json

@@ -8,10 +8,14 @@
   ],
   "files": [
     "lib",
+    "src",
     "dist",
+    "bson.d.ts",
+    "etc/prepare.js",
     "bower.json"
   ],
-  "version": "4.0.4",
+  "types": "bson.d.ts",
+  "version": "4.2.2",
   "author": "Christian Amor Kvalheim <christkv@gmail.com>",
   "license": "Apache-2.0",
   "contributors": [],
@@ -21,30 +25,45 @@
     "url": "https://github.com/mongodb/js-bson/issues"
   },
   "devDependencies": {
-    "@babel/core": "^7.1.5",
-    "@babel/preset-env": "^7.1.5",
+    "@babel/plugin-external-helpers": "^7.10.4",
+    "@babel/preset-env": "^7.11.0",
+    "@istanbuljs/nyc-config-typescript": "^1.0.1",
+    "@microsoft/api-extractor": "^7.11.2",
+    "@rollup/plugin-babel": "^5.2.0",
+    "@rollup/plugin-commonjs": "^15.0.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^9.0.0",
+    "@rollup/plugin-typescript": "^6.0.0",
+    "@typescript-eslint/eslint-plugin": "^3.10.1",
+    "@typescript-eslint/parser": "^3.10.1",
     "benchmark": "^2.1.4",
     "chai": "^4.2.0",
-    "dmd-clear": "^0.1.2",
-    "eslint": "^5.8.0",
-    "eslint-plugin-prettier": "^3.0.0",
-    "istanbul": "^0.4.5",
-    "jsdoc-to-markdown": "^4.0.1",
-    "karma": "^3.1.1",
-    "karma-chrome-launcher": "^2.2.0",
-    "karma-mocha": "^1.3.0",
+    "downlevel-dts": "^0.7.0",
+    "eslint": "^7.7.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "eslint-plugin-tsdoc": "^0.2.6",
+    "karma": "^5.1.1",
+    "karma-chai": "^0.1.0",
+    "karma-chrome-launcher": "^3.1.0",
+    "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
-    "karma-rollup-preprocessor": "^6.1.0",
-    "mocha": "^5.2.0",
-    "prettier": "^1.15.1",
-    "rollup": "^0.67.0",
-    "rollup-plugin-babel": "^4.0.3",
-    "rollup-plugin-commonjs": "^9.2.0",
-    "rollup-plugin-json": "^3.1.0",
+    "karma-rollup-preprocessor": "^7.0.5",
+    "mocha": "5.2.0",
+    "node-fetch": "^2.6.1",
+    "nyc": "^15.1.0",
+    "prettier": "^2.1.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.26.5",
+    "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-node-builtins": "^2.1.2",
     "rollup-plugin-node-globals": "^1.4.0",
-    "rollup-plugin-node-resolve": "^3.4.0",
-    "standard-version": "^4.4.0"
+    "rollup-plugin-node-polyfills": "^0.2.1",
+    "standard-version": "^8.0.1",
+    "ts-node": "^9.0.0",
+    "typedoc": "^0.18.0",
+    "typescript": "^4.0.2",
+    "typescript-cached-transpile": "0.0.6"
   },
   "config": {
     "native": false
@@ -59,19 +78,22 @@
     "node": ">=6.9.0"
   },
   "scripts": {
-    "docs": "jsdoc2md --heading-depth 3 --template tools/README.hbs --plugin dmd-clear --files lib/bson.js lib/extended_json.js > README.md",
-    "test": "npm run-script lint && npm run-script test-node && npm run-script test-browser",
-    "test-node": "node --throw-deprecation node_modules/.bin/_mocha ./test/node",
-    "test-browser": "npm run-script build && node --throw-deprecation node_modules/.bin/karma start",
-    "build": "rollup -c",
-    "lint": "eslint lib test",
-    "format": "prettier --print-width 100 --tab-width 2 --single-quote --write 'test/**/*.js' 'lib/**/*.js'",
-    "coverage": "istanbul cover _mocha -- --recursive --ui tdd test/node",
-    "prepublishOnly": "npm run build",
+    "docs": "typedoc",
+    "test": "npm run build && npm run test-node && npm run test-browser",
+    "test-node": "mocha test/node test/*_tests.js",
+    "test-browser": "karma start karma.conf.js",
+    "build:ts": "tsc",
+    "build:dts": "npm run build:ts && api-extractor run --typescript-compiler-folder node_modules/typescript --local && rimraf 'lib/**/*.d.ts*' && downlevel-dts bson.d.ts bson.d.ts",
+    "build:bundle": "rollup -c rollup.config.js",
+    "build": "npm run build:dts && npm run build:bundle",
+    "lint": "eslint -v && eslint --ext '.js,.ts' --max-warnings=0 src test && tsc -v && tsc --noEmit",
+    "format": "eslint --ext '.js,.ts' src test --fix",
+    "coverage": "nyc npm run test-node",
+    "coverage:html": "npm run coverage && open ./coverage/index.html",
+    "prepare": "node etc/prepare.js",
     "release": "standard-version -i HISTORY.md"
   },
   "dependencies": {
-    "buffer": "^5.1.0",
-    "long": "^4.0.0"
+    "buffer": "^5.6.0"
   }
 }

package/src/binary.ts

@@ -0,0 +1,270 @@
+import { Buffer } from 'buffer';
+import { ensureBuffer } from './ensure_buffer';
+import type { EJSONOptions } from './extended_json';
+import { parseUUID, UUIDExtended } from './uuid';
+
+/** @public */
+export type BinarySequence = Uint8Array | Buffer | number[];
+
+/** @public */
+export interface BinaryExtendedLegacy {
+  $type: string;
+  $binary: string;
+}
+
+/** @public */
+export interface BinaryExtended {
+  $binary: {
+    subType: string;
+    base64: string;
+  };
+}
+
+/**
+ * A class representation of the BSON Binary type.
+ * @public
+ */
+export class Binary {
+  _bsontype!: 'Binary';
+
+  /**
+   * Binary default subtype
+   * @internal
+   */
+  private static readonly BSON_BINARY_SUBTYPE_DEFAULT = 0;
+
+  /** Initial buffer default size */
+  static readonly BUFFER_SIZE = 256;
+  /** Default BSON type */
+  static readonly SUBTYPE_DEFAULT = 0;
+  /** Function BSON type */
+  static readonly SUBTYPE_FUNCTION = 1;
+  /** Byte Array BSON type */
+  static readonly SUBTYPE_BYTE_ARRAY = 2;
+  /** Deprecated UUID BSON type @deprecated Please use SUBTYPE_UUID */
+  static readonly SUBTYPE_UUID_OLD = 3;
+  /** UUID BSON type */
+  static readonly SUBTYPE_UUID = 4;
+  /** MD5 BSON type */
+  static readonly SUBTYPE_MD5 = 5;
+  /** User BSON type */
+  static readonly SUBTYPE_USER_DEFINED = 128;
+
+  buffer: Buffer;
+  sub_type: number;
+  position: number;
+
+  /**
+   * @param buffer - a buffer object containing the binary data.
+   * @param subType - the option binary type.
+   */
+  constructor(buffer?: string | BinarySequence, subType?: number) {
+    if (
+      !(buffer == null) &&
+      !(typeof buffer === 'string') &&
+      !ArrayBuffer.isView(buffer) &&
+      !(buffer instanceof ArrayBuffer) &&
+      !Array.isArray(buffer)
+    ) {
+      throw new TypeError(
+        'Binary can only be constructed from string, Buffer, TypedArray, or Array<number>'
+      );
+    }
+
+    this.sub_type = subType ?? Binary.BSON_BINARY_SUBTYPE_DEFAULT;
+
+    if (buffer == null) {
+      // create an empty binary buffer
+      this.buffer = Buffer.alloc(Binary.BUFFER_SIZE);
+      this.position = 0;
+    } else {
+      if (typeof buffer === 'string') {
+        // string
+        this.buffer = Buffer.from(buffer, 'binary');
+      } else if (Array.isArray(buffer)) {
+        // number[]
+        this.buffer = Buffer.from(buffer);
+      } else {
+        // Buffer | TypedArray | ArrayBuffer
+        this.buffer = ensureBuffer(buffer);
+      }
+
+      this.position = this.buffer.byteLength;
+    }
+  }
+
+  /**
+   * Updates this binary with byte_value.
+   *
+   * @param byteValue - a single byte we wish to write.
+   */
+  put(byteValue: string | number | Uint8Array | Buffer | number[]): void {
+    // If it's a string and a has more than one character throw an error
+    if (typeof byteValue === 'string' && byteValue.length !== 1) {
+      throw new TypeError('only accepts single character String');
+    } else if (typeof byteValue !== 'number' && byteValue.length !== 1)
+      throw new TypeError('only accepts single character Uint8Array or Array');
+
+    // Decode the byte value once
+    let decodedByte: number;
+    if (typeof byteValue === 'string') {
+      decodedByte = byteValue.charCodeAt(0);
+    } else if (typeof byteValue === 'number') {
+      decodedByte = byteValue;
+    } else {
+      decodedByte = byteValue[0];
+    }
+
+    if (decodedByte < 0 || decodedByte > 255) {
+      throw new TypeError('only accepts number in a valid unsigned byte range 0-255');
+    }
+
+    if (this.buffer.length > this.position) {
+      this.buffer[this.position++] = decodedByte;
+    } else {
+      const buffer = Buffer.alloc(Binary.BUFFER_SIZE + this.buffer.length);
+      // Combine the two buffers together
+      this.buffer.copy(buffer, 0, 0, this.buffer.length);
+      this.buffer = buffer;
+      this.buffer[this.position++] = decodedByte;
+    }
+  }
+
+  /**
+   * Writes a buffer or string to the binary.
+   *
+   * @param sequence - a string or buffer to be written to the Binary BSON object.
+   * @param offset - specify the binary of where to write the content.
+   */
+  write(sequence: string | BinarySequence, offset: number): void {
+    offset = typeof offset === 'number' ? offset : this.position;
+
+    // If the buffer is to small let's extend the buffer
+    if (this.buffer.length < offset + sequence.length) {
+      const buffer = Buffer.alloc(this.buffer.length + sequence.length);
+      this.buffer.copy(buffer, 0, 0, this.buffer.length);
+
+      // Assign the new buffer
+      this.buffer = buffer;
+    }
+
+    if (ArrayBuffer.isView(sequence)) {
+      this.buffer.set(ensureBuffer(sequence), offset);
+      this.position =
+        offset + sequence.byteLength > this.position ? offset + sequence.length : this.position;
+    } else if (typeof sequence === 'string') {
+      this.buffer.write(sequence, offset, sequence.length, 'binary');
+      this.position =
+        offset + sequence.length > this.position ? offset + sequence.length : this.position;
+    }
+  }
+
+  /**
+   * Reads **length** bytes starting at **position**.
+   *
+   * @param position - read from the given position in the Binary.
+   * @param length - the number of bytes to read.
+   */
+  read(position: number, length: number): BinarySequence {
+    length = length && length > 0 ? length : this.position;
+
+    // Let's return the data based on the type we have
+    return this.buffer.slice(position, position + length);
+  }
+
+  /**
+   * Returns the value of this binary as a string.
+   * @param asRaw - Will skip converting to a string
+   * @remarks
+   * This is handy when calling this function conditionally for some key value pairs and not others
+   */
+  value(asRaw?: boolean): string | BinarySequence {
+    asRaw = !!asRaw;
+
+    // Optimize to serialize for the situation where the data == size of buffer
+    if (asRaw && this.buffer.length === this.position) {
+      return this.buffer;
+    }
+
+    // If it's a node.js buffer object
+    if (asRaw) {
+      return this.buffer.slice(0, this.position);
+    }
+    return this.buffer.toString('binary', 0, this.position);
+  }
+
+  /** the length of the binary sequence */
+  length(): number {
+    return this.position;
+  }
+
+  /** @internal */
+  toJSON(): string {
+    return this.buffer.toString('base64');
+  }
+
+  /** @internal */
+  toString(format: string): string {
+    return this.buffer.toString(format);
+  }
+
+  /** @internal */
+  toExtendedJSON(options?: EJSONOptions): BinaryExtendedLegacy | BinaryExtended {
+    options = options || {};
+    const base64String = this.buffer.toString('base64');
+
+    const subType = Number(this.sub_type).toString(16);
+    if (options.legacy) {
+      return {
+        $binary: base64String,
+        $type: subType.length === 1 ? '0' + subType : subType
+      };
+    }
+    return {
+      $binary: {
+        base64: base64String,
+        subType: subType.length === 1 ? '0' + subType : subType
+      }
+    };
+  }
+
+  /** @internal */
+  static fromExtendedJSON(
+    doc: BinaryExtendedLegacy | BinaryExtended | UUIDExtended,
+    options?: EJSONOptions
+  ): Binary {
+    options = options || {};
+    let data: Buffer | undefined;
+    let type;
+    if ('$binary' in doc) {
+      if (options.legacy && typeof doc.$binary === 'string' && '$type' in doc) {
+        type = doc.$type ? parseInt(doc.$type, 16) : 0;
+        data = Buffer.from(doc.$binary, 'base64');
+      } else {
+        if (typeof doc.$binary !== 'string') {
+          type = doc.$binary.subType ? parseInt(doc.$binary.subType, 16) : 0;
+          data = Buffer.from(doc.$binary.base64, 'base64');
+        }
+      }
+    } else if ('$uuid' in doc) {
+      type = 4;
+      data = Buffer.from(parseUUID(doc.$uuid));
+    }
+    if (!data) {
+      throw new TypeError(`Unexpected Binary Extended JSON format ${JSON.stringify(doc)}`);
+    }
+    return new Binary(data, type);
+  }
+
+  /** @internal */
+  [Symbol.for('nodejs.util.inspect.custom')](): string {
+    return this.inspect();
+  }
+
+  inspect(): string {
+    const asBuffer = this.value(true);
+    return `Binary("${asBuffer.toString('hex')}", ${this.sub_type})`;
+  }
+}
+
+Object.defineProperty(Binary.prototype, '_bsontype', { value: 'Binary' });