bson 6.1.0 → 6.3.0

package/bson.d.ts

@@ -68,7 +68,7 @@ export declare class Binary extends BSONValue {
     /** Creates an Binary instance from a base64 string */
     static createFromBase64(base64: string, subType?: number): Binary;
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -150,14 +150,16 @@ export { BSON }
  * @public
  * @category Error
  *
- * `BSONError` objects are thrown when BSON ecounters an error.
+ * `BSONError` objects are thrown when BSON encounters an error.
  *
  * This is the parent class for all the other errors thrown by this library.
  */
 export declare class BSONError extends Error {
     /* Excluded from this release type: bsonError */
     get name(): string;
-    constructor(message: string);
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
     /**
      * @public
      *
@@ -187,7 +189,7 @@ export declare class BSONRegExp extends BSONValue {
     static parseOptions(options?: string): string;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -232,10 +234,10 @@ export declare class BSONSymbol extends BSONValue {
     /** Access the wrapped string value. */
     valueOf(): string;
     toString(): string;
-    inspect(): string;
     toJSON(): string;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -275,8 +277,12 @@ export declare type BSONType = (typeof BSONType)[keyof typeof BSONType];
 export declare abstract class BSONValue {
     /** @public */
     abstract get _bsontype(): string;
-    /** @public */
-    abstract inspect(): string;
+    /**
+     * @public
+     * Prints a human-readable string of BSON value information
+     * If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify
+     */
+    abstract inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
     /* Excluded from this release type: toExtendedJSON */
 }
 
@@ -321,7 +327,7 @@ export declare class Code extends BSONValue {
     };
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -352,7 +358,7 @@ export declare class DBRef extends BSONValue {
     toJSON(): DBRefLike & Document;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -406,7 +412,7 @@ export declare class Decimal128 extends BSONValue {
     toJSON(): Decimal128Extended;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -529,7 +535,7 @@ export declare class Double extends BSONValue {
     toString(radix?: number): string;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -579,6 +585,8 @@ export declare type EJSONOptions = {
  */
 declare function EJSONserialize(value: any, options?: EJSONOptions): Document;
 
+declare type InspectFn = (x: unknown, options?: unknown) => string;
+
 /**
  * A class representation of a BSON Int32 type.
  * @public
@@ -603,7 +611,7 @@ export declare class Int32 extends BSONValue {
     toJSON(): number;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -926,7 +934,7 @@ export declare class Long extends BSONValue {
     static fromExtendedJSON(doc: {
         $numberLong: string;
     }, options?: EJSONOptions): number | Long | bigint;
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -988,9 +996,42 @@ export declare class ObjectId extends BSONValue {
     /* Excluded from this release type: [kId] */
     /* Excluded from this release type: __id */
     /**
-     * Create an ObjectId type
+     * Create ObjectId from a number.
+     *
+     * @param inputId - A number.
+     * @deprecated Instead, use `static createFromTime()` to set a numeric value for the new ObjectId.
+     */
+    constructor(inputId: number);
+    /**
+     * Create ObjectId from a 24 character hex string.
+     *
+     * @param inputId - A 24 character hex string.
+     */
+    constructor(inputId: string);
+    /**
+     * Create ObjectId from the BSON ObjectId type.
+     *
+     * @param inputId - The BSON ObjectId type.
+     */
+    constructor(inputId: ObjectId);
+    /**
+     * Create ObjectId from the object type that has the toHexString method.
+     *
+     * @param inputId - The ObjectIdLike type.
+     */
+    constructor(inputId: ObjectIdLike);
+    /**
+     * Create ObjectId from a 12 byte binary Buffer.
+     *
+     * @param inputId - A 12 byte binary Buffer.
+     */
+    constructor(inputId: Uint8Array);
+    /** To generate a new ObjectId, use ObjectId() with no argument. */
+    constructor();
+    /**
+     * Implementation overload.
      *
-     * @param inputId - Can be a 24 character hex string, 12 byte binary Buffer, or a number.
+     * @param inputId - All input types that are used in the constructor implementation.
      */
     constructor(inputId?: string | number | ObjectId | ObjectIdLike | Uint8Array);
     /**
@@ -1046,7 +1087,12 @@ export declare class ObjectId extends BSONValue {
     static isValid(id: string | number | ObjectId | ObjectIdLike | Uint8Array): boolean;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    /**
+     * Converts to a string representation of this Id.
+     *
+     * @returns return the 24 character hex string representation.
+     */
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -1203,7 +1249,7 @@ export declare class Timestamp extends LongWithoutOverridesClass {
     static fromString(str: string, optRadix: number): Timestamp;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -1278,7 +1324,13 @@ export declare class UUID extends Binary {
     static createFromBase64(base64: string): UUID;
     /* Excluded from this release type: bytesFromString */
     /* Excluded from this release type: isValidUUIDString */
-    inspect(): string;
+    /**
+     * Converts to a string representation of this Id.
+     *
+     * @returns return the 36 character hex string representation.
+     *
+     */
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */