mongo-portable

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ObjectId | Mongo Portable</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">Mongo Portable</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="objectid.html">ObjectId</a> </li> </ul> <h1>Class ObjectId</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>ObjectId</p> </div> <dl class="tsd-comment-tags"> <dt>module</dt> <dd><p>ObjectId</p> </dd> <dt>since</dt> <dd><p>0.0.1</p> </dd> <dt>author</dt> <dd><p>Eduardo Astolfi <a href="mailto:eastolfi91@gmail.com">eastolfi91@gmail.com</a></p> </dd> <dt>copyright</dt> <dd><p>2016 Eduardo Astolfi <a href="mailto:eastolfi91@gmail.com">eastolfi91@gmail.com</a></p> </dd> <dt>license</dt> <dd><p>MIT Licensed</p> </dd> <dt>classdesc</dt> <dd><p>Represents the BSON ObjectId type</p> </dd> <dt>param</dt> <dd><p>Can be a 24 byte hex string, a 12 byte binary string or a Number.</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">ObjectId</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="objectid.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="objectid.html#binaryparser" class="tsd-kind-icon">binary<wbr>Parser</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="objectid.html#cachedid" class="tsd-kind-icon">cached<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="objectid.html#id" class="tsd-kind-icon">id</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="objectid.html#logger" class="tsd-kind-icon">logger</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="objectid.html#cachehexstring" class="tsd-kind-icon">cache<wbr>Hex<wbr>String</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="objectid.html#index" class="tsd-kind-icon">index</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="objectid.html#generationtime" class="tsd-kind-icon">generation<wbr>Time</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="objectid.html#equals" class="tsd-kind-icon">equals</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="objectid.html#generate" class="tsd-kind-icon">generate</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="objectid.html#getinc" class="tsd-kind-icon">get<wbr>Inc</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="objectid.html#gettimestamp" class="tsd-kind-icon">get<wbr>Timestamp</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="objectid.html#returnhash" class="tsd-kind-icon">return<wbr>Hash</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="objectid.html#tohexstring" class="tsd-kind-icon">to<wbr>Hex<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="objectid.html#tojson" class="tsd-kind-icon">toJSON</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="objectid.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="objectid.html#createfromhexstring" class="tsd-kind-icon">create<wbr>From<wbr>Hex<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="objectid.html#createfromtime" class="tsd-kind-icon">create<wbr>From<wbr>Time</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="objectid.html#createpk" class="tsd-kind-icon">create<wbr>Pk</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Object<wbr>Id<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="objectid.html" class="tsd-signature-type">ObjectId</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L57">document/ObjectId.ts:57</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="objectid.html" class="tsd-signature-type">ObjectId</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="binaryparser" class="tsd-anchor"></a> <h3>binary<wbr>Parser</h3> <div class="tsd-signature tsd-kind-icon">binary<wbr>Parser<span class="tsd-signature-symbol">:</span> <a href="binaryparser.html" class="tsd-signature-type">BinaryParser</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L51">document/ObjectId.ts:51</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="cachedid" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> cached<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">cached<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L57">document/ObjectId.ts:57</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="id" class="tsd-anchor"></a> <h3>id</h3> <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L52">document/ObjectId.ts:52</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a name="logger" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> logger</h3> <div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">JSWLogger</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L54">document/ObjectId.ts:54</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"> <a name="cachehexstring" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> cache<wbr>Hex<wbr>String</h3> <div class="tsd-signature tsd-kind-icon">cache<wbr>Hex<wbr>String<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L49">document/ObjectId.ts:49</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="index" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> index</h3> <div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L47">document/ObjectId.ts:47</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="generationtime" class="tsd-anchor"></a> <h3>generation<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> generationTime<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> generationTime<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L264">document/ObjectId.ts:264</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">number</span> </h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L268">document/ObjectId.ts:268</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="equals" class="tsd-anchor"></a> <h3>equals</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">equals<span class="tsd-signature-symbol">(</span>otherID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L242">document/ObjectId.ts:242</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Compares the equality of this ObjectId with [otherID].</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>ObjectId#equals</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>otherID: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>ObjectId instance to compare against.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>The result of comparing two ObjectId"s</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="generate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> generate</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">generate<span class="tsd-signature-symbol">(</span>time<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L179">document/ObjectId.ts:179</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Generate a 12 byte id string used in ObjectId"s</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>ObjectId#generate</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> time: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> <p>The 12 byte id binary string.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="getinc" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Inc</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">get<wbr>Inc<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L154">document/ObjectId.ts:154</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Update the ObjectId index used in generating new ObjectId"s on the driver</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>ObjectId#get_inc</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> <p>Next index value.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="gettimestamp" class="tsd-anchor"></a> <h3>get<wbr>Timestamp</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Timestamp<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L255">document/ObjectId.ts:255</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the generation time in seconds that this ID was generated.</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>ObjectId#getTimestamp</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4> <p>Number of seconds in the timestamp part of the 12 byte id.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="returnhash" class="tsd-anchor"></a> <h3>return<wbr>Hash</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">return<wbr>Hash<span class="tsd-signature-symbol">(</span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L158">document/ObjectId.ts:158</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>length: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tohexstring" class="tsd-anchor"></a> <h3>to<wbr>Hex<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>Hex<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L101">document/ObjectId.ts:101</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return the ObjectId id as a 24 byte hex string representation</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>ObjectId#toHexString</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> <p>The 24 byte hex string representation.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tojson" class="tsd-anchor"></a> <h3>toJSON</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L142">document/ObjectId.ts:142</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Alias for {@link ObjectId#toHexString}</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>Cursor#next</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tostring" class="tsd-anchor"></a> <h3>to<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L133">document/ObjectId.ts:133</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Alias for {@link ObjectId#toHexString}</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>Cursor#next</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createfromhexstring" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>From<wbr>Hex<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>From<wbr>Hex<wbr>String<span class="tsd-signature-symbol">(</span>hexString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="objectid.html" class="tsd-signature-type">ObjectId</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L287">document/ObjectId.ts:287</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates an ObjectId from a hex string representation of an ObjectId.</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>ObjectId#createFromHexString</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hexString: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>An ObjectId 24 byte hexstring representation.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="objectid.html" class="tsd-signature-type">ObjectId</a></h4> <p>The created ObjectId</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createfromtime" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>From<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>From<wbr>Time<span class="tsd-signature-symbol">(</span>time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="objectid.html" class="tsd-signature-type">ObjectId</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L319">document/ObjectId.ts:319</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates an ObjectId from a second based number, with the rest of the ObjectId zeroed out. Used for comparisons or sorting the ObjectId.</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>ObjectId#createFromTime</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>time: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>A number of seconds.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="objectid.html" class="tsd-signature-type">ObjectId</a></h4> <p>The created ObjectId</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createpk" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Pk</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Pk<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="objectid.html" class="tsd-signature-type">ObjectId</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/EastolfiWebDev/MongoPortable/blob/b25b7c9/src/document/ObjectId.ts#L334">document/ObjectId.ts:334</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates an ObjectId from a second based number, with the rest of the ObjectId zeroed out. Used for comparisons or sorting the ObjectId.</p> </div> <dl class="tsd-comment-tags"> <dt>method</dt> <dd><p>ObjectId#createPk</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <a href="objectid.html" class="tsd-signature-type">ObjectId</a></h4> <p>return the created ObjectId</p> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="objectid.html" class="tsd-kind-icon">Object<wbr>Id</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="objectid.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="objectid.html#binaryparser" class="tsd-kind-icon">binary<wbr>Parser</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="objectid.html#cachedid" class="tsd-kind-icon">cached<wbr>Id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="objectid.html#id" class="tsd-kind-icon">id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a href="objectid.html#logger" class="tsd-kind-icon">logger</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"> <a href="objectid.html#cachehexstring" class="tsd-kind-icon">cache<wbr>Hex<wbr>String</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="objectid.html#index" class="tsd-kind-icon">index</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="objectid.html#generationtime" class="tsd-kind-icon">generation<wbr>Time</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="objectid.html#equals" class="tsd-kind-icon">equals</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="objectid.html#generate" class="tsd-kind-icon">generate</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="objectid.html#getinc" class="tsd-kind-icon">get<wbr>Inc</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="objectid.html#gettimestamp" class="tsd-kind-icon">get<wbr>Timestamp</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="objectid.html#returnhash" class="tsd-kind-icon">return<wbr>Hash</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="objectid.html#tohexstring" class="tsd-kind-icon">to<wbr>Hex<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="objectid.html#tojson" class="tsd-kind-icon">toJSON</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="objectid.html#tostring" class="tsd-kind-icon">to<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="objectid.html#createfromhexstring" class="tsd-kind-icon">create<wbr>From<wbr>Hex<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="objectid.html#createfromtime" class="tsd-kind-icon">create<wbr>From<wbr>Time</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="objectid.html#createpk" class="tsd-kind-icon">create<wbr>Pk</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>