feat(NODE-4819): add custom inspect support for other js runtimes

src/binary.ts

@@ -4,6 +4,7 @@ import type { EJSONOptions } from './extended_json';
 import { BSONError, BSONTypeError } from './error';
 import { BSON_BINARY_SUBTYPE_UUID_NEW } from './constants';
 import { ByteUtils } from './utils/byte_utils';
+import { kInspect } from './utils/custom_inspect';
 
 /** @public */
 export type BinarySequence = Uint8Array | number[];
@@ -285,7 +286,7 @@ export class Binary {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 
@@ -475,7 +476,7 @@ export class UUID extends Binary {
    * @returns return the 36 character hex string representation.
    * @internal
    */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/code.ts

@@ -1,4 +1,5 @@
 import type { Document } from './bson';
+import { kInspect } from './utils/custom_inspect';
 
 /** @public */
 export interface CodeExtended {
@@ -46,7 +47,7 @@ export class Code {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/db_ref.ts

@@ -2,6 +2,7 @@ import type { Document } from './bson';
 import type { EJSONOptions } from './extended_json';
 import type { ObjectId } from './objectid';
 import { isObjectLike } from './parser/utils';
+import { kInspect } from './utils/custom_inspect';
 
 /** @public */
 export interface DBRefLike {
@@ -107,7 +108,7 @@ export class DBRef {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/decimal128.ts

@@ -2,6 +2,7 @@ import { BSONTypeError } from './error';
 import { Long } from './long';
 import { isUint8Array } from './parser/utils';
 import { ByteUtils } from './utils/byte_utils';
+import { kInspect } from './utils/custom_inspect';
 
 const PARSE_STRING_REGEXP = /^(\+|-)?(\d+|(\d*\.\d*))?(E|e)?([-+])?(\d+)?$/;
 const PARSE_INF_REGEXP = /^(\+|-)?(Infinity|inf)$/i;
@@ -765,7 +766,7 @@ export class Decimal128 {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/double.ts

@@ -1,4 +1,5 @@
 import type { EJSONOptions } from './extended_json';
+import { kInspect } from './utils/custom_inspect';
 
 /** @public */
 export interface DoubleExtended {
@@ -78,7 +79,7 @@ export class Double {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/int_32.ts

@@ -1,4 +1,5 @@
 import type { EJSONOptions } from './extended_json';
+import { kInspect } from './utils/custom_inspect';
 
 /** @public */
 export interface Int32Extended {
@@ -58,7 +59,7 @@ export class Int32 {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/long.ts

@@ -1,6 +1,7 @@
 import type { EJSONOptions } from './extended_json';
 import { isObjectLike } from './parser/utils';
 import type { Timestamp } from './timestamp';
+import { kInspect } from './utils/custom_inspect';
 
 interface LongWASMHelpers {
   /** Gets the high bits of the last operation performed */
@@ -1027,7 +1028,7 @@ export class Long {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/max_key.ts

@@ -1,3 +1,5 @@
+import { kInspect } from './utils/custom_inspect';
+
 /** @public */
 export interface MaxKeyExtended {
   $maxKey: 1;
@@ -26,7 +28,7 @@ export class MaxKey {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/min_key.ts

@@ -1,3 +1,5 @@
+import { kInspect } from './utils/custom_inspect';
+
 /** @public */
 export interface MinKeyExtended {
   $minKey: 1;
@@ -26,7 +28,7 @@ export class MinKey {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/objectid.ts

@@ -1,6 +1,7 @@
 import { BSONTypeError } from './error';
 import { deprecate, isUint8Array, randomBytes } from './parser/utils';
 import { BSONDataView, ByteUtils } from './utils/byte_utils';
+import { kInspect } from './utils/custom_inspect';
 
 // Regular expression that checks for hex value
 const checkForHexRegExp = new RegExp('^[0-9a-fA-F]{24}$');
@@ -322,7 +323,7 @@ export class ObjectId {
    * @returns return the 24 character hex string representation.
    * @internal
    */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/symbol.ts

@@ -1,3 +1,5 @@
+import { kInspect } from './utils/custom_inspect';
+
 /** @public */
 export interface BSONSymbolExtended {
   $symbol: string;
@@ -50,7 +52,7 @@ export class BSONSymbol {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 }

src/timestamp.ts

@@ -1,5 +1,6 @@
 import { Long } from './long';
 import { isObjectLike } from './parser/utils';
+import { kInspect } from './utils/custom_inspect';
 
 /** @public */
 export type TimestampOverrides = '_bsontype' | 'toExtendedJSON' | 'fromExtendedJSON' | 'inspect';
@@ -109,7 +110,7 @@ export class Timestamp extends LongWithoutOverridesClass {
   }
 
   /** @internal */
-  [Symbol.for('nodejs.util.inspect.custom')](): string {
+  [kInspect](): string {
     return this.inspect();
   }
 

src/utils/custom_inspect.ts

@@ -0,0 +1,12 @@
+function getSymbol() {
+  if ('Deno' in globalThis) {
+    // Deno
+    return Symbol.for('Deno.customInspect');
+  }
+
+  // Node.js as Default
+  return Symbol.for('nodejs.util.inspect.custom');
+}
+
+/** @internal */
+export const kInspect = getSymbol();