UNPKG

iridium

Version:

A custom lightweight ORM for MongoDB designed for power-users

sierrasoftworks.com/iridium

sierrasoftworks/iridium

16 lines (15 loc) • 876 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import * as MongoDB from "mongodb"; /** * Converts a string to an ObjectID instance - a shortcut for require("mongodb").ObjectID.createFromHexString * * @param value The string representation of the ObjectID you wish to create. * @returns A MongoDB ObjectID instance equivalent to the string you provided. * * You should be aware that this method performs no validation on the received string, MongoDB's ObjectID requires * that it either be a 12 byte UTF8 string, or a 24 byte hexadecimal string in order to be converted correctly. * * This method removes the need for your application to directly depend on MongoDB's Node.js client library, * which helps clean up your code a bit and reduces the headache of maintaining two different versions of the * library (since Iridium also has one). */ export declare function toObjectID(value: string): MongoDB.ObjectID;