From 775ade8fa63b5d5baa2cd5ae8a64d0c01fc28242 Mon Sep 17 00:00:00 2001
From: ramlez <ramlez@users.noreply.github.com>
Date: Wed, 11 Apr 2018 21:08:06 +0200
Subject: [PATCH] [BSON] add types for missing `calculateObjectSize` method
 (#24901)

---
 types/bson/bson-tests.ts |  9 ++++++++-
 types/bson/index.d.ts    | 16 ++++++++++++++++
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/types/bson/bson-tests.ts b/types/bson/bson-tests.ts
index ebdd8a19c3..b3173053c8 100644
--- a/types/bson/bson-tests.ts
+++ b/types/bson/bson-tests.ts
@@ -6,7 +6,7 @@ bson.ObjectID.cacheHexString = true
 let BSON = new bson.BSON();
 let Long = bson.Long;
 
-let doc = {long: Long.fromNumber(100)}
+let doc = { long: Long.fromNumber(100) }
 
 // Serialize a document
 let data = BSON.serialize(doc, false, true, false);
@@ -19,3 +19,10 @@ console.log("doc_2:", doc_2);
 BSON = new bson.BSON();
 data = BSON.serialize(doc);
 doc_2 = BSON.deserialize(data);
+
+
+// Calculate Object Size
+BSON = new bson.BSON();
+console.log("Calculated Object size - no options object:", BSON.calculateObjectSize(doc));
+console.log("Calculated Object size - empty options object:", BSON.calculateObjectSize(doc, {}));
+console.log("Calculated Object size - custom options object:", BSON.calculateObjectSize(doc, { ignoreUndefined: false, serializeFunctions: true }));
diff --git a/types/bson/index.d.ts b/types/bson/index.d.ts
index 24372ff0f5..3b0feb0113 100644
--- a/types/bson/index.d.ts
+++ b/types/bson/index.d.ts
@@ -16,6 +16,14 @@ export interface DeserializeOptions {
     /** {Boolean, default:false}, deserialize Binary data directly into node.js Buffer object. */
     promoteBuffers?: boolean;
 }
+
+export interface CalculateObjectSizeOptions {
+    /** {Boolean, default:false}, serialize the javascript functions */
+    serializeFunctions?: boolean;
+    /** {Boolean, default:true}, ignore undefined fields. */
+    ignoreUndefined?: boolean;
+}
+
 export class BSON {
     /**
      * @param {Object} object the Javascript object to serialize.
@@ -26,6 +34,14 @@ export class BSON {
      */
     serialize(object: any, checkKeys?: boolean, asBuffer?: boolean, serializeFunctions?: boolean): Buffer;
     deserialize(buffer: Buffer, options?: DeserializeOptions, isArray?: boolean): any;
+    /**
+     * Calculate the bson size for a passed in Javascript object.
+     *
+     * @param {Object} object the Javascript object to calculate the BSON byte size for.
+     * @param {CalculateObjectSizeOptions} Options
+     * @return {Number} returns the number of bytes the BSON object will take up.
+     */
+    calculateObjectSize(object: any, options?: CalculateObjectSizeOptions): number;
 }
 
 export class Binary {