bson 4.5.1 → 4.6.0

package/bson.d.ts

@@ -20,6 +20,10 @@ export declare class Binary {
     static readonly SUBTYPE_UUID = 4;
     /** MD5 BSON type */
     static readonly SUBTYPE_MD5 = 5;
+    /** Encrypted BSON type */
+    static readonly SUBTYPE_ENCRYPTED = 6;
+    /** Column BSON type */
+    static readonly SUBTYPE_COLUMN = 7;
     /** User BSON type */
     static readonly SUBTYPE_USER_DEFINED = 128;
     buffer: Buffer;
@@ -59,10 +63,10 @@ export declare class Binary {
     value(asRaw?: boolean): string | BinarySequence;
     /** the length of the binary sequence */
     length(): number;
-    /* Excluded from this release type: toJSON */
-    /* Excluded from this release type: toString */
+    toJSON(): string;
+    toString(format?: string): string;
     /* Excluded from this release type: toExtendedJSON */
-    /* Excluded from this release type: toUUID */
+    toUUID(): UUID;
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
 }
@@ -112,10 +116,14 @@ declare const BSON: {
     deserialize: typeof deserialize;
     calculateObjectSize: typeof calculateObjectSize;
     deserializeStream: typeof deserializeStream;
+    BSONError: typeof BSONError;
+    BSONTypeError: typeof BSONTypeError;
 };
 export default BSON;
 /* Excluded from this release type: BSON_BINARY_SUBTYPE_BYTE_ARRAY */
+/* Excluded from this release type: BSON_BINARY_SUBTYPE_COLUMN */
 /* Excluded from this release type: BSON_BINARY_SUBTYPE_DEFAULT */
+/* Excluded from this release type: BSON_BINARY_SUBTYPE_ENCRYPTED */
 /* Excluded from this release type: BSON_BINARY_SUBTYPE_FUNCTION */
 /* Excluded from this release type: BSON_BINARY_SUBTYPE_MD5 */
 /* Excluded from this release type: BSON_BINARY_SUBTYPE_USER_DEFINED */
@@ -146,6 +154,11 @@ export default BSON;
 /* Excluded from this release type: BSON_INT32_MIN */
 /* Excluded from this release type: BSON_INT64_MAX */
 /* Excluded from this release type: BSON_INT64_MIN */
+/** @public */
+export declare class BSONError extends Error {
+    constructor(message: string);
+    readonly name: string;
+}
 /**
  * A class representation of the BSON RegExp type.
  * @public
@@ -186,11 +199,19 @@ export declare class BSONSymbol {
     constructor(value: string);
     /** Access the wrapped string value. */
     valueOf(): string;
+    toString(): string;
+    /* Excluded from this release type: inspect */
+    toJSON(): string;
 }
 /** @public */
 export declare interface BSONSymbolExtended {
     $symbol: string;
 }
+/** @public */
+export declare class BSONTypeError extends TypeError {
+    constructor(message: string);
+    readonly name: string;
+}
 /**
  * Calculate the bson size for a passed in Javascript object.
  *
@@ -214,7 +235,10 @@ export declare class Code {
      * @param scope - an optional scope for the function.
      */
     constructor(code: string | Function, scope?: Document);
-    /* Excluded from this release type: toJSON */
+    toJSON(): {
+        code: string | Function;
+        scope?: Document;
+    };
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
@@ -242,7 +266,7 @@ export declare class DBRef {
     constructor(collection: string, oid: ObjectId, db?: string, fields?: Document);
     /* Excluded from this release type: namespace */
     /* Excluded from this release type: namespace */
-    /* Excluded from this release type: toJSON */
+    toJSON(): DBRefLike & Document;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
@@ -317,6 +341,24 @@ export declare interface DeserializeOptions {
     /** Offset into buffer to begin reading document from */
     index?: number;
     raw?: boolean;
+    /** Allows for opt-out utf-8 validation for all keys or
+     * specified keys. Must be all true or all false.
+     *
+     * @example
+     * ```js
+     * // disables validation on all keys
+     *  validation: { utf8: false }
+     *
+     * // enables validation only on specified keys a, b, and c
+     *  validation: { utf8: { a: true, b: true, c: true } }
+     *
+     *  // disables validation only on specified keys a, b
+     *  validation: { utf8: { a: false, b: false } }
+     * ```
+     */
+    validation?: {
+        utf8: boolean | Record<string, true> | Record<string, false>;
+    };
 }
 /**
  * Deserialize stream data as BSON documents.
@@ -354,7 +396,8 @@ export declare class Double {
      * @returns returns the wrapped double number.
      */
     valueOf(): number;
-    /* Excluded from this release type: toJSON */
+    toJSON(): number;
+    toString(radix?: number): string;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
@@ -458,7 +501,8 @@ export declare class Int32 {
      * @returns returns the wrapped int32 number.
      */
     valueOf(): number;
-    /* Excluded from this release type: toJSON */
+    toString(radix?: number): string;
+    toJSON(): number;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
@@ -839,9 +883,9 @@ declare class ObjectId {
     /**
      * Create an ObjectId type
      *
-     * @param id - Can be a 24 character hex string, 12 byte binary Buffer, or a number.
+     * @param inputId - Can be a 24 character hex string, 12 byte binary Buffer, or a number.
      */
-    constructor(id?: string | Buffer | number | ObjectIdLike | ObjectId);
+    constructor(inputId?: string | Buffer | number | ObjectIdLike | ObjectId);
     /*
     * The ObjectId bytes
     * @readonly
@@ -861,8 +905,14 @@ declare class ObjectId {
      * @param time - pass in a second based timestamp.
      */
     static generate(time?: number): Buffer;
-    /* Excluded from this release type: toString */
-    /* Excluded from this release type: toJSON */
+    /**
+     * Converts the id into a 24 character hex string for printing
+     *
+     * @param format - The Buffer toString format parameter.
+     */
+    toString(format?: string): string;
+    /** Converts to its JSON the 24 character hex string representation. */
+    toJSON(): string;
     /**
      * Compares the equality of this ObjectId with `otherID`.
      *
@@ -1026,8 +1076,15 @@ export declare class UUID {
      * @param includeDashes - should the string exclude dash-separators.
      * */
     toHexString(includeDashes?: boolean): string;
-    /* Excluded from this release type: toString */
-    /* Excluded from this release type: toJSON */
+    /**
+     * Converts the id into a 36 character (dashes included) hex string, unless a encoding is specified.
+     */
+    toString(encoding?: string): string;
+    /**
+     * Converts the id into its JSON string representation.
+     * A 36 character (dashes included) hex string in the format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+     */
+    toJSON(): string;
     /**
      * Compares the equality of this UUID with `otherID`.
      *