bson 6.2.0 → 6.4.0

package/bson.d.ts

@@ -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
      *
@@ -617,8 +619,6 @@ export declare interface Int32Extended {
     $numberInt: string;
 }
 
-declare const kId: unique symbol;
-
 /**
  * A class representing a 64-bit integer
  * @public
@@ -991,12 +991,45 @@ export declare class ObjectId extends BSONValue {
     get _bsontype(): 'ObjectId';
     /* Excluded from this release type: index */
     static cacheHexString: boolean;
-    /* Excluded from this release type: [kId] */
+    /* Excluded from this release type: buffer */
     /* 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);
     /**
@@ -1031,6 +1064,7 @@ export declare class ObjectId extends BSONValue {
     /** Returns the generation date (accurate up to the second) that this ID was generated. */
     getTimestamp(): Date;
     /* Excluded from this release type: createPk */
+    /* Excluded from this release type: serializeInto */
     /**
      * Creates an ObjectId from a second based number, with the rest of the ObjectId zeroed out. Used for comparisons or sorting the ObjectId.
      *