Added support and tests for a toObjectID helper method

SierraSoftworks · Jul 30, 2015 · 625397d · 625397d
1 parent 4ebd33d
commit 625397d
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 2 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/lib/utils/ObjectID.js b/dist/lib/utils/ObjectID.js
diff --git a/dist/lib/utils/ObjectID.js.map b/dist/lib/utils/ObjectID.js.map
diff --git a/index.ts b/index.ts
@@ -18,4 +18,7 @@ import NoOpCache from './lib/caches/NoOpCache';
 export {MemoryCache, NoOpCache};
 
 import IDDirector from './lib/cacheControllers/IDDirector';
-export {IDDirector as CacheOnID};
+export {IDDirector as CacheOnID};
+
+import {toObjectID} from './lib/utils/ObjectID';
+export {toObjectID};
diff --git a/lib/utils/ObjectID.ts b/lib/utils/ObjectID.ts
@@ -0,0 +1,6 @@
+/// <reference path="../../_references.d.ts" />
+import MongoDB = require('mongodb');
+
+export function toObjectID(value: string): MongoDB.ObjectID {
+	return MongoDB.ObjectID.createFromHexString(value);
+}
diff --git a/test/Utilities.ts b/test/Utilities.ts
@@ -0,0 +1,19 @@
+/// <reference path="../_references.d.ts" />
+import * as Iridium from '../index';
+import MongoDB = require('mongodb');
+
+describe("Utilities", () => {
+	describe("toObjectID", () => {
+		it("should convert hex strings to ObjectIDs", () => {
+			let oID = Iridium.toObjectID("aaaaaaaaaaaaaaaaaaaaaaaa");
+			chai.expect(oID).to.be.instanceOf(MongoDB.ObjectID);
+			chai.expect(oID.toHexString()).to.eql("aaaaaaaaaaaaaaaaaaaaaaaa");
+		});
+
+		it("should throw an error if your string is not a valid ObjectID", () => {
+			chai.expect(() => {
+				Iridium.toObjectID("aaaaaaaaaaaaaaaa");
+			}).to.throw;
+		});
+	});
+})