bson 5.0.0-alpha.2 → 5.0.0

package/bson.d.ts

@@ -3,7 +3,7 @@
  * @public
  * @category BSONType
  */
-export declare class Binary {
+export declare class Binary extends BSONValue {
     get _bsontype(): 'Binary';
     /* Excluded from this release type: BSON_BINARY_SUBTYPE_DEFAULT */
     /** Initial buffer default size */
@@ -141,7 +141,9 @@ declare namespace BSON {
         MaxKey,
         BSONRegExp,
         Decimal128,
+        BSONValue,
         BSONError,
+        BSONVersionError,
         BSONType,
         EJSON,
         Document,
@@ -175,7 +177,7 @@ export declare class BSONError extends Error {
  * @public
  * @category BSONType
  */
-export declare class BSONRegExp {
+export declare class BSONRegExp extends BSONValue {
     get _bsontype(): 'BSONRegExp';
     pattern: string;
     options: string;
@@ -209,7 +211,7 @@ export declare interface BSONRegExpExtendedLegacy {
  * @public
  * @category BSONType
  */
-export declare class BSONSymbol {
+export declare class BSONSymbol extends BSONValue {
     get _bsontype(): 'BSONSymbol';
     value: string;
     /**
@@ -219,7 +221,7 @@ export declare class BSONSymbol {
     /** Access the wrapped string value. */
     valueOf(): string;
     toString(): string;
-    /* Excluded from this release type: inspect */
+    inspect(): string;
     toJSON(): string;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
@@ -258,6 +260,21 @@ export declare const BSONType: Readonly<{
 /** @public */
 export declare type BSONType = typeof BSONType[keyof typeof BSONType];
 
+/** @public */
+export declare abstract class BSONValue {
+    /** @public */
+    abstract get _bsontype(): string;
+    /** @public */
+    abstract inspect(): string;
+    /* Excluded from this release type: toExtendedJSON */
+}
+
+/** @public */
+export declare class BSONVersionError extends BSONError {
+    get name(): 'BSONVersionError';
+    constructor();
+}
+
 /**
  * Calculate the bson size for a passed in Javascript object.
  *
@@ -275,7 +292,7 @@ export declare type CalculateObjectSizeOptions = Pick<SerializeOptions, 'seriali
  * @public
  * @category BSONType
  */
-export declare class Code {
+export declare class Code extends BSONValue {
     get _bsontype(): 'Code';
     code: string;
     scope: Document | null;
@@ -304,7 +321,7 @@ export declare interface CodeExtended {
  * @public
  * @category BSONType
  */
-export declare class DBRef {
+export declare class DBRef extends BSONValue {
     get _bsontype(): 'DBRef';
     collection: string;
     oid: ObjectId;
@@ -336,7 +353,7 @@ export declare interface DBRefLike {
  * @public
  * @category BSONType
  */
-export declare class Decimal128 {
+export declare class Decimal128 extends BSONValue {
     get _bsontype(): 'Decimal128';
     readonly bytes: Uint8Array;
     /**
@@ -435,7 +452,7 @@ export declare interface Document {
  * @public
  * @category BSONType
  */
-export declare class Double {
+export declare class Double extends BSONValue {
     get _bsontype(): 'Double';
     value: number;
     /**
@@ -484,6 +501,8 @@ export declare type EJSONOptions = {
     legacy?: boolean;
     /** Enable Extended JSON's `relaxed` mode, which attempts to return native JS types where possible, rather than BSON types */
     relaxed?: boolean;
+    /** Enable native bigint support */
+    useBigInt64?: boolean;
 };
 
 /**
@@ -499,7 +518,7 @@ declare function EJSONserialize(value: any, options?: EJSONOptions): Document;
  * @public
  * @category BSONType
  */
-export declare class Int32 {
+export declare class Int32 extends BSONValue {
     get _bsontype(): 'Int32';
     value: number;
     /**
@@ -547,7 +566,7 @@ declare const kId: unique symbol;
  * case would often result in infinite recursion.
  * Common constant values ZERO, ONE, NEG_ONE, etc. are found as static properties on this class.
  */
-export declare class Long {
+export declare class Long extends BSONValue {
     get _bsontype(): 'Long';
     /** An indicator used to reliably determine if an object is a Long or not. */
     get __isLong__(): boolean;
@@ -840,7 +859,7 @@ export declare class Long {
     toExtendedJSON(options?: EJSONOptions): number | LongExtended;
     static fromExtendedJSON(doc: {
         $numberLong: string;
-    }, options?: EJSONOptions): number | Long;
+    }, options?: EJSONOptions): number | Long | bigint;
     inspect(): string;
 }
 
@@ -862,7 +881,7 @@ export declare const LongWithoutOverridesClass: LongWithoutOverrides;
  * @public
  * @category BSONType
  */
-export declare class MaxKey {
+export declare class MaxKey extends BSONValue {
     get _bsontype(): 'MaxKey';
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
@@ -879,7 +898,7 @@ export declare interface MaxKeyExtended {
  * @public
  * @category BSONType
  */
-export declare class MinKey {
+export declare class MinKey extends BSONValue {
     get _bsontype(): 'MinKey';
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
@@ -896,7 +915,7 @@ export declare interface MinKeyExtended {
  * @public
  * @category BSONType
  */
-export declare class ObjectId {
+export declare class ObjectId extends BSONValue {
     get _bsontype(): 'ObjectId';
     /* Excluded from this release type: index */
     static cacheHexString: boolean;