diff --git a/404.html b/404.html index efd54ada..e48519c1 100644 --- a/404.html +++ b/404.html @@ -4,13 +4,13 @@ Page Not Found | mongodb-memory-server - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/24f38be7.2cf6d8ab.js b/assets/js/24f38be7.dd1fc695.js similarity index 99% rename from assets/js/24f38be7.2cf6d8ab.js rename to assets/js/24f38be7.dd1fc695.js index 5e5740a2..3fd0ed66 100644 --- a/assets/js/24f38be7.2cf6d8ab.js +++ b/assets/js/24f38be7.dd1fc695.js @@ -1 +1 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[754],{5680:function(e,n,a){a.d(n,{xA:function(){return d},yg:function(){return N}});var t=a(6540);function r(e,n,a){return n in e?Object.defineProperty(e,n,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[n]=a,e}function i(e,n){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),a.push.apply(a,t)}return a}function o(e){for(var n=1;n=0||(r[a]=e[a]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=t.createContext({}),g=function(e){var n=t.useContext(p),a=n;return e&&(a="function"==typeof e?e(n):o(o({},n),e)),a},d=function(e){var n=g(e.components);return t.createElement(p.Provider,{value:n},e.children)},m="mdxType",y={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},s=t.forwardRef((function(e,n){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=g(a),s=r,N=m["".concat(p,".").concat(s)]||m[s]||y[s]||i;return a?t.createElement(N,o(o({ref:n},d),{},{components:a})):t.createElement(N,o({ref:n},d))}));function N(e,n){var a=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=a.length,o=new Array(i);o[0]=s;var l={};for(var p in n)hasOwnProperty.call(n,p)&&(l[p]=n[p]);l.originalType=e,l[m]="string"==typeof e?e:r,o[1]=l;for(var g=2;g=0||(r[a]=e[a]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=t.createContext({}),g=function(e){var n=t.useContext(p),a=n;return e&&(a="function"==typeof e?e(n):o(o({},n),e)),a},d=function(e){var n=g(e.components);return t.createElement(p.Provider,{value:n},e.children)},m="mdxType",y={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},s=t.forwardRef((function(e,n){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=g(a),s=r,N=m["".concat(p,".").concat(s)]||m[s]||y[s]||i;return a?t.createElement(N,o(o({ref:n},d),{},{components:a})):t.createElement(N,o({ref:n},d))}));function N(e,n){var a=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=a.length,o=new Array(i);o[0]=s;var l={};for(var p in n)hasOwnProperty.call(n,p)&&(l[p]=n[p]);l.originalType=e,l[m]="string"==typeof e?e:r,o[1]=l;for(var g=2;g=0||(a[n]=e[n]);return a}(e,r);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var m=t.createContext({}),l=function(e){var r=t.useContext(m),n=r;return e&&(n="function"==typeof e?e(r):i(i({},r),e)),n},d=function(e){var r=l(e.components);return t.createElement(m.Provider,{value:r},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var r=e.children;return t.createElement(t.Fragment,{},r)}},y=t.forwardRef((function(e,r){var n=e.components,a=e.mdxType,o=e.originalType,m=e.parentName,d=g(e,["components","mdxType","originalType","parentName"]),s=l(n),y=a,c=s["".concat(m,".").concat(y)]||s[y]||p[y]||o;return n?t.createElement(c,i(i({ref:r},d),{},{components:n})):t.createElement(c,i({ref:r},d))}));function c(e,r){var n=arguments,a=r&&r.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=y;var g={};for(var m in r)hasOwnProperty.call(r,m)&&(g[m]=r[m]);g.originalType=e,g[s]="string"==typeof e?e:a,i[1]=g;for(var l=2;lmongodb-memory-server-core Version Table",id:"mongodb-memory-server-core-version-table",level:2},{value:"mongodb-memory-server-global-* Version Table",id:"mongodb-memory-server-global--version-table",level:2}],p={toc:s},y="wrapper";function c(e){var r=e.components,n=(0,a.A)(e,i);return(0,o.yg)(y,(0,t.A)({},p,n,{components:r,mdxType:"MDXLayout"}),(0,o.yg)("p",null,"This Guide will show what MongoDB Server versions are / were the default for versions of ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," and the guidelines of when a version gets changed."),(0,o.yg)("p",null,(0,o.yg)("em",{parentName:"p"},(0,o.yg)("sub",null,"Some expressions will use ",(0,o.yg)("a",{parentName:"em",href:"https://www.npmjs.com/package/semver"},"npm's semver convention"),"."))),(0,o.yg)("h2",{id:"when-a-version-gets-upgraded"},"When a Version gets upgraded"),(0,o.yg)("p",null,"In a new major version of ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.yg)("inlineCode",{parentName:"p"},"X.0.0"),"), the default mongodb binary version may be upgraded to any newer version (",(0,o.yg)("inlineCode",{parentName:"p"},"X.X.X"),").",(0,o.yg)("br",{parentName:"p"}),"\n","In a minor version of ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.yg)("inlineCode",{parentName:"p"},"0.X.0"),"), the default mongodb binary version may be upgraded to the latest patch version ",(0,o.yg)("inlineCode",{parentName:"p"},"0.0.X"),".",(0,o.yg)("br",{parentName:"p"}),"\n","In a patch version of ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.yg)("inlineCode",{parentName:"p"},"0.0.X"),"), the default mongodb binary version will not be changed."),(0,o.yg)("p",null,"There are some exceptions:"),(0,o.yg)("ul",null,(0,o.yg)("li",{parentName:"ul"},"A mongodb binary may go offline (not being able to download it anymore), then the default version will be changed and a ",(0,o.yg)("em",{parentName:"li"},"minor")," (",(0,o.yg)("inlineCode",{parentName:"li"},"0.X.0"),") release will happen."),(0,o.yg)("li",{parentName:"ul"},"A mongodb binary may be broken, then the default version will be changed and a ",(0,o.yg)("em",{parentName:"li"},"minor")," (",(0,o.yg)("inlineCode",{parentName:"li"},"0.X.0"),") release will happen.")),(0,o.yg)("p",null,"The versions with a broken default binary may get deprecated (when possible)."),(0,o.yg)("p",null,"For Packages that are named with a version (like ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-global-4.2"),"), the patch version (",(0,o.yg)("inlineCode",{parentName:"p"},"0.0.X"),") of a binary may be changed with minor (",(0,o.yg)("inlineCode",{parentName:"p"},"0.X.0"),") releases."),(0,o.yg)("admonition",{type:"note"},(0,o.yg)("p",{parentName:"admonition"},"Starting with MongoDB version 5.0, the default versions for ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," will only be major ",(0,o.yg)("inlineCode",{parentName:"p"},"X.0.0")," versions (no ",(0,o.yg)("inlineCode",{parentName:"p"},"X.X.0")," versions), see ",(0,o.yg)("a",{parentName:"p",href:"https://docs.mongodb.com/manual/reference/versioning/#std-label-release-version-numbers"},"MongoDB Versioning"),".")),(0,o.yg)("h2",{id:"mongodb-memory-server-core-version-table"},(0,o.yg)("inlineCode",{parentName:"h2"},"mongodb-memory-server-core")," Version Table"),(0,o.yg)("table",null,(0,o.yg)("thead",{parentName:"table"},(0,o.yg)("tr",{parentName:"thead"},(0,o.yg)("th",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"th"},"mongodb-memory-server-core")," Version"),(0,o.yg)("th",{parentName:"tr",align:"center"},"Default MongoDB Version"))),(0,o.yg)("tbody",{parentName:"table"},(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"10.0.x - 10.0.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"7.0.11")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"9.2.x - 9.2.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"6.0.14")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"9.0.x - 9.1.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"6.0.9")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.14.x - 8.16.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.19")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.13.x - 8.13.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.18")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.11.x - 8.12.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.13")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.6.x - 8.10.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.8")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.0.x - 8.5.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.3")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"7.5.x - 7.5.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.27")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"7.0.x - 7.4.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.25")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"6.4.x - 6.9.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.14")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"6.0.x - 6.4.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.3")))),(0,o.yg)("h2",{id:"mongodb-memory-server-global--version-table"},(0,o.yg)("inlineCode",{parentName:"h2"},"mongodb-memory-server-global-*")," Version Table"),(0,o.yg)("p",null,"This Section will show all ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-global-*")," packages that ever existed for this Project, what Version they provide in the latest version and what Branch they will be updated from."),(0,o.yg)("p",null,"If the branch is named like ",(0,o.yg)("inlineCode",{parentName:"p"},"old/"),", then it means that this package will not be updated for new major MMS versions anymore. (Example if the package is in ",(0,o.yg)("inlineCode",{parentName:"p"},"old/6.x"),", then it will not get any updates to MMS 7.0 or higher)"),(0,o.yg)("table",null,(0,o.yg)("thead",{parentName:"table"},(0,o.yg)("tr",{parentName:"thead"},(0,o.yg)("th",{parentName:"tr",align:"center"},"Package Name"),(0,o.yg)("th",{parentName:"tr",align:"center"},"Provided MongoDB Version"),(0,o.yg)("th",{parentName:"tr",align:"center"},"Current Branch"))),(0,o.yg)("tbody",{parentName:"table"},(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.4")),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.4.28"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"master"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.2")),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.2.24"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"master"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.0")),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.28"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"master"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-3.6")),(0,o.yg)("td",{parentName:"tr",align:"center"},"3.6.23"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"old/7.x"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-3.4")),(0,o.yg)("td",{parentName:"tr",align:"center"},"3.4.20"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"old/6.x"))))))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[261],{5680:function(e,r,n){n.d(r,{xA:function(){return d},yg:function(){return c}});var t=n(6540);function a(e,r,n){return r in e?Object.defineProperty(e,r,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[r]=n,e}function o(e,r){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);r&&(t=t.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),n.push.apply(n,t)}return n}function i(e){for(var r=1;r=0||(a[n]=e[n]);return a}(e,r);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var m=t.createContext({}),l=function(e){var r=t.useContext(m),n=r;return e&&(n="function"==typeof e?e(r):i(i({},r),e)),n},d=function(e){var r=l(e.components);return t.createElement(m.Provider,{value:r},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var r=e.children;return t.createElement(t.Fragment,{},r)}},y=t.forwardRef((function(e,r){var n=e.components,a=e.mdxType,o=e.originalType,m=e.parentName,d=g(e,["components","mdxType","originalType","parentName"]),s=l(n),y=a,c=s["".concat(m,".").concat(y)]||s[y]||p[y]||o;return n?t.createElement(c,i(i({ref:r},d),{},{components:n})):t.createElement(c,i({ref:r},d))}));function c(e,r){var n=arguments,a=r&&r.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=y;var g={};for(var m in r)hasOwnProperty.call(r,m)&&(g[m]=r[m]);g.originalType=e,g[s]="string"==typeof e?e:a,i[1]=g;for(var l=2;lmongodb-memory-server-core Version Table",id:"mongodb-memory-server-core-version-table",level:2},{value:"mongodb-memory-server-global-* Version Table",id:"mongodb-memory-server-global--version-table",level:2}],p={toc:s},y="wrapper";function c(e){var r=e.components,n=(0,a.A)(e,i);return(0,o.yg)(y,(0,t.A)({},p,n,{components:r,mdxType:"MDXLayout"}),(0,o.yg)("p",null,"This Guide will show what MongoDB Server versions are / were the default for versions of ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," and the guidelines of when a version gets changed."),(0,o.yg)("p",null,(0,o.yg)("em",{parentName:"p"},(0,o.yg)("sub",null,"Some expressions will use ",(0,o.yg)("a",{parentName:"em",href:"https://www.npmjs.com/package/semver"},"npm's semver convention"),"."))),(0,o.yg)("h2",{id:"when-a-version-gets-upgraded"},"When a Version gets upgraded"),(0,o.yg)("p",null,"In a new major version of ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.yg)("inlineCode",{parentName:"p"},"X.0.0"),"), the default mongodb binary version may be upgraded to any newer version (",(0,o.yg)("inlineCode",{parentName:"p"},"X.X.X"),").",(0,o.yg)("br",{parentName:"p"}),"\n","In a minor version of ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.yg)("inlineCode",{parentName:"p"},"0.X.0"),"), the default mongodb binary version may be upgraded to the latest patch version ",(0,o.yg)("inlineCode",{parentName:"p"},"0.0.X"),".",(0,o.yg)("br",{parentName:"p"}),"\n","In a patch version of ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.yg)("inlineCode",{parentName:"p"},"0.0.X"),"), the default mongodb binary version will not be changed."),(0,o.yg)("p",null,"There are some exceptions:"),(0,o.yg)("ul",null,(0,o.yg)("li",{parentName:"ul"},"A mongodb binary may go offline (not being able to download it anymore), then the default version will be changed and a ",(0,o.yg)("em",{parentName:"li"},"minor")," (",(0,o.yg)("inlineCode",{parentName:"li"},"0.X.0"),") release will happen."),(0,o.yg)("li",{parentName:"ul"},"A mongodb binary may be broken, then the default version will be changed and a ",(0,o.yg)("em",{parentName:"li"},"minor")," (",(0,o.yg)("inlineCode",{parentName:"li"},"0.X.0"),") release will happen.")),(0,o.yg)("p",null,"The versions with a broken default binary may get deprecated (when possible)."),(0,o.yg)("p",null,"For Packages that are named with a version (like ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-global-4.2"),"), the patch version (",(0,o.yg)("inlineCode",{parentName:"p"},"0.0.X"),") of a binary may be changed with minor (",(0,o.yg)("inlineCode",{parentName:"p"},"0.X.0"),") releases."),(0,o.yg)("admonition",{type:"note"},(0,o.yg)("p",{parentName:"admonition"},"Starting with MongoDB version 5.0, the default versions for ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," will only be major ",(0,o.yg)("inlineCode",{parentName:"p"},"X.0.0")," versions (no ",(0,o.yg)("inlineCode",{parentName:"p"},"X.X.0")," versions), see ",(0,o.yg)("a",{parentName:"p",href:"https://docs.mongodb.com/manual/reference/versioning/#std-label-release-version-numbers"},"MongoDB Versioning"),".")),(0,o.yg)("h2",{id:"mongodb-memory-server-core-version-table"},(0,o.yg)("inlineCode",{parentName:"h2"},"mongodb-memory-server-core")," Version Table"),(0,o.yg)("table",null,(0,o.yg)("thead",{parentName:"table"},(0,o.yg)("tr",{parentName:"thead"},(0,o.yg)("th",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"th"},"mongodb-memory-server-core")," Version"),(0,o.yg)("th",{parentName:"tr",align:"center"},"Default MongoDB Version"))),(0,o.yg)("tbody",{parentName:"table"},(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"10.1.x - 10.1.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"7.0.14")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"10.0.x - 10.0.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"7.0.11")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"9.2.x - 9.2.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"6.0.14")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"9.0.x - 9.1.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"6.0.9")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.14.x - 8.16.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.19")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.13.x - 8.13.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.18")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.11.x - 8.12.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.13")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.6.x - 8.10.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.8")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"8.0.x - 8.5.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"5.0.3")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"7.5.x - 7.5.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.27")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"7.0.x - 7.4.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.25")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"6.4.x - 6.9.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.14")),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},"6.0.x - 6.4.x"),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.3")))),(0,o.yg)("h2",{id:"mongodb-memory-server-global--version-table"},(0,o.yg)("inlineCode",{parentName:"h2"},"mongodb-memory-server-global-*")," Version Table"),(0,o.yg)("p",null,"This Section will show all ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server-global-*")," packages that ever existed for this Project, what Version they provide in the latest version and what Branch they will be updated from."),(0,o.yg)("p",null,"If the branch is named like ",(0,o.yg)("inlineCode",{parentName:"p"},"old/"),", then it means that this package will not be updated for new major MMS versions anymore. (Example if the package is in ",(0,o.yg)("inlineCode",{parentName:"p"},"old/6.x"),", then it will not get any updates to MMS 7.0 or higher)"),(0,o.yg)("table",null,(0,o.yg)("thead",{parentName:"table"},(0,o.yg)("tr",{parentName:"thead"},(0,o.yg)("th",{parentName:"tr",align:"center"},"Package Name"),(0,o.yg)("th",{parentName:"tr",align:"center"},"Provided MongoDB Version"),(0,o.yg)("th",{parentName:"tr",align:"center"},"Current Branch"))),(0,o.yg)("tbody",{parentName:"table"},(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.4")),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.4.28"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"master"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.2")),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.2.24"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"master"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.0")),(0,o.yg)("td",{parentName:"tr",align:"center"},"4.0.28"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"master"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-3.6")),(0,o.yg)("td",{parentName:"tr",align:"center"},"3.6.23"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"old/7.x"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-3.4")),(0,o.yg)("td",{parentName:"tr",align:"center"},"3.4.20"),(0,o.yg)("td",{parentName:"tr",align:"center"},(0,o.yg)("inlineCode",{parentName:"td"},"old/6.x"))))))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.5ef48574.js b/assets/js/runtime~main.2c2c6139.js similarity index 96% rename from assets/js/runtime~main.5ef48574.js rename to assets/js/runtime~main.2c2c6139.js index 03838ae9..d94b3a23 100644 --- a/assets/js/runtime~main.5ef48574.js +++ b/assets/js/runtime~main.2c2c6139.js @@ -1 +1 @@ -!function(){"use strict";var e,t,r,n,a,f={},o={};function c(e){var t=o[e];if(void 0!==t)return t.exports;var r=o[e]={id:e,loaded:!1,exports:{}};return f[e].call(r.exports,r,r.exports,c),r.loaded=!0,r.exports}c.m=f,c.c=o,e=[],c.O=function(t,r,n,a){if(!r){var f=1/0;for(i=0;i=a)&&Object.keys(c.O).every((function(e){return c.O[e](r[d])}))?r.splice(d--,1):(o=!1,a0&&e[i-1][2]>a;i--)e[i]=e[i-1];e[i]=[r,n,a]},c.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return c.d(t,{a:t}),t},r=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},c.t=function(e,n){if(1&n&&(e=this(e)),8&n)return e;if("object"==typeof e&&e){if(4&n&&e.__esModule)return e;if(16&n&&"function"==typeof e.then)return e}var a=Object.create(null);c.r(a);var f={};t=t||[null,r({}),r([]),r(r)];for(var o=2&n&&e;"object"==typeof o&&!~t.indexOf(o);o=r(o))Object.getOwnPropertyNames(o).forEach((function(t){f[t]=function(){return e[t]}}));return f.default=function(){return e},c.d(a,f),a},c.d=function(e,t){for(var r in t)c.o(t,r)&&!c.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},c.f={},c.e=function(e){return Promise.all(Object.keys(c.f).reduce((function(t,r){return c.f[r](e,t),t}),[]))},c.u=function(e){return"assets/js/"+({11:"6d7d5585",26:"a97422aa",73:"7f2a500a",87:"75d87773",110:"44df2d52",153:"af543849",244:"12f3979d",260:"d5016940",261:"9082ebdf",287:"8f715786",291:"83cdaeac",292:"66a4ae68",353:"32c6e8e6",354:"faafc594",358:"111fcaee",362:"ca5259b8",401:"17896441",416:"b46a53f4",426:"e3728ee4",452:"812a5cd9",458:"1cfa44aa",503:"a8d48a20",506:"b0db94fd",537:"9f6ab2c9",581:"935f2afb",595:"e9ab2b32",598:"a5852e81",602:"fc8b4723",634:"c4f5d8e4",690:"6fc6bd8d",691:"ea46b895",706:"9795f834",712:"d351376f",714:"1be78505",754:"24f38be7",814:"f9ecf5d9",815:"088ea2b2",851:"28ece197",888:"84a84a34",890:"1bdfe715",963:"85f7b89a",973:"db74d20c"}[e]||e)+"."+{11:"c78ba8c4",26:"6196a1a2",73:"6574e89c",87:"fcf4f8ce",110:"d56d6678",153:"ed0acd37",244:"7ea1d274",260:"b55e0830",261:"dd089d94",287:"f986d602",291:"4b7de614",292:"3438cff4",353:"ee77b853",354:"6278622b",358:"da60d174",362:"06396863",401:"869ac5de",416:"afca2b6e",426:"884ec387",452:"91062a0e",458:"17d0eb64",503:"3b9558a9",506:"42364ff9",537:"2055a04e",581:"3691dd17",595:"e6fa4011",598:"6e284725",602:"f1e3fbe1",634:"6b49d40d",690:"9ebe3e1d",691:"c7d5235c",706:"41690aba",712:"ba3000bd",714:"9a55653b",754:"2cf6d8ab",774:"3a7b2b43",814:"d6473097",815:"46a5db36",851:"8d506c68",888:"c64b8d14",890:"ce84fdc7",963:"de5ac5b2",973:"8a8e9f59"}[e]+".js"},c.miniCssF=function(e){},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n={},a="mongodb-memory-server-website:",c.l=function(e,t,r,f){if(n[e])n[e].push(t);else{var o,d;if(void 0!==r)for(var u=document.getElementsByTagName("script"),i=0;i=a)&&Object.keys(c.O).every((function(e){return c.O[e](r[d])}))?r.splice(d--,1):(o=!1,a0&&e[i-1][2]>a;i--)e[i]=e[i-1];e[i]=[r,n,a]},c.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return c.d(t,{a:t}),t},r=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},c.t=function(e,n){if(1&n&&(e=this(e)),8&n)return e;if("object"==typeof e&&e){if(4&n&&e.__esModule)return e;if(16&n&&"function"==typeof e.then)return e}var a=Object.create(null);c.r(a);var f={};t=t||[null,r({}),r([]),r(r)];for(var o=2&n&&e;"object"==typeof o&&!~t.indexOf(o);o=r(o))Object.getOwnPropertyNames(o).forEach((function(t){f[t]=function(){return e[t]}}));return f.default=function(){return e},c.d(a,f),a},c.d=function(e,t){for(var r in t)c.o(t,r)&&!c.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},c.f={},c.e=function(e){return Promise.all(Object.keys(c.f).reduce((function(t,r){return c.f[r](e,t),t}),[]))},c.u=function(e){return"assets/js/"+({11:"6d7d5585",26:"a97422aa",73:"7f2a500a",87:"75d87773",110:"44df2d52",153:"af543849",244:"12f3979d",260:"d5016940",261:"9082ebdf",287:"8f715786",291:"83cdaeac",292:"66a4ae68",353:"32c6e8e6",354:"faafc594",358:"111fcaee",362:"ca5259b8",401:"17896441",416:"b46a53f4",426:"e3728ee4",452:"812a5cd9",458:"1cfa44aa",503:"a8d48a20",506:"b0db94fd",537:"9f6ab2c9",581:"935f2afb",595:"e9ab2b32",598:"a5852e81",602:"fc8b4723",634:"c4f5d8e4",690:"6fc6bd8d",691:"ea46b895",706:"9795f834",712:"d351376f",714:"1be78505",754:"24f38be7",814:"f9ecf5d9",815:"088ea2b2",851:"28ece197",888:"84a84a34",890:"1bdfe715",963:"85f7b89a",973:"db74d20c"}[e]||e)+"."+{11:"c78ba8c4",26:"6196a1a2",73:"6574e89c",87:"fcf4f8ce",110:"d56d6678",153:"ed0acd37",244:"7ea1d274",260:"b55e0830",261:"dffd00b4",287:"f986d602",291:"4b7de614",292:"3438cff4",353:"ee77b853",354:"6278622b",358:"da60d174",362:"06396863",401:"869ac5de",416:"afca2b6e",426:"884ec387",452:"91062a0e",458:"17d0eb64",503:"3b9558a9",506:"42364ff9",537:"2055a04e",581:"3691dd17",595:"e6fa4011",598:"6e284725",602:"f1e3fbe1",634:"6b49d40d",690:"9ebe3e1d",691:"c7d5235c",706:"41690aba",712:"ba3000bd",714:"9a55653b",754:"dd1fc695",774:"3a7b2b43",814:"d6473097",815:"46a5db36",851:"8d506c68",888:"c64b8d14",890:"ce84fdc7",963:"de5ac5b2",973:"8a8e9f59"}[e]+".js"},c.miniCssF=function(e){},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n={},a="mongodb-memory-server-website:",c.l=function(e,t,r,f){if(n[e])n[e].push(t);else{var o,d;if(void 0!==r)for(var u=document.getElementsByTagName("script"),i=0;i DryMongoBinary | mongodb-memory-server - +

DryMongoBinary

API Documentation of DryMongoBinary-Class

Functions​

note

This class is not actually meant to be constructed, it only consists of static functions & values

locateBinary​

Typings: static async locateBinary(opts: DryMongoBinaryOptions): Promise<string | undefined>

Try to locate a existing binary without downloading or touching the filesystem much.

generateOptions​

Typings: static async generateOptions(opts?: DryMongoBinaryOptions): Promise<Required<DryMongoBinaryOptions>>

Generate a full DryMongoBinaryOptions from partial input.

parseArchiveNameRegex​

Typings: static parseArchiveNameRegex(input: string, opts: Required<DryMongoBinaryOptions>): Required<DryMongoBinaryOptions>

Parse a archive name into useable options.

getBinaryName​

Typings: static async getBinaryName(opts: DryMongoBinaryNameOptions): Promise<string>

Get what the binary name should be formatted like.
If USE_ARCHIVE_NAME_FOR_BINARY_NAME is true, then the archive name will be used instead of what MMS uses by default.

combineBinaryName​

Typings: static combineBinaryName(basePath: string, binaryName: string): string

Helper function to consistently combine a basePath with the binaryName (eg. /path/to/binary)

getSytemPath​

Typings: static async getSystemPath(systemBinary: string): Promise<string | undefined>

Check if the given path has all the permissions required to be executed.

generatePaths​

Typings: static async generatePaths(opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions): Promise<DryMongoBinaryPaths>

Get the Paths where binaries may be located in.

generateDownloadPath​

Typings: static async generateDownloadPath(opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions): Promise<[boolean, string]>

Get the path where the binary will be downloaded to.

homedir​

Internal

Typings: private static homedir(): string

Used to get the Home-Dir of the current user, it is a function on the class for easy-mocking, because os.homedir cannot be easily be mocked in jest.

Values​

binaryCache​

Typings: static binaryCache: Map<string, string> = new Map()

Cache for already found binaries to not hit the filesystem too much.

- + \ No newline at end of file diff --git a/docs/api/classes/mongo-binary/index.html b/docs/api/classes/mongo-binary/index.html index e30516c8..f352c64a 100644 --- a/docs/api/classes/mongo-binary/index.html +++ b/docs/api/classes/mongo-binary/index.html @@ -4,14 +4,14 @@ MongoBinary | mongodb-memory-server - +

MongoBinary

API Documentation of MongoBinary-Class

Functions​

note

This class is not actually meant to be constructed, it only consists of static functions & values

download​

Typings: static async download(options: Required<MongoBinaryOpts>): Promise<string>

Try to find the binary and if not found download the binary.

getPath​

Typings: static async getPath(opts: MongoBinaryOpts = {}): Promise<string>

Get a working binary and returns the path to it.
(Calls download if RUNTIME_DOWNLOAD is true)

- + \ No newline at end of file diff --git a/docs/api/classes/mongo-instance/index.html b/docs/api/classes/mongo-instance/index.html index 01dad17f..2bedf76b 100644 --- a/docs/api/classes/mongo-instance/index.html +++ b/docs/api/classes/mongo-instance/index.html @@ -4,14 +4,14 @@ MongoInstance | mongodb-memory-server - +

MongoInstance

API Documentation of MongoInstance-Class

Functions​

new​

Typings: constructor(opts: Partial<MongodOpts>)

Create an new Instance without starting it

tip

When directly starting the instance, run should be used

debug​

Typings: private debug(msg: string): void

Format input with debug-message template

create​

Typings: static async create(opts: Partial<MongodOpts>): Promise<MongoInstance>

Create an new Instance and start it (while being an Promise)

prepareCommandArgs​

Typings: prepareCommandArgs(): string[]

Constructs the Command Arguments

start​

Typings: async start(): Promise<void>

Start the mongod and the watcher processes

caution

Currently does not check if the instance is in a correct state and just resets all values, see #662.

stop​

Typings: async stop(): Promise<boolean>

Stop the mongod and the watcher processes

caution

Will not Error if instance is not running

_launchMongod​

Internal

Typings: _launchMongod(mongoBin: string): ChildProcess

Actually spawn the mongod process with ChildProcess, used by run

_launchKiller​

Internal

Typings: _launchKiller(parentPid: number, childPid: number): ChildProcess

Spawn an killer process that keeps watch over the mongod process

errorHandler​

Internal

Typings: errorHandler(err: string): void

Error handler for the mongod process

closeHandler​

Internal

Typings: closeHandler(code: number, signal: string): void

Close handler for the mongod process

stderrHandler​

Internal

Typings: stderrHandler(message: string | Buffer): void

STDERR handler for the mongod process

stdoutHandler​

Internal

Typings: stdoutHandler(message: string | Buffer): void

STDOUT handler for the mongod process
Matches process output against known formats and raise events

Values​

instanceOpts​

Typings: instanceOpts: MongoInstanceOpts

Stores the Instance Options

binaryOpts​

Typings: readonly binaryOpts: Readonly<MongoBinaryOpts>

Stores the Binary Options

spawnOpts​

Typings: readonly spawnOpts: Readonly<SpawnOptions>

Stores the Spawn Options

extraConnectionOptions​

Internal

Typings: extraConnectionOptions?: MongoClientOptions

Contains extra Connection options used for mongoClient.connect, this is mainly used for authentication

mongodProcess​

Internal

Typings: mongodProcess?: ChildProcess

Stores the active process reference for the mongod process

killerProcess​

Internal

Typings: killerProcess?: ChildProcess

Stores the active process reference for the killer process

isInstancePrimary​

Typings: isInstancePrimary: boolean

Stores that the process is an Primary (ReplSet) (event emitted when found in STDOUT)

isInstanceReady​

Typings: isInstanceReady: boolean (event emitted when found in STDOUT)

Stores that the process is fully started

isReplSet​

Typings: isReplSet: boolean

Stores that the process is in an ReplSet, is true when instanceOpts.replSet is defined and truthy

- + \ No newline at end of file diff --git a/docs/api/classes/mongo-memory-replset/index.html b/docs/api/classes/mongo-memory-replset/index.html index 20bb24e1..3cbffca3 100644 --- a/docs/api/classes/mongo-memory-replset/index.html +++ b/docs/api/classes/mongo-memory-replset/index.html @@ -4,7 +4,7 @@ MongoMemoryReplSet | mongodb-memory-server - + @@ -13,7 +13,7 @@ When setting otherDbName, the value of otherDbName will be appended after / and before any query arguments.
When setting otherIp, the ip will be the value of otherIp instead of 127.0.0.1 (for all instances).

start​

Typings: async start(): Promise<void>

Used to start an new ReplSet or to Re-Start an stopped ReplSet

caution

Will Error if ReplSet is already running

initAllServers​

Internal

Typings: protected async initAllServers(): Promise<void>

Used by start and to restart without fully running everything again

ensureKeyFile​

Internal

Typings: protected async ensureKeyFile(): Promise<string>

Ensures and returns that _keyfiletmp is defined an exists and also that the keyfile is created

stop​

Typings: async stop(cleanupOptions?: Cleanup): Promise<boolean>

Stop an running instance, this function will by default call .cleanup with { doCleanup: true, force: false }.

With cleanupOptions options for cleanup can be manually set.

caution

Will not Error if instance is not running

cleanup​

Typings: async cleanup(options?: Cleanup): Promise<void>

Cleanup all files used by this ReplSet's instances, by default { doCleanup: true, force: false } is used.

With options can be set how to run a cleanup.

waitUntilRunning​

Typings: async waitUntilRunning(): Promise<void>

Wait until all instances are running.

It is recommended to await the promise returned from start when available.

Does not start the replset instance if not already starting (unlike ensureInstance).

caution

Will Error if state is not running or init.

caution

Will not Error if a error is encountered while waiting.

_initReplSet​

Internal

Typings: protected async _initReplSet(): Promise<void>

This is used to connect to the first server and initiate the ReplSet with an command
Also enables auth

_initServer​

Internal

Typings: protected _initServer(instanceOpts: MongoMemoryInstanceProp): MongoMemoryServer

Creates an new instance for the ReplSet

_waitForPrimary​

Internal

Typings: protected async _waitForPrimary(timeout: number = 1000 * 30, where?: string): Promise<void>

Wait until the ReplSet has elected an Primary, the where string will be added to the error if the timeout is reached

Values​

servers​

Typings: servers: MongoMemoryServer[]

Stores all the servers of this ReplSet

instanceOpts​

Typings:

  • get instanceOpts(): MongoMemoryInstancePropBase[]
  • set instanceOpts(val: MongoMemoryInstancePropBase[])

Getter & Setter for _instanceOpts

caution

Will Throw an Error if state is not stopped

_instanceOpts​

Internal

Typings: protected _instanceOpts!: MongoMemoryInstancePropBase[]

Stores Options used for an instance

binaryOpts​

Typings:

  • get binaryOpts(): MongoBinaryOpts
  • set binaryOpts(val: MongoBinaryOpts)

Getter & Setter for _binaryOpts

caution

Will Throw an Error if state is not stopped

_binaryOpts​

Internal

Typings: protected _binaryOpts!: MongoBinaryOpts

Stores the options used for the binary

replSetOpts​

Typings:

  • get replSetOpts(): ReplSetOpts
  • set replSetOpts(val: ReplSetOpts)

Getter & Setter for _replSetOpts

caution

Will Throw an Error if state is not stopped

_replSetOpts​

Internal

Typings: protected _replSetOpts!: Required<ReplSetOpts>

Stores the options used for the ReplSet Initiation, uses ReplSetOpts.

_keyfiletmp​

Internal

Typings: protected _keyfiletmp?: string

Stores the path of the created temporary directory for the keyfile location

state​

Typings: get state(): MongoMemoryReplSetStates

Getter for _state

caution

Will Throw an Error if state is not stopped

_state​

Internal

Typings: protected _state: MongoMemoryReplSetStates

Stores the current State, uses MongoMemoryReplSetStates enum.

_ranCreateAuth​

Internal

Typings: protected _ranCreateAuth: boolean

Stores if the auth creation has already ran

- + \ No newline at end of file diff --git a/docs/api/classes/mongo-memory-server/index.html b/docs/api/classes/mongo-memory-server/index.html index 6b7ba8b8..12e9b1c0 100644 --- a/docs/api/classes/mongo-memory-server/index.html +++ b/docs/api/classes/mongo-memory-server/index.html @@ -4,7 +4,7 @@ MongoMemoryServer | mongodb-memory-server - + @@ -15,7 +15,7 @@ When setting otherDbName, the value of otherDbName will be appended after / and before any query arguments.
When setting otherIp, the ip will be the value of otherIp instead of 127.0.0.1.

createAuth​

Internal

Typings: async createAuth(data: StartupInstanceData): Promise<void>

Logs in into the currently running instance and restarts it with auth enabled

info

The Instance will not be restarted if the storage engine is ephemeralForTest because data will not persist across restarts
It is still usefull if an user is always required in connection logic and mongodb throws an error that an user does not exists / cannot login

Values​

instanceInfo​

Typings: get instanceInfo(): MongoInstanceData | undefined

Getter for _instanceInfo

_instanceInfo​

Internal

Typings: protected _instanceInfo?: MongoInstanceData

Stores the instance information

opts​

Typings: opts: MongoMemoryServerOpts

Store the instance options, uses MongoMemoryServerOpts.

state​

Typings: get state(): MongoMemoryServerStates

Getter for _state_

_state​

Internal

Typings: protected _state: MongoMemoryServerStates

Stores the current State, uses MongoMemoryServerStates enum.

auth​

Typings: readonly auth?: Required<AutomaticAuth>

Stores automatic auth creation options, uses AutomaticAuth with all values defined.

- + \ No newline at end of file diff --git a/docs/api/config-options/index.html b/docs/api/config-options/index.html index 705b1857..4033273c 100644 --- a/docs/api/config-options/index.html +++ b/docs/api/config-options/index.html @@ -4,15 +4,15 @@ Config Options | mongodb-memory-server - +

Config Options

List of all Config Options

List of Config Options​

DOWNLOAD_DIR​

Environment VariablePackageJson
MONGOMS_DOWNLOAD_DIRdownloadDir

Option DOWNLOAD_DIR is used to set where the binaries will be located in, this will overwrite all other directories

Directory Priority:

  1. DOWNLOAD_DIR (Environment Variable over package.json)
  2. ~/.cache/mongodb-binaries (Home Directory Cache) (if PREFER_GLOBAL_PATH is active, or binary already exists)
  3. projectRoot/node_modules/.cache/mongodb-binaries (node-modules cache)
  4. ./mongodb-binaries (relative to process.cwd())
note

Resolving the node_modules/.cache can be rather inconsistent depending on what package manager is used and from where the script is started.

A way to force a more specific node_modules/.cache to be used (like a workspace's) is to set the package.json config for mongodb-memory-server (there needs to be at least one key, it does not matter if it is a actual config option or not), see How to use them in the package.json. -Example:

{
  "name": "workspace",
  // along with your other workspace keys
  "config": {
    "mongodbMemoryServer": {
      "_": 0
    }
  }
}

Format:

  • /path/to/binary/ (POSIX)
  • C:/path/to/binary/ (DOS)

PLATFORM​

Environment VariablePackageJson
MONGOMS_PLATFORMplatform

Option PLATFORM is used to overwrite which platform should be downloaded

Valid Options are win32, darwin, linux, sunos(never actually supported, will be removed in 9.0)

ARCH​

Environment VariablePackageJson
MONGOMS_ARCHarch

Option ARCH is used to overwrite the Architecture to download for

Valid Options are x64, arm64

See here for what versions are available for what architectures

DISTRO​

Environment VariablePackageJson
MONGOMS_DISTROdistro

Option DISTRO is used to overwrite the Distribution used instead of the detected one.

Only works for when PLATFORM (automatic or manually set) is linux.

Format is distro-release, both distro and release need to be always defined.

Example: ubuntu-18.04

See here for what versions are available for what distros

VERSION​

Environment VariablePackageJson
MONGOMS_VERSIONversion

Option VERSION is used to set what mongodb version should be downloaded

Default: 7.0.11 (see Mongodb Server Versions for a complete list and policy)

This Option does not have a effect when ARCHIVE_NAME or DOWNLOAD_URL is defined.

Common MongoDB Version formats (X is a number):

  • X.X.X
  • vX.X-latest

Search for what Versions are available

note

When using SYSTEM_BINARY and SYSTEM_BINARY_VERSION_CHECK, ONLY the major, minor, and patch versions of the system binary will be compared against the desired binary.

That is, a system binary version of 4.2.19-11-ge2f2736a will match a mongodb required version of 4.2.19. DO NOT set the mongodb required version to the full 4.2.19-11-ge2f2736a version as the check which examines the binary version will strip the additional tags.

DEBUG​

Environment VariablePackageJson
MONGOMS_DEBUGdebug

Option DEBUG is used to enable Debug Output

DOWNLOAD_MIRROR​

Environment VariablePackageJson
MONGOMS_DOWNLOAD_MIRRORdownloadMirror

Option DOWNLOAD_MIRROR is used to set which mirror to use

Default / Format: https://fastdl.mongodb.org (protocol needs to be included)

Also supported is adding an path https://someserver.com/some/path/for/mongodb.

note

It is discouraged to use query parameters, they may work, but not officially supported

DOWNLOAD_URL​

Environment VariablePackageJson
MONGOMS_DOWNLOAD_URLdownloadUrl

Option DOWNLOAD_URL is used to overwrite the complete URL (including DOWNLOAD_MIRROR)

Format: https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1604-4.0.20.tgz

DOWNLOAD_IGNORE_MISSING_HEADER​

Environment VariablePackageJson
DOWNLOAD_IGNORE_MISSING_HEADERdownloadIgnoreMissingHeader

Option DOWNLOAD_IGNORE_MISSING_HEADER can be set to true to ignore missing response headers like content-length.

Default: false

PREFER_GLOBAL_PATH​

Environment VariablePackageJson
MONGOMS_PREFER_GLOBAL_PATHpreferGlobalPath

Option PREFER_GLOBAL_PATH is used to force download into ~/.cache/mongodb-binaries instead of local folder

DISABLE_POSTINSTALL​

Environment VariablePackageJson
MONGOMS_DISABLE_POSTINSTALLdisablePostinstall

Option DISABLE_POSTINSTALL is used to skip all postinstall scripts

SYSTEM_BINARY​

Environment VariablePackageJson
MONGOMS_SYSTEM_BINARYsystemBinary

Option SYSTEM_BINARY is used to set the path to an system binary already existing on the system

Format:

  • /path/to/binary/mongod (POSIX)
  • C:/path/to/binary/mongod.exe (DOS)

SYSTEM_BINARY_VERSION_CHECK​

Environment VariablePackageJson
MONGOMS_SYSTEM_BINARY_VERSION_CHECKsystemBinaryVersionCheck

Option SYSTEM_BINARY_VERSION_CHECK is used to disable the version conflict check if SYSTEM_BINARY is set and version returned from mongod_system_binary --version does not match VERSION

Default: true

MD5_CHECK​

Environment VariablePackageJson
MONGOMS_MD5_CHECKmd5Check

Option MD5_CHECK is used to enable an md5 check after download

Default: true

ARCHIVE_NAME​

Environment VariablePackageJson
MONGOMS_ARCHIVE_NAMEarchiveName

Option ARCHIVE_NAME is used to overwrite the complete archive name

Format: mongodb-linux-x86_64-ubuntu1604-4.0.20.tgz

See here for what archive names are available

This Option does not have a effect when DOWNLOAD_URL is defined.

RUNTIME_DOWNLOAD​

Environment VariablePackageJson
MONGOMS_RUNTIME_DOWNLOADruntimeDownload

Option RUNTIME_DOWNLOAD is used to disable downloading while being in something like .start

Default: true

USE_HTTP​

Environment VariablePackageJson
MONGOMS_USE_HTTPuseHttp

Option USE_HTTP is used to use http over https

Default: false

MAX_REDIRECTS​

Environment VariablePackageJson
MONGOMS_MAX_REDIRECTSmaxRedirects

Option MAX_REDIRECTS is used to set the maximal amount of redirects to follow

Default: 2

USE_ARCHIVE_NAME_FOR_BINARY_NAME​

Environment VariablePackageJson
MONGOMS_USE_ARCHIVE_NAME_FOR_BINARY_NAMEuseArchiveNameForBinaryName

Option USE_ARCHIVE_NAME_FOR_BINARY_NAME is used to use the archive name as binary

Default: false

This can resolve conflicts when resolving binary names for different systems changes between versions (like support for ubuntu 22.04 becoming available instead of using 20.04) or if the same cache is shared between different distros (like docker pass-through).

Example:

By default the binary name gets set like mongod-ARCH-CURRENT_DISTRO-VERSION (mongod-x64-ubuntu-6.0.4), but with this option it will use the downloaded archive name (without extension) like mongodb-linux-x86_64-ubuntu2004-6.0.4.

Also see ARCHIVE_NAME.

note

Keep in mind that downloaded binaries will never be automatically deleted.

How to use them in the package.json​

To use the config options in the package.json, they need to be camelCased (and without _), and need to be in the property config.mongodbMemoryServer

Example:

{
  "config": {
    "mongodbMemoryServer": {
      "downloadDir": "/path/to/DownloadDir"
    }
  }
}

By default it uses the nearest (upwards) package.json to process.cwd(). +Example:

{
  "name": "workspace",
  // along with your other workspace keys
  "config": {
    "mongodbMemoryServer": {
      "_": 0
    }
  }
}

Format:

  • /path/to/binary/ (POSIX)
  • C:/path/to/binary/ (DOS)

PLATFORM​

Environment VariablePackageJson
MONGOMS_PLATFORMplatform

Option PLATFORM is used to overwrite which platform should be downloaded

Valid Options are win32, darwin, linux, sunos(never actually supported, will be removed in 9.0)

ARCH​

Environment VariablePackageJson
MONGOMS_ARCHarch

Option ARCH is used to overwrite the Architecture to download for

Valid Options are x64, arm64

See here for what versions are available for what architectures

DISTRO​

Environment VariablePackageJson
MONGOMS_DISTROdistro

Option DISTRO is used to overwrite the Distribution used instead of the detected one.

Only works for when PLATFORM (automatic or manually set) is linux.

Format is distro-release, both distro and release need to be always defined.

Example: ubuntu-18.04

See here for what versions are available for what distros

VERSION​

Environment VariablePackageJson
MONGOMS_VERSIONversion

Option VERSION is used to set what mongodb version should be downloaded

Default: 7.0.14 (see Mongodb Server Versions for a complete list and policy)

This Option does not have a effect when ARCHIVE_NAME or DOWNLOAD_URL is defined.

Common MongoDB Version formats (X is a number):

  • X.X.X
  • vX.X-latest

Search for what Versions are available

note

When using SYSTEM_BINARY and SYSTEM_BINARY_VERSION_CHECK, ONLY the major, minor, and patch versions of the system binary will be compared against the desired binary.

That is, a system binary version of 4.2.19-11-ge2f2736a will match a mongodb required version of 4.2.19. DO NOT set the mongodb required version to the full 4.2.19-11-ge2f2736a version as the check which examines the binary version will strip the additional tags.

DEBUG​

Environment VariablePackageJson
MONGOMS_DEBUGdebug

Option DEBUG is used to enable Debug Output

DOWNLOAD_MIRROR​

Environment VariablePackageJson
MONGOMS_DOWNLOAD_MIRRORdownloadMirror

Option DOWNLOAD_MIRROR is used to set which mirror to use

Default / Format: https://fastdl.mongodb.org (protocol needs to be included)

Also supported is adding an path https://someserver.com/some/path/for/mongodb.

note

It is discouraged to use query parameters, they may work, but not officially supported

DOWNLOAD_URL​

Environment VariablePackageJson
MONGOMS_DOWNLOAD_URLdownloadUrl

Option DOWNLOAD_URL is used to overwrite the complete URL (including DOWNLOAD_MIRROR)

Format: https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1604-4.0.20.tgz

DOWNLOAD_IGNORE_MISSING_HEADER​

Environment VariablePackageJson
DOWNLOAD_IGNORE_MISSING_HEADERdownloadIgnoreMissingHeader

Option DOWNLOAD_IGNORE_MISSING_HEADER can be set to true to ignore missing response headers like content-length.

Default: false

PREFER_GLOBAL_PATH​

Environment VariablePackageJson
MONGOMS_PREFER_GLOBAL_PATHpreferGlobalPath

Option PREFER_GLOBAL_PATH is used to force download into ~/.cache/mongodb-binaries instead of local folder

DISABLE_POSTINSTALL​

Environment VariablePackageJson
MONGOMS_DISABLE_POSTINSTALLdisablePostinstall

Option DISABLE_POSTINSTALL is used to skip all postinstall scripts

SYSTEM_BINARY​

Environment VariablePackageJson
MONGOMS_SYSTEM_BINARYsystemBinary

Option SYSTEM_BINARY is used to set the path to an system binary already existing on the system

Format:

  • /path/to/binary/mongod (POSIX)
  • C:/path/to/binary/mongod.exe (DOS)

SYSTEM_BINARY_VERSION_CHECK​

Environment VariablePackageJson
MONGOMS_SYSTEM_BINARY_VERSION_CHECKsystemBinaryVersionCheck

Option SYSTEM_BINARY_VERSION_CHECK is used to disable the version conflict check if SYSTEM_BINARY is set and version returned from mongod_system_binary --version does not match VERSION

Default: true

MD5_CHECK​

Environment VariablePackageJson
MONGOMS_MD5_CHECKmd5Check

Option MD5_CHECK is used to enable an md5 check after download

Default: true

ARCHIVE_NAME​

Environment VariablePackageJson
MONGOMS_ARCHIVE_NAMEarchiveName

Option ARCHIVE_NAME is used to overwrite the complete archive name

Format: mongodb-linux-x86_64-ubuntu1604-4.0.20.tgz

See here for what archive names are available

This Option does not have a effect when DOWNLOAD_URL is defined.

RUNTIME_DOWNLOAD​

Environment VariablePackageJson
MONGOMS_RUNTIME_DOWNLOADruntimeDownload

Option RUNTIME_DOWNLOAD is used to disable downloading while being in something like .start

Default: true

USE_HTTP​

Environment VariablePackageJson
MONGOMS_USE_HTTPuseHttp

Option USE_HTTP is used to use http over https

Default: false

MAX_REDIRECTS​

Environment VariablePackageJson
MONGOMS_MAX_REDIRECTSmaxRedirects

Option MAX_REDIRECTS is used to set the maximal amount of redirects to follow

Default: 2

USE_ARCHIVE_NAME_FOR_BINARY_NAME​

Environment VariablePackageJson
MONGOMS_USE_ARCHIVE_NAME_FOR_BINARY_NAMEuseArchiveNameForBinaryName

Option USE_ARCHIVE_NAME_FOR_BINARY_NAME is used to use the archive name as binary

Default: false

This can resolve conflicts when resolving binary names for different systems changes between versions (like support for ubuntu 22.04 becoming available instead of using 20.04) or if the same cache is shared between different distros (like docker pass-through).

Example:

By default the binary name gets set like mongod-ARCH-CURRENT_DISTRO-VERSION (mongod-x64-ubuntu-6.0.4), but with this option it will use the downloaded archive name (without extension) like mongodb-linux-x86_64-ubuntu2004-6.0.4.

Also see ARCHIVE_NAME.

note

Keep in mind that downloaded binaries will never be automatically deleted.

How to use them in the package.json​

To use the config options in the package.json, they need to be camelCased (and without _), and need to be in the property config.mongodbMemoryServer

Example:

{
  "config": {
    "mongodbMemoryServer": {
      "downloadDir": "/path/to/DownloadDir"
    }
  }
}

By default it uses the nearest (upwards) package.json to process.cwd(). To change this:

import { findPackageJson } from "mongodb-memory-server-core/lib/util/resolveConfig";

findPackageJson('/custom/path');

// OR

process.chdir('/custom/path'); // not recommended

How to use them as Environment Variables​

For Environment Variables an config option must be prefixed with MONGOMS_

Example: MONGOMS_DOWNLOAD_DIR

For boolean Variables, the following will be interpreted as true: true 1 on yes

- + \ No newline at end of file diff --git a/docs/api/enums/mongo-memory-replset-states/index.html b/docs/api/enums/mongo-memory-replset-states/index.html index bf2a4a80..fba4dee3 100644 --- a/docs/api/enums/mongo-memory-replset-states/index.html +++ b/docs/api/enums/mongo-memory-replset-states/index.html @@ -4,13 +4,13 @@ MongoMemoryReplSetStates | mongodb-memory-server - +

MongoMemoryReplSetStates

API Documentation of MongoMemoryReplSetStates-Enum

Members​

init​

Value: init

Indicates that the instance is currently starting.

running​

Value: running

Indicates that the instance is currently running.

stopped​

Value: stopped

Indicates that the instance is currently stopped.

- + \ No newline at end of file diff --git a/docs/api/enums/mongo-memory-server-states/index.html b/docs/api/enums/mongo-memory-server-states/index.html index d4cfa2fb..46f248b4 100644 --- a/docs/api/enums/mongo-memory-server-states/index.html +++ b/docs/api/enums/mongo-memory-server-states/index.html @@ -4,13 +4,13 @@ MongoMemoryServerStates | mongodb-memory-server - +

MongoMemoryServerStates

API Documentation of MongoMemoryServerStates-Enum

Members​

new​

Value: new

Indicates that the instance is still a new instance that has never been started.

starting​

Value: starting

Indicates that the instance is currently starting.

running​

Value: running

Indicates that the instance is currently running.

stopped​

Value: stopped

Indicates that the instance is currently stopped.

- + \ No newline at end of file diff --git a/docs/api/index-api/index.html b/docs/api/index-api/index.html index 23286e47..24a31811 100644 --- a/docs/api/index-api/index.html +++ b/docs/api/index-api/index.html @@ -4,13 +4,13 @@ Welcome to the API | mongodb-memory-server - +

Welcome to the API

In API will be documented what functions & values do, even internal protected / private ones

Interfaces & Options​

To get the options, the tsdoc (source) should be used directly (FAQ)

- + \ No newline at end of file diff --git a/docs/api/index.html b/docs/api/index.html index f78f8354..9195c32f 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -4,13 +4,13 @@ mongodb-memory-server - +
- + \ No newline at end of file diff --git a/docs/api/interfaces/mongo-memory-binary-opts/index.html b/docs/api/interfaces/mongo-memory-binary-opts/index.html index 19c929fa..b9448816 100644 --- a/docs/api/interfaces/mongo-memory-binary-opts/index.html +++ b/docs/api/interfaces/mongo-memory-binary-opts/index.html @@ -4,14 +4,14 @@ MongoBinaryOpts | mongodb-memory-server - +

MongoBinaryOpts

API Documentation of MongoBinaryOpts-Interface

Values for MongoBinaryOpts​

Inherits most values from BaseDryMongoBinaryOptions.

checkMD5​

Typings: checkMD5?: boolean

Set wheter to perform a MD5 check on the downloaded archive.

Values for BaseDryMongoBinaryOptions​

version​

Typings: version?: string

Set which binary version to download, see config option VERSION for more.

downloadDir​

Typings: downloadDir?: string

Set the directory where binaries will be downloaded to, when a download needs to happen. If a binary is not found in this directory, the other default directories will also be searched.

os​

Typings: os?: AnyOS

Set OS information that is necessary for generating the archive name, uses AnyOS.

arch​

Typings: arch?: string

Set which Architecture to use,supports the same values as config option ARCH.

platform​

Typings: platform?: string

Set which Platform to use,supports the same values as config option PLATFORM.

systemBinary​

Typings: systemBinary?: string

Set the SystemBinary path, if set this path will be used instead of finding a binary.
If this path does not exist or does not have the required permissions, a error will be thrown instead of downloading.

Helper Type AnyOS​

Typings: AnyOS = OtherOS | LinuxOS

Uses either OtherOS or LinuxOS.

Values for OtherOS​

os​

Typings: os: 'aix' | 'android' | 'darwin' | 'freebsd' | 'openbsd' | 'sunos' | 'win32' | 'cygwin' | string

Set the Platform the current system is on.

Values for LinuxOS​

Inherits from OtherOS.

os​

Typings: os: 'linux'

Value of the current Platform the system is on. In LinuxOS, this value can only be linux.

dist​

Typings: dist: string

Value of the current Distribution the current system is on.

release​

Typings: release: string

Value of the current Release the Distribution is on.

codename​

Typings: codename?: string

Value of the codename of the current Distribution Release.

id_like​

Typings: id_like?: string[]

List of Distributions this Distribution is like.

- + \ No newline at end of file diff --git a/docs/api/interfaces/mongo-memory-dispose-opts/index.html b/docs/api/interfaces/mongo-memory-dispose-opts/index.html index f8db0759..ca1ceace 100644 --- a/docs/api/interfaces/mongo-memory-dispose-opts/index.html +++ b/docs/api/interfaces/mongo-memory-dispose-opts/index.html @@ -4,13 +4,13 @@ DisposeOptions | mongodb-memory-server - +

DisposeOptions

API Documentation of DisposeOptions-Interface

Values for DisposeOptions​

enabled​

Typings: enabled?: boolean

Set whether to stop the manager on [Symbol.asyncDispose] calls.

cleanup​

Typings: cleanup?: Cleanup

Set custom cleanup options to be used for disposal, see cleanup function (the same options apply for the replset).

- + \ No newline at end of file diff --git a/docs/api/interfaces/mongo-memory-instance-opts/index.html b/docs/api/interfaces/mongo-memory-instance-opts/index.html index 37a58625..ccf05827 100644 --- a/docs/api/interfaces/mongo-memory-instance-opts/index.html +++ b/docs/api/interfaces/mongo-memory-instance-opts/index.html @@ -4,7 +4,7 @@ MongoMemoryInstanceOpts | mongodb-memory-server - + @@ -17,7 +17,7 @@ This option will automatically be set with a directory generated by mkdtemp.

storageEngine​

Typings: storageEngine?: StorageEngine
Default: ephemeralForTest (unless mongodb version is 7.0.0, where its wiredTiger)

Set which storage engine to use, uses StorageEngine.

replicaMemberConfig​

Typings: replicaMemberConfig?: ReplicaMemberConfig

Set custom a custom Replica Member Config, uses ReplicaMemberConfig.
Only has a effect when started with MongoMemoryReplSet.

Helper Type StorageEngine​

Typings: StorageEngine = 'ephemeralForTest' | 'wiredTiger'

Storage Engines supported by mongodb, see MongoDB Storage Engines.

Custom Explanation:

  • ephemeralForTest is a in-memory storage engine, which stores everything in RAM, which is great to use when wanting a simple database testing backend, is not the same as the Enterprise In-Memory Engine
  • wiredTiger is a storage engine which stores data on disk.
danger

MongoDB has stated that storage-engine ephemeralForTest is unstable and has been deprecated, it will be removed with mongodb 7.

In MMS there has been no observation of ephemeralForTest being unstable (aside from some missing features) and will continue to be the default until mongodb-memory-server changes to a version where ephemeralForTest is not present anymore.

With mongodb-memory-server 9.0.0, if mongodb 7.0.0 or higher is used, wiredTiger is the default engine.

- + \ No newline at end of file diff --git a/docs/api/interfaces/mongo-memory-instance-replicamemberconfig/index.html b/docs/api/interfaces/mongo-memory-instance-replicamemberconfig/index.html index ff018831..495d9220 100644 --- a/docs/api/interfaces/mongo-memory-instance-replicamemberconfig/index.html +++ b/docs/api/interfaces/mongo-memory-instance-replicamemberconfig/index.html @@ -4,7 +4,7 @@ ReplicaMemberConfig | mongodb-memory-server - + @@ -20,7 +20,7 @@ Default: 0

Set how long behind the secondary members should be behind the primary, for more see MongoDB Configure a Delayed Replica Set Member.
This option is a for MongoDB 5.0 or higher.

votes​

Typings: votes?: number
Default: 1

Set how many votes this member has for electing a primary. Arbiters only have a static vote of 1.

- + \ No newline at end of file diff --git a/docs/api/interfaces/mongo-memory-replset-opts/index.html b/docs/api/interfaces/mongo-memory-replset-opts/index.html index a38be893..3bf557f1 100644 --- a/docs/api/interfaces/mongo-memory-replset-opts/index.html +++ b/docs/api/interfaces/mongo-memory-replset-opts/index.html @@ -4,7 +4,7 @@ MongoMemoryReplSetOpts | mongodb-memory-server - + @@ -13,7 +13,7 @@ Default: {}

Set MongoMemoryInstanceOptsBase for a instance individually, overwrites existing options from replSet.

The count of this array deducts from the replSet.count, if more than replSet.count are specified, the additional ones are also spawned.

binary​

Typings: binary: MongoBinaryOpts
Default: {}

Set MongoBinaryOpts for the replset instances to use.

replSet​

Typings: replSet: ReplSetOpts
Default: {}

Set ReplSetOpts for the whole ReplSet and default options for the instances to spawn with.

- + \ No newline at end of file diff --git a/docs/api/interfaces/mongo-memory-server-automaticauth/index.html b/docs/api/interfaces/mongo-memory-server-automaticauth/index.html index b87777f0..1a0261e7 100644 --- a/docs/api/interfaces/mongo-memory-server-automaticauth/index.html +++ b/docs/api/interfaces/mongo-memory-server-automaticauth/index.html @@ -4,7 +4,7 @@ AutomaticAuth | mongodb-memory-server - + @@ -17,7 +17,7 @@ Default: false

Force to run createAuth, by default createAuth is only run when the instance is new.

keyfileContent​

Typings: keyfileContent?: string
Default: 0123456789

Set custom content for the keyfile.
This field only has a effect in a MongoMemoryReplSet.

A Keyfile is required in ReplSet's since ~5.0 for other replset instances to connect to eachother without having to use a password, and keyfiles only work for authenticating other instances, not clients, for more see MongoDB Keyfile Documentation.

- + \ No newline at end of file diff --git a/docs/api/interfaces/mongo-memory-server-createuser/index.html b/docs/api/interfaces/mongo-memory-server-createuser/index.html index e1825739..5cbe800b 100644 --- a/docs/api/interfaces/mongo-memory-server-createuser/index.html +++ b/docs/api/interfaces/mongo-memory-server-createuser/index.html @@ -4,7 +4,7 @@ CreateUser | mongodb-memory-server - + @@ -12,7 +12,7 @@

CreateUser

API Documentation of CreateUser-Interface

Values​

This Interface inherits most values from the CreateUserMongoDB interface, which is a interface for the createUser command manually types, see #663 for tracking on switching to native interface.

Because most values are inherited, only the new ones and important ones are described here.

database​

Typings: database?: string
Default: admin

Set the Database where the user will be added to, by default the user will be added to the admin database.

createUser​

Typings: createUser: string

Set the username of the User to create.

pwd​

Typings: pwd: string

Set the password of the User to create.

roles​

Typings: roles: ({ role: UserRoles; db: string } | UserRoles)[]

Set the Roles the new User will have.
For a list of available Roles, see the MongoDB Documentation.

- + \ No newline at end of file diff --git a/docs/api/interfaces/mongo-memory-server-opts/index.html b/docs/api/interfaces/mongo-memory-server-opts/index.html index a4655f77..81584205 100644 --- a/docs/api/interfaces/mongo-memory-server-opts/index.html +++ b/docs/api/interfaces/mongo-memory-server-opts/index.html @@ -4,13 +4,13 @@ MongoMemoryServerOpts | mongodb-memory-server - +

MongoMemoryServerOpts

API Documentation of MongoMemoryServerOpts-Interface

Values​

instance​

Typings: instance?: MemoryServerInstanceOpts & ExtraOptions

Set custom options based on MongoMemoryInstanceOpts, but ignores some properties:

  • auth is ignored because it is set via auth property.

Extra options specific to MongoMemoryServer class:

  • portGeneration: enable / disable port generation, enabled by default.

binary​

Typings: binary?: MongoBinaryOpts

Set custom options for finding the binary, uses MongoBinaryOpts.

spawn​

Typings: spawn?: SpawnOptions

Set custom spawn options for spawning processes, uses SpawnOptions

auth​

Typings: auth?: AutomaticAuth

Set custom Authentication options for the instance, uses AutomaticAuth.

dispose​

Typings: dispose?: DisposeOptions

Set custom behavior for when [Symbol.asyncDispose] is called, uses DisposeOptions.

- + \ No newline at end of file diff --git a/docs/api/interfaces/replset-opts/index.html b/docs/api/interfaces/replset-opts/index.html index 57f6b6c5..191bed59 100644 --- a/docs/api/interfaces/replset-opts/index.html +++ b/docs/api/interfaces/replset-opts/index.html @@ -4,7 +4,7 @@ ReplSetOpts | mongodb-memory-server - + @@ -19,7 +19,7 @@ Default: "ephemeralForTest" (unless mongodb version is 7.0.0, where its wiredTiger)

Set which Storage Engine to use, uses StorageEngine.

Also see MongoMemoryInstanceOpts.storageEngine.

configSettings​

Typings: configSettings?: MongoMemoryReplSetConfigSettings
Default: {}

Set custom ReplSet config options

See MongoDB Replica Set Configuration.

count​

Typings: count?: number
Default: 1

Set how many ReplSet members to spawn, this number will be deducted from length of instanceOpts array.

tip

It is recommended to set this number to a odd number, and try to never have it be even, see MongoDB Deploy an Odd Number of Members.

dispose​

Typings: dispose?: DisposeOptions

Set custom behavior for when [Symbol.asyncDispose] is called, uses DisposeOptions.

- + \ No newline at end of file diff --git a/docs/guides/common-issues/index.html b/docs/guides/common-issues/index.html index fafa809c..748faeef 100644 --- a/docs/guides/common-issues/index.html +++ b/docs/guides/common-issues/index.html @@ -4,14 +4,14 @@ Common Issues | mongodb-memory-server - +

Common Issues

There are some common issues you may encounter with mongodb-memory-server (or also manually handling mongod instances), this guide will try to explain why they happen how to fix those issues.

MongoWriteConcernError: operation was interrupted​

The Error MongoWriteConcernError: operation was interrupted happens when a operation which is not retryable fails, which includes for example db.dropDatabase. This Error happens because mongodb firstly starts all instances, says they are okay and has a primary (which are all events mongodb-memory-server listens for before resolving .start), but the shortly after the .start is resolved, the instace that is primary decides to step-down due to whatever reason.

The fix is to manually re-try those operations, like:

// original:
async function setup(db) {
  await db.dropDatabase();
}

// fix
async function setup(db) {
  let retries = 5;
  while (retries > 0) {
    retries -= 1;
    try {
      await _setup(db);
    } catch (err) {
      if (err instanceof mongodb.MongoWriteConcernError && /operation was interrupted/.test(err.message)) {
        continue;
      }

      throw err;
    }
  }
}

async function _setup(db) {
  await db.dropDatabase();
}

See Operations which are retry-able.

- + \ No newline at end of file diff --git a/docs/guides/enable-debug-mode/index.html b/docs/guides/enable-debug-mode/index.html index a3abc368..e757ca6f 100644 --- a/docs/guides/enable-debug-mode/index.html +++ b/docs/guides/enable-debug-mode/index.html @@ -4,13 +4,13 @@ Enable Debug Mode | mongodb-memory-server - +

Enable Debug Mode

The Debug Mode can be enabled by setting the DEBUG config options, which can be done by either setting it as a Environment Variable or package.json option.

Examples​

Via Environment Variable​

# also available case-insensitive values: "on" "yes" "true"
MONGOMS_DEBUG=1 npm run test

Via package.json config​

{
  "config": {
    "mongodbMemoryServer": {
      "debug": "1", // also available case-insensitive values: "on" "yes" "true"
    }
  }
}

Extra Notes​

npm quirks​

Starting with NPM 7, scripts (like postinstall) will run in parallel and will not output any logging, but sometimes in mongodb-memory-server it is required to provide the Debug Log from a postinstall script.

Logging can be temporarly enabled with:

# Change scripts to be executed on the NPM main proccess instead of workers AND log script output
MONGOMS_DEBUG=1 npm install --foreground-scripts
- + \ No newline at end of file diff --git a/docs/guides/error-warning-details/index.html b/docs/guides/error-warning-details/index.html index 30bbceea..0b38ba58 100644 --- a/docs/guides/error-warning-details/index.html +++ b/docs/guides/error-warning-details/index.html @@ -4,7 +4,7 @@ Details for Errors & Warnings | mongodb-memory-server - + @@ -31,7 +31,7 @@ The Linux distro in use does not have a mapping for a mongodb version, please report this issue if the distro / idlike is not mentioned in Supported Systems.

Deprecation Codes​

MMS001​

Code: MMS001
Message: mongodb-memory-server will fully drop support for ia32 in 9.0

In the major version 9.0 MMS will fully drop support for the architecture ia32 (i386 / i686), because MongoDB stopped supporting the architecture past 3.x, and MMS never full supported 3.6 or lower anyway, see #638 for tracking.

MMS002​

Code: MMS002
Message: mongodb-memory-server will fully drop support for sunos in 9.0

In the major version 9.0 MMS will fully drop support for the platfrom sunos, because MMS never actually supported sunos in the first place and Mongodb has stopped providing builds after ~3.4, see #661 for tracking.

- + \ No newline at end of file diff --git a/docs/guides/faq/index.html b/docs/guides/faq/index.html index 58208396..3f7cc646 100644 --- a/docs/guides/faq/index.html +++ b/docs/guides/faq/index.html @@ -4,14 +4,14 @@ Frequently Asked Questions | mongodb-memory-server - +

Frequently Asked Questions

Do binaries get automatically deleted?​

No, this package will not delete any binaries, so after an system / package upgrade the binaries may have to be cleaned manually.

Why is there no documentation about class-options / interfaces in the documentation?​

It is currently recommended to directly look at the TSDoc for these properties to get their type & documentation.

Do testing database paths get cleaned up?​

If the Database-path is a temporary directory (generated with mkdtemp), then it will automatically get cleaned-up when calling .stop(), this can be disabled with .stop(false).
If the Database-path is manually set with dbPath, then it needs to be manually cleaned-up with .cleanup(true).

tip

Since 8.4.0 objects can also be used instead of just booleans for parameter in stop and cleanup (the same applies to MongoMemoryReplSet).

For Example .stop({ doCleanup: false }) can be used instead of .stop(false).

Does this package support Explicit Resource Management?​

Yes, [Symbol.asyncDispose] is implemented for all manager classes, behavior can be configured via dispose options:

note

Note that when using await using server = that [Symbol.asyncDispose] is called at the end of the scope even if the value is reassigned to something out of the current scope.

- + \ No newline at end of file diff --git a/docs/guides/index.html b/docs/guides/index.html index c03b19e3..3b90e055 100644 --- a/docs/guides/index.html +++ b/docs/guides/index.html @@ -4,13 +4,13 @@ mongodb-memory-server - +
- + \ No newline at end of file diff --git a/docs/guides/integration-examples/docker/index.html b/docs/guides/integration-examples/docker/index.html index 9109dfc0..c6674070 100644 --- a/docs/guides/integration-examples/docker/index.html +++ b/docs/guides/integration-examples/docker/index.html @@ -4,14 +4,14 @@ Integration with Docker | mongodb-memory-server - +

Integration with Docker

This Guide will show how mongodb-memory-server can be used with Docker & dockerfiles.

Important Notes before Starting​

caution

It is common that images like node:16-alpine are used, which will not work with this package, because mongodb does not provide binaries for Alpine yet. It is recommended to switch to images like node:16 (or node:16-buster) for Debian builds.

See No Build available for Alpine Linux.

caution

Docker Debian builds (at least with debian:11), extra packages have to be installed:

apt-get install libcurl4 # for Debian 10+ to fix CURL_OPENSSL_4
# OR
apt-get install libcurl3 # for Debian 9 (and before) to fix CURL_OPENSSL_3

Writing a dockerfile with mongodb binary caching​

Sometimes you want to have the tests isolated from the host system and also have caching working for mongodb-memory-server.

.dockerignore​

It is recommended to have the following added to the .dockerignore file to make sure that no host-specific things are copied into the image:

# ignore all node_modules, no matter where, like when having a monorepo
**/node_modules

If the above is not added to the .dockeringore then the following may happen:

  • Best case is just added bloat if the host system is not debian (like having the host's mongodb binary copied into the image)
  • If the host system is Debian (and to that not matching version), then the host's mongodb binary is copied in and will be used instead of downloading the actual required mongodb binary

Alternatively, if no .dockeringore is used, the following could also be added to the dockerfile:

# ...
COPY node:node . /project

# Put this Instruction between the COPY and the RUN "npm install" steps
# The following recursively deletes all directories it finds that are a directory AND have a name matching "node_modules"
RUN find . -type d -iname "node_modules" -exec rm -rf {} \;

RUN npm install
# ...

dockerfile​

The following dockerfile contains the recommended steps to build a good MMS image:

note

The following dockerfile has examples for 2 package managers: npm and yarn, be sure to remove the one that will not be used.

# Using a Debian build
FROM node:16

# Installing "libcurl4" because some Debian images may not come with this package installed, but is required by the mongodb binaries
RUN apt-get install libcurl4

# Settings the CWD (Current Work Directory) to "/project" to have a isolated folder for the project
# Note: it is not recommended to set it to "/home/dockeruser", but to use "/home/dockeruser/project"
WORKDIR /project

# Copy the project (all files) into the image into "/project" as user "node:node"
# User "node:node" is the default nodejs user in the docker images
COPY node:node . /project

# Explicitly set the user that will be used for the next Instructions and ENTRYPOINT
USER node

# Install all required dependencies locked to the package-lock (or yarn.lock)
# Replace "npm install" with your package manager command of choice
RUN npm install --ci
# OR
RUN yarn install --frozen-lockfile

# Set the default command that will be used when running the image
# Replace this with your command / package manager command of choice
ENTRYPOINT ["npm", "run", "test"]
# OR
ENTRYPOINT ["yarn", "run", "test"]
- + \ No newline at end of file diff --git a/docs/guides/integration-examples/test-runners/index.html b/docs/guides/integration-examples/test-runners/index.html index 135da1c6..972cbb86 100644 --- a/docs/guides/integration-examples/test-runners/index.html +++ b/docs/guides/integration-examples/test-runners/index.html @@ -4,14 +4,14 @@ Integration with Test Runners | mongodb-memory-server - +

Integration with Test Runners

This Guide will show how mongodb-memory-server can be used with different frameworks

jest​

jest version 29

For usage with jest it is recommended to use the globalSetup and globalTeardown options

config.ts:

// this file could be anything (like a json directly imported)

export = {
  Memory: true,
  IP: '127.0.0.1',
  Port: '27017',
  Database: 'somedb'
}

jest.config.json:

{
  "preset": "ts-jest",
  "globalSetup": "<rootDir>/test/globalSetup.ts",
  "globalTeardown": "<rootDir>/test/globalTeardown.ts",
  "setupFilesAfterEnv": [
    "<rootDir>/test/setupFile.ts"
  ]
}

globalSetup.ts:

import { MongoMemoryServer } from 'mongodb-memory-server';
import * as mongoose from 'mongoose';
import { config } from './utils/config';

export = async function globalSetup() {
  if (config.Memory) { // Config to decide if an mongodb-memory-server instance should be used
    // it's needed in global space, because we don't want to create a new instance every test-suite
    const instance = await MongoMemoryServer.create();
    const uri = instance.getUri();
    (global as any).__MONGOINSTANCE = instance;
    process.env.MONGO_URI = uri.slice(0, uri.lastIndexOf('/'));
  } else {
    process.env.MONGO_URI = `mongodb://${config.IP}:${config.Port}`;
  }

  // The following is to make sure the database is clean before a test suite starts
  const conn = await mongoose.connect(`${process.env.MONGO_URI}/${config.Database}`);
  await conn.connection.db.dropDatabase();
  await mongoose.disconnect();
};

globalTeardown.ts:

import { MongoMemoryServer } from 'mongodb-memory-server';
import { config } from './utils/config';

export = async function globalTeardown() {
  if (config.Memory) { // Config to decide if an mongodb-memory-server instance should be used
    const instance: MongoMemoryServer = (global as any).__MONGOINSTANCE;
    await instance.stop();
  }
};

and an setupFilesAfterEnv can be used to connect something like mongoose or mongodb

setupFile.ts:

beforeAll(async () => {
  // put your client connection code here, example with mongoose:
  await mongoose.connect(process.env['MONGO_URI']);
});

afterAll(async () => {
  // put your client disconnection code here, example with mongoose:
  await mongoose.disconnect();
});
caution

It is very important to limit the spawned number of Jest workers on machines that have many cores, because otherwise the tests may run slower than with fewer workers, because the database instance(s) may be hit very hard.
Use either --maxWorkers 4 or --runInBand to limit the workers.

note

Keep in mind that jest's global-setup and global-teardown do not share a environment with the tests themself, and so require setupFile / setupFilesAfterEnv to actually connect.

mocha / chai​

mocha version (unknown)

Start Mocha with --timeout 60000 cause first download of MongoDB binaries may take a time.

import mongoose from 'mongoose';
import { MongoMemoryServer } from 'mongodb-memory-server';

let mongoServer;

before(async () => {
  mongoServer = await MongoMemoryServer.create();
  const mongoUri = mongoServer.getUri();
  await mongoose.connect(mongoUri);
});

after(async () => {
  await mongoose.disconnect();
  await mongoServer.stop();
});

describe('...', () => {
  it('...', async () => {
    const User = mongoose.model('User', new mongoose.Schema({ name: String }));
    const cnt = await User.countDocuments();
    expect(cnt).to.equal(0);
  });
});

AVA test runner​

For AVA there is a detailed written tutorial on how to test mongoose models with mongodb-memory-server by @zellwk.

note

Note that this tutorial is pre mongodb-memory-server 7.x.

- + \ No newline at end of file diff --git a/docs/guides/known-issues/index.html b/docs/guides/known-issues/index.html index 1f8a32db..93607cd2 100644 --- a/docs/guides/known-issues/index.html +++ b/docs/guides/known-issues/index.html @@ -4,13 +4,13 @@ Known Issues | mongodb-memory-server - +

Known Issues

ArchLinux on Docker​

It is known that ArchLinux on Docker does not have an /etc/os-release or /etc/lsb-release, so detection will not work.

Workaround:

  • Create one of these files (either manually, or install lsb-release)
  • Use a SystemBinary with SYSTEM_BINARY
  • Use an pre-set Archive Name to be used with ARCHIVE_NAME

No Build available for Alpine Linux​

It is known that AlpineLinux does not have an official build (and no build like the ubuntu build works).

Workaround:

libcurl on older or custom Docker images​

When running older docker images or a custom image not based on any node image, then libcurl4 will likely need to be manually installed, otherwise MongoDB binary will not start since version 5.0.0 on most distributions.

libcurl4 is not available on your system. Mongod requires it and cannot be started without it.

This can be resolved by installing it in your image:

apt-get install libcurl4
- + \ No newline at end of file diff --git a/docs/guides/migration/migrate10/index.html b/docs/guides/migration/migrate10/index.html index 3773cba2..31fc84a7 100644 --- a/docs/guides/migration/migrate10/index.html +++ b/docs/guides/migration/migrate10/index.html @@ -4,7 +4,7 @@ Migrate to version 10.0.0 | mongodb-memory-server - + @@ -12,7 +12,7 @@

Migrate to version 10.0.0

Here are the Important changes made for 10.0.0

Important, Read this first

This Guide is written for migration from version 9.4.1 to 10.0.0, for versions >10.0.0 <11.0.0, please consult the CHANGELOG

Breaking Changes​

Minimal NodeJS version is now 16​

With 10.0.0 the minimal nodejs required is 16.20.1.

Mongodb Driver Version upgraded to 6.x​

The used MongoDB Driver version is now 6.7.0.

Default binary version is now 7.x​

The default binary version has been upgraded from 6.0.x to 7.0.x. For more specifics see mongodb-server-versions.

note

In mongodb 7.0.0 storage engine ephemeralForTest has been removed, mongodb-memory-server will automatically translate any occurrence to wiredTiger with a warning.

It is recommended to run the tests against a tmpfs or equivalent (default /tmp on linux / macos).

Non-Breaking changes / Additions​

Compiler target is now es2021​

The tsconfig target option has been updated to es2021, which will result in less polyfills. This should be a non-breaking change.

Getport now uses net0listen by default​

This means a port is now generated by the engine (like nodejs) itself, previously known as EXP_NET0LISTEN. This should reduce amount of Max port tries exceeded errors.

Allow setting port generation in MongoMemoryServer​

Starting with 10.0 there is a new option to set whether port generation is enabled or not on MongoMemoryServer called portGeneration. (default: true)

(Note that the forceSamePort parameter in .start will overwrite this option)

- + \ No newline at end of file diff --git a/docs/guides/migration/migrate7/index.html b/docs/guides/migration/migrate7/index.html index 6ee83ca0..092aa9cb 100644 --- a/docs/guides/migration/migrate7/index.html +++ b/docs/guides/migration/migrate7/index.html @@ -4,7 +4,7 @@ Migrate to version 7.0.0 | mongodb-memory-server - + @@ -13,7 +13,7 @@ This will make it easier to work with sharing the project folder (like host to docker)

note

This package will not delete the old binaries, these need to be manually deleted, see storage paths for where binaries are stored

getConnectionString got removed​

Function getConnectionString got removed in favor of just getUri

MongoInstance.waitPrimaryReady got removed​

Function MongoInstance.prototype.waitPrimaryReady got removed, in favor of listening to event instancePrimary

Functions that returned public values on classes got removed​

Functions like MongoMemoryServer.prototype.getInstanceInfo got removed in favor of MongoMemoryServer.prototype.instanceInfo (readonly value)

These include:

  • MongoMemoryServer.prototype.getInstanceInfo -> MongoMemoryServer.prototype.instanceInfo (readonly value)
  • MongoMemoryServer.prototype.getPort -> MongoMemoryServer.prototype.instanceInfo.port (readonly value)
  • MongoMemoryServer.prototype.getDbPath -> MongoMemoryServer.prototype.instanceInfo.dbPath (readonly value)
  • MongoMemoryServer.prototype.getDbName -> MongoMemoryServer.prototype.instanceInfo.dbName (readonly value)
  • MongoMemoryReplSet.prototype.getDbName -> MongoMemoryReplSet.prototype.opts.replSet.db (readonly value)
  • MongoInstance.prototype.getPid -> MongoInstance.prototype.mongodProcess.pid (readonly value)

Manager Class functions got unified​

Manager-Classes got unified, these include MongoMemoryServer, MongoMemoryReplSet, MongoInstance
This means that all of them have unified typings for start, stop, create, getUri, cleanup

This also includes function renames:

  • (static) MongoInstance.run -> MongoInstance.create
  • MongoInstance.prototype.run -> MongoInstance.prototype.start
  • MongoInstance.prototype.kill -> MongoInstance.prototype.stop

getUri by default does not include any dbName anymore​

This was changed to allow mongodb and mongoose URI's to work at the same time (they slightly differ).

See the code comment for more information

Non-Breaking changes / Additions​

Config Values are now collected in an enum​

Config values like DOWNLOAD_DIR are now collected in an enum called ResolveConfigVariables, see more here

Config helper function "envName"​

An helper function named envName is introduced into 7.0.0, which does:

// previously
process.env[ENV_CONFIG_PREFIX + ResolveConfigVariables.DOWNLOAD_DIR] = 'someValue';

// now
process.env(envName(ResolveConfigVariables.DOWNLOAD_DIR)) = 'someValue';

this does not only save space, but also provide direct auto-completion-suggestions for ResolveConfigVariables

All Manager Classes are now extending EventEmitter​

All Manager-Classes are now extending EventEmitter, which makes them easier to use and listen for changes

Automatic Authentication creation​

For 7.0.0 there is now Automatic Authentication created, which can be enabled by providing config option auth in the code

Example:

// This will create an Auth-enabled instance with default auth-values
const mongoServer = await MongoMemoryServer.create({
  auth: {}, // anything else than "undefined / null" will enable auth, can be explicitly disabled with "auth: { disable: true }"
  instance: {
    auth: true,
    storageEngine: 'wiredTiger',
  },
});
info

The Instance will not be restarted if the storage engine is ephemeralForTest because data will not persist across restarts

For available Values look into either the source code or let intellisense show values

Explicit & Implicit Cleanup​

Cleanup behaviour can now be controlled, default is an tmpDir that will get automatically removed on instance-stop / process exit, if it is not an tmpDir then .cleanup needs to be manually called with true (force)

If persistence between restarts is wanted (even if it is an tmpDir), then call .stop with false (cleanup for tmpDir will still be run on process exit)

ReplSet's can now gracefully exit​

Since Mongod ~4.2 replset's dont exit anymore on SIGTERM if they cannot step-down (no other instance to give primary to)
In 7.0.0 this is now handled with mongodb command replSetStepDown: 1, force: true

Linux Distribution Detection enhanced​

For 7.0.0, the Linux Distribution Detection got enhanced, now preferring to use /etc/upstream-release/lsb-release instead of the /etc/ ones, which enables based-on distributions to be easier mapped (and fallback correctly)

This mostly impacts Debian based distros and Ubuntu based distros

ArchLinux got somewhat supported​

Some reports said that the ubuntu binaries work on arch, so there is now an automatic fallback to ubuntu binaries (MongoDB still dosnt have binaries for arch)

Runtime downloads can now be disabled or explicitly enabled​

Version 7.0.0 brings an new config value named RUNTIME_DOWNLOAD, which is an boolean, to disable Runtime Downloads or explicitly enable them

Unified Common Errors​

In pre-7.0.0, errors were all over the place, now the most common are unified into custom errors

- + \ No newline at end of file diff --git a/docs/guides/migration/migrate8/index.html b/docs/guides/migration/migrate8/index.html index a1423a14..cb00efb2 100644 --- a/docs/guides/migration/migrate8/index.html +++ b/docs/guides/migration/migrate8/index.html @@ -4,13 +4,13 @@ Migrate to version 8.0.0 | mongodb-memory-server - +

Migrate to version 8.0.0

Here are the Important changes made for 8.0.0

Important, Read this first

This Guide is written for migration from version 7.6.0 to 8.0.0, for versions >8.0.0 <9.0.0, please consult the CHANGELOG

Breaking Changes​

Default MongoDB Server version upgraded to 5.0.3​

The Default MongoDB Server version for 8.0 is 5.0.3, see MongoDB Server Versions.

Mongodb Driver Version upgraded to 4.x​

The used MongoDB Driver version is now 4.1.2.

Non-Breaking changes / Additions​

Binary file name is now parsed from ARCHIVE_NAME and DOWNLOAD_URL​

The Binary file name (like mongod-x64-ubuntu-4.0.0) is now parsed from ARCHIVE_NAME and DOWNLOAD_URL.

A Error now gets thrown if Debian 10 (or higher) is used with mongodb version below 4.2.0​

A Error now gets thrown, if Debian 10 (or higher) is used with a requested mongodb version of below 4.2.0, because there are no version available for Debian 10 below 4.2.0 and Debian 9 binaries are incompatible with Debian 10. (because of libcurl3)

instance.auth is no longer required to enable Authentication​

Option instance.auth is now no longer required to be set to enable Authentication when auth (top-level) is set.

More Errors moved to Custom Error classes​

More Errors have been moved to a custom Error class.

- + \ No newline at end of file diff --git a/docs/guides/migration/migrate9/index.html b/docs/guides/migration/migrate9/index.html index 526cc5ae..8cbacce0 100644 --- a/docs/guides/migration/migrate9/index.html +++ b/docs/guides/migration/migrate9/index.html @@ -4,7 +4,7 @@ Migrate to version 9.0.0 | mongodb-memory-server - + @@ -17,7 +17,7 @@ This should be a non-breaking change

Crypto function have been changed to use nodejs internals​

Crypto functions like for the md5 check and uuidv4 generation have been moved to use the node:crypto support, resulting in dropping 2 dependencies.

Dropped dependencies are md5-file and uuid.

Binary childprocess is now also .unref()​

The Mongodb Binary childprocess is now also .unref(), like the killer process has been for some time.

This should help with non-closed instances not exiting the nodejs process.

The port testing package has been replaced​

Previously MMS used get-port, but it caused some big memory-leakage across big projects, so it has been replaced with one that uses less maps.

It also has been replaced because newer versions were ESM only, but we couldnt switch to ESM yet (and using ESM in CommonJS is not a great experience)

Mongodb version 7.0.0 is now supported​

Mongob version 7.0.0 removed storage engine ephemeralForTest, with mongodb-memory-server 9.0.0 storage engine wiredTiger is the default for binary versions 7.0.0 and higher. Older versions (before 7.0.0) will still continue to use ephemeralForTest by default.

info

The version used for the decision is the version provided via the resolved VERSION config option.
This mean it needs to match the version the system binary is (a warning is printed if they are not the same).

If the option is unset, the default version will be used, which is likely not correct for the system binary.

If the decision should not be automatic, the storage engine can be explicitly defined as a instance option.

It is recommended to run those instances with a db path which is equivalent to tmpfs.

- + \ No newline at end of file diff --git a/docs/guides/mongodb-server-versions/index.html b/docs/guides/mongodb-server-versions/index.html index 3db97231..97ae8f6a 100644 --- a/docs/guides/mongodb-server-versions/index.html +++ b/docs/guides/mongodb-server-versions/index.html @@ -4,15 +4,15 @@ Mongodb Server Versions | mongodb-memory-server - +

Mongodb Server Versions

This Guide will show what MongoDB Server versions are / were the default for versions of mongodb-memory-server-core and the guidelines of when a version gets changed.

Some expressions will use npm's semver convention.

When a Version gets upgraded​

In a new major version of mongodb-memory-server-core (X.0.0), the default mongodb binary version may be upgraded to any newer version (X.X.X).
In a minor version of mongodb-memory-server-core (0.X.0), the default mongodb binary version may be upgraded to the latest patch version 0.0.X.
-In a patch version of mongodb-memory-server-core (0.0.X), the default mongodb binary version will not be changed.

There are some exceptions:

  • A mongodb binary may go offline (not being able to download it anymore), then the default version will be changed and a minor (0.X.0) release will happen.
  • A mongodb binary may be broken, then the default version will be changed and a minor (0.X.0) release will happen.

The versions with a broken default binary may get deprecated (when possible).

For Packages that are named with a version (like mongodb-memory-server-global-4.2), the patch version (0.0.X) of a binary may be changed with minor (0.X.0) releases.

note

Starting with MongoDB version 5.0, the default versions for mongodb-memory-server-core will only be major X.0.0 versions (no X.X.0 versions), see MongoDB Versioning.

mongodb-memory-server-core Version Table​

mongodb-memory-server-core VersionDefault MongoDB Version
10.0.x - 10.0.x7.0.11
9.2.x - 9.2.x6.0.14
9.0.x - 9.1.x6.0.9
8.14.x - 8.16.x5.0.19
8.13.x - 8.13.x5.0.18
8.11.x - 8.12.x5.0.13
8.6.x - 8.10.x5.0.8
8.0.x - 8.5.x5.0.3
7.5.x - 7.5.x4.0.27
7.0.x - 7.4.x4.0.25
6.4.x - 6.9.x4.0.14
6.0.x - 6.4.x4.0.3

mongodb-memory-server-global-* Version Table​

This Section will show all mongodb-memory-server-global-* packages that ever existed for this Project, what Version they provide in the latest version and what Branch they will be updated from.

If the branch is named like old/, then it means that this package will not be updated for new major MMS versions anymore. (Example if the package is in old/6.x, then it will not get any updates to MMS 7.0 or higher)

Package NameProvided MongoDB VersionCurrent Branch
mongodb-memory-server-global-4.44.4.28master
mongodb-memory-server-global-4.24.2.24master
mongodb-memory-server-global-4.04.0.28master
mongodb-memory-server-global-3.63.6.23old/7.x
mongodb-memory-server-global-3.43.4.20old/6.x
- +In a patch version of mongodb-memory-server-core (0.0.X), the default mongodb binary version will not be changed.

There are some exceptions:

  • A mongodb binary may go offline (not being able to download it anymore), then the default version will be changed and a minor (0.X.0) release will happen.
  • A mongodb binary may be broken, then the default version will be changed and a minor (0.X.0) release will happen.

The versions with a broken default binary may get deprecated (when possible).

For Packages that are named with a version (like mongodb-memory-server-global-4.2), the patch version (0.0.X) of a binary may be changed with minor (0.X.0) releases.

note

Starting with MongoDB version 5.0, the default versions for mongodb-memory-server-core will only be major X.0.0 versions (no X.X.0 versions), see MongoDB Versioning.

mongodb-memory-server-core Version Table​

mongodb-memory-server-core VersionDefault MongoDB Version
10.1.x - 10.1.x7.0.14
10.0.x - 10.0.x7.0.11
9.2.x - 9.2.x6.0.14
9.0.x - 9.1.x6.0.9
8.14.x - 8.16.x5.0.19
8.13.x - 8.13.x5.0.18
8.11.x - 8.12.x5.0.13
8.6.x - 8.10.x5.0.8
8.0.x - 8.5.x5.0.3
7.5.x - 7.5.x4.0.27
7.0.x - 7.4.x4.0.25
6.4.x - 6.9.x4.0.14
6.0.x - 6.4.x4.0.3

mongodb-memory-server-global-* Version Table​

This Section will show all mongodb-memory-server-global-* packages that ever existed for this Project, what Version they provide in the latest version and what Branch they will be updated from.

If the branch is named like old/, then it means that this package will not be updated for new major MMS versions anymore. (Example if the package is in old/6.x, then it will not get any updates to MMS 7.0 or higher)

Package NameProvided MongoDB VersionCurrent Branch
mongodb-memory-server-global-4.44.4.28master
mongodb-memory-server-global-4.24.2.24master
mongodb-memory-server-global-4.04.0.28master
mongodb-memory-server-global-3.63.6.23old/7.x
mongodb-memory-server-global-3.43.4.20old/6.x
+ \ No newline at end of file diff --git a/docs/guides/quick-start-guide/index.html b/docs/guides/quick-start-guide/index.html index d034e055..0f0ffe1c 100644 --- a/docs/guides/quick-start-guide/index.html +++ b/docs/guides/quick-start-guide/index.html @@ -4,14 +4,14 @@ Quick Start Guide | mongodb-memory-server - +

Quick Start Guide

This Guide will show how to setup this package for basic use

note

The Examples on this page assume Top-Level async-await for readability.
If Top-Level async-await is not available for your case, the code can in most cases be wrapped like:

(async () => {
  // async code in where
})();

Requirements​

  • NodeJS: 16.20.1+
  • Typescript: 5.3+ (if used)

When on Linux, one of the following are required:

  • having lsb-core installed (or any that provides the lsb_release command)
  • having an /etc/os-release file that is compliant to the OS-Release Spec
  • having an /etc/*-release file that is compliant to the OS-Release Spec (and does not include lsb)
  • manually specify which version & system should be used

On Linux, you will also need libcurl (or libcurl3 on some older distro versions). This will probably only be an issue on "slim" Docker images.

Choose the right package​

There are multiple packages for this project, here are the differences:

  • mongodb-memory-server-core is the main package, which does not have any hooks on install
  • mongodb-memory-server adds hooks to install on yarn install or npm install to install the latest package locally
  • mongodb-memory-server-global adds hooks to install on yarn install or npm install to install the latest package globally (into $HOME)
  • mongodb-memory-server-global-X.X adds hooks to install on yarn install or npm install to install MongoDB with version X.X globally (into $HOME)

Normal Server​

A Normal Server can be easily started with:

import { MongoMemoryServer } from 'mongodb-memory-server';

// This will create an new instance of "MongoMemoryServer" and automatically start it
const mongod = await MongoMemoryServer.create();

const uri = mongod.getUri();

// The Server can be stopped again with
await mongod.stop();

ReplicaSet​

A ReplicaSet can be easily started with:

import { MongoMemoryReplSet } from 'mongodb-memory-server';

// This will create an new instance of "MongoMemoryReplSet" and automatically start all Servers
const replset = await MongoMemoryReplSet.create({ replSet: { count: 4 } }); // This will create an ReplSet with 4 members
// To use Transactions, the "storageEngine" needs to be changed to `wiredTiger`
const replset = await MongoMemoryReplSet.create({ replSet: { count: 4, storageEngine: 'wiredTiger' } }); // This will create an ReplSet with 4 members and storage-engine "wiredTiger"

const uri = replset.getUri();

// The ReplSet can be stopped again with
await replset.stop();

Final Notes​

danger

When you are not using a global instance for tests and run multi-threaded tests, it can cause Race Conditions.

- + \ No newline at end of file diff --git a/docs/guides/supported-systems/index.html b/docs/guides/supported-systems/index.html index 05c63467..5838ccb0 100644 --- a/docs/guides/supported-systems/index.html +++ b/docs/guides/supported-systems/index.html @@ -4,7 +4,7 @@ Supported Systems | mongodb-memory-server - + @@ -43,7 +43,7 @@ Default version is none

Arch​

Unsupported Working

There are no official mongodb builds for Arch Distributions, but the ubuntu binaries work on most Arch systems, so they are used.
Currently Mapping to: ubuntu2204

note

Because Arch* dosnt base on ubuntu, there is no specific ubuntu version associated with an arch version, so it defaults to highest supported ubuntu version

note

MongoDB Binary versions before 6.0.4 require OpenSSL 1.1 installed, on arch can be installed via core/openssl-1.1.

Gentoo​

Unsupported Working

There are no official mongodb builds for Gentoo Distributions, but the debian binaries work on most Gentoo systems, so they are used.
Currently Mapping to: debain11

note

Because Gentoo dosnt base on debian, there is no specific debian version associated with an gentoo version, so it defaults to highest supported debian version

Alpine​

Unsupported

There are no official mongodb builds alpine, though there are some unoffical build of mongodb build for it which can be used

- + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 449e4c38..35b7095f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,13 +4,13 @@ mongodb-memory-server - +
- + \ No newline at end of file diff --git a/docs/test/index.html b/docs/test/index.html index ee6e0347..d230a332 100644 --- a/docs/test/index.html +++ b/docs/test/index.html @@ -4,13 +4,13 @@ Docusaurus Testing | mongodb-memory-server - +

Docusaurus Testing

This file is meant to show what Docusaurus is capable of and how it looks in this projects styles

Sources:

Callouts / Admonitions​

note

The content and title can include markdown.

You can specify an optional title

Heads up! Here's a pro-tip.

info

Useful information.

caution

Warning! You better pay attention!

danger

Danger danger, mayday!

Specify type and title​

Your Title

The content and title can include markdown.

Badges​

PrimarySecondarySuccessInfoWarningDanger

Tabs​

Tabs

Hello Tab 1, text first

Code in Tab 1

Extra Code Block Styling​

Extra Code Block Styling

Highlighting lines:

import something from "some";

class SomeClass {
  public hello?: string
}

export SomeClass;

Line Numbering:

import something from "some";

class SomeClass {
  public hello?: string
}

export SomeClass;

Yarn & NPM:

npm install somepackage
- + \ No newline at end of file diff --git a/index.html b/index.html index 2a4440ed..eb245877 100644 --- a/index.html +++ b/index.html @@ -4,13 +4,13 @@ mongodb-memory-server | mongodb-memory-server - +

mongodb-memory-server

Manage & spin up mongodb server binaries with zero(or slight) configuration for tests.

Get Started

Easy to Use

mongodb-memory-server was build with "easy-to-use" in mind and is in most common systems zero-configuration. (except setting a custom mongodb version)

Supports all MongoDB supports systems

mongodb-memory-server supporst all systems there are mongodb binaries are for, including some unofficial environments where some other binary works.

Supports both Single-Instance and Replica Sets

mongodb-memory-server can be quickly used with single mongodb instances or spin up a entire replicaset.

- + \ No newline at end of file diff --git a/typedoc/classes/MongoMemoryReplSet.MongoMemoryReplSet.html b/typedoc/classes/MongoMemoryReplSet.MongoMemoryReplSet.html index 902fd827..630c641c 100644 --- a/typedoc/classes/MongoMemoryReplSet.MongoMemoryReplSet.html +++ b/typedoc/classes/MongoMemoryReplSet.MongoMemoryReplSet.html @@ -1,5 +1,5 @@ MongoMemoryReplSet | mongodb-memory-server-core

Class MongoMemoryReplSet

Class for managing an replSet

-

Hierarchy

  • EventEmitter
    • MongoMemoryReplSet

Implements

Constructors

constructor +

Hierarchy

  • EventEmitter
    • MongoMemoryReplSet

Implements

Constructors

constructor

Properties

_binaryOpts _instanceOpts _keyfiletmp? @@ -50,12 +50,12 @@ on once setMaxListeners -

Constructors

constructor

Properties

Protected _binaryOpts

_binaryOpts: MongoBinaryOpts

Options for the Binary across all instances

-

Protected _instanceOpts

_instanceOpts: MongoMemoryInstanceOptsBase[]

Options for individual instances

-

Protected Optional _keyfiletmp

_keyfiletmp?: string

TMPDIR for the keyfile, when auth is used

-

Protected _ranCreateAuth

_ranCreateAuth: boolean = false

Protected _replSetOpts

_replSetOpts: Required<ReplSetOpts>

Options for the Replset itself and defaults for instances

-

Protected _state

_state: MongoMemoryReplSetStates = MongoMemoryReplSetStates.stopped

servers

servers: MongoMemoryServer[] = []

All servers this ReplSet instance manages

-

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

+

Constructors

constructor

Properties

Protected _binaryOpts

_binaryOpts: MongoBinaryOpts

Options for the Binary across all instances

+

Protected _instanceOpts

_instanceOpts: MongoMemoryInstanceOptsBase[]

Options for individual instances

+

Protected Optional _keyfiletmp

_keyfiletmp?: string

TMPDIR for the keyfile, when auth is used

+

Protected _ranCreateAuth

_ranCreateAuth: boolean = false

Protected _replSetOpts

_replSetOpts: Required<ReplSetOpts>

Options for the Replset itself and defaults for instances

+

Protected _state

_state: MongoMemoryReplSetStates = MongoMemoryReplSetStates.stopped

servers

servers: MongoMemoryServer[] = []

All servers this ReplSet instance manages

+

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

@@ -64,36 +64,36 @@ regular 'error' listener is installed.

Accessors

binaryOpts

instanceOpts

instanceOpts

replSetOpts

replSetOpts

state

Methods

[asyncDispose]

Protected _initReplSet

state

Methods

[asyncDispose]

Protected _initReplSet

  • _initReplSet(): Promise<void>

  • Connects to the first server from the list of servers and issues the replSetInitiate command passing in a new replica set configuration object.

    Returns Promise<void>

    Throws

    if state is not "init"

    Throws

    if "servers.length" is not 1 or above

    Throws

    if package "mongodb" is not installed

    -

Protected _initServer

Protected _initServer

Protected _waitForPrimary

  • _waitForPrimary(timeout?, where?): Promise<void>

  • Wait until the replSet has elected a Primary

    +

Returns MongoMemoryServer

Protected _waitForPrimary

  • _waitForPrimary(timeout?, where?): Promise<void>

  • Wait until the replSet has elected a Primary

    Parameters

    • timeout: number = ...

      Timeout to not run infinitly, default: 30s

    • Optional where: string

      Extra Parameter for logging to know where this function was called

    Returns Promise<void>

    Throws

    if timeout is reached

    -

addListener

addListener

  • addListener(eventName, listener): this

  • Alias for emitter.on(eventName, listener).

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

cleanup

  • cleanup(options?): Promise<void>

  • Remove the defined dbPath's

    Parameters

    • Optional options: Cleanup

      Set how to run a cleanup, by default { doCleanup: true } is used

    Returns Promise<void>

    Throws

    If "state" is not "stopped"

    Throws

    If "instanceInfo" is not defined

    Throws

    If an fs error occured

    -

emit

Protected enableAuth

emit

Protected enableAuth

Protected ensureKeyFile

Protected ensureKeyFile

eventNames

eventNames

  • eventNames(): (string | symbol)[]

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    @@ -101,7 +101,7 @@

    Throws

    If an fs error occured

Protected getInstanceOpts

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either +

Returns MongoMemoryInstanceOpts

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    Since

    v1.0.0

getUri

  • getUri(otherDb?, otherIp?): string

  • Returns an mongodb URI that is setup with all replSet servers

    @@ -110,8 +110,8 @@

    Throws

    If an fs error occured

Returns string

an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/

Throws

if state is not "running"

Throws

if an server doesnt have "instanceInfo.port" defined

-

Protected initAllServers

listenerCount

Protected initAllServers

listenerCount

  • listenerCount(eventName): number

  • Returns the number of listeners listening to the event named eventName.

    Parameters

    • eventName: string | symbol

      The name of the event being listened for

    Returns number

    Since

    v3.2.0

listeners

  • listeners(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    @@ -120,7 +120,7 @@

    Throws

    if an server doesnt have "instanceInfo.port" defined

    Parameters

    • eventName: string | symbol

    Returns Function[]

    Since

    v0.1.26

off

  • off(eventName, listener): this

  • Alias for emitter.removeListener().

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v10.0.0

    -

on

once

prependListener

  • prependListener(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the +

on

once

prependListener

  • prependListener(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    @@ -181,15 +181,15 @@

    Throws

    if an server doesnt have "instanceInfo.port" defined

    Parameters

    • n: number

    Returns this

    Since

    v0.3.5

start

Protected stateChange

Protected stateChange

stop

  • stop(cleanupOptions?): Promise<boolean>

  • Stop the underlying mongod instance(s).

    +
  • Rest ...args: any[]

Returns void

stop

waitUntilRunning

  • waitUntilRunning(): Promise<void>

  • Wait until all instances are running

    +

Returns Promise<boolean>

waitUntilRunning

Static create

Static create

Static getEventListeners

  • getEventListeners(emitter, name): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    +

Returns Promise<MongoMemoryReplSet>

Static getEventListeners

Returns MongoMemoryServer

Properties

Protected Optional _instanceInfo

_instanceInfo?: MongoInstanceData

Information about the started instance

+

Protected _state

_state: MongoMemoryServerStates = MongoMemoryServerStates.new

The Current State of this instance

+

Optional Readonly auth

auth?: Required<AutomaticAuth>

Original Auth Configuration (this.opts can be changed if stopped, but auth cannot be changed here)

+

opts

opts: MongoMemoryServerOpts

General Options for this Instance

+

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

@@ -56,22 +56,22 @@ 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

instanceInfo

state

Methods

[asyncDispose]

addListener

state

Methods

[asyncDispose]

addListener

  • addListener(eventName, listener): this

  • Alias for emitter.on(eventName, listener).

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

Protected authObjectEnable

  • authObjectEnable(): boolean

  • Helper function to determine if the "auth" object is set and not to be disabled This function expectes to be run after the auth object has been transformed to a object

    Returns boolean

    "true" when "auth" should be enabled

    -

cleanup

cleanup

  • cleanup(options?): Promise<void>

  • Remove the defined dbPath

    Parameters

    • Optional options: Cleanup

      Set how to run a cleanup, by default { doCleanup: true } is used

    Returns Promise<void>

    Throws

    If "state" is not "stopped"

    Throws

    If "instanceInfo" is not defined

    Throws

    If an fs error occured

    -

Protected debug

Protected debug

emit

ensureInstance

  • ensureInstance(): Promise<MongoInstanceData>

  • Ensure that the instance is running +

  • Rest ...extra: unknown[]

Returns void

emit

ensureInstance

eventNames

eventNames

  • eventNames(): (string | symbol)[]

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    @@ -81,15 +81,15 @@

    Throws

    If an fs error occured

    Returns number

    Since

    v1.0.0

Protected getNewPort

Protected getStartOptions

Returns Promise<number>

Protected getStartOptions

getUri

  • getUri(otherDb?, otherIp?): string

  • Generate the Connection string used by mongodb

    +

Returns Promise<MongoMemoryServerGetStartOptions>

getUri

  • getUri(otherDb?, otherIp?): string

  • Generate the Connection string used by mongodb

    Parameters

    • Optional otherDb: string

      add a database into the uri (in mongodb its the auth database, in mongoose its the default database for models)

    • Optional otherIp: string

      change the ip in the generated uri, default will otherwise always be "127.0.0.1"

    Returns string

    a valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/

    Throws

    if state is not "running" (or "starting")

    Throws

    if a server doesnt have "instanceInfo.port" defined

    -

listenerCount

listenerCount

  • listenerCount(eventName): number

  • Returns the number of listeners listening to the event named eventName.

    Parameters

    • eventName: string | symbol

      The name of the event being listened for

    Returns number

    Since

    v3.2.0

listeners

  • listeners(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    @@ -98,7 +98,7 @@

    Throws

    if a server doesnt have "instanceInfo.port" defined<

    Parameters

    • eventName: string | symbol

    Returns Function[]

    Since

    v0.1.26

off

  • off(eventName, listener): this

  • Alias for emitter.removeListener().

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v10.0.0

    -

on

once

prependListener

  • prependListener(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the +

on

once

prependListener

  • prependListener(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    @@ -160,13 +160,13 @@

    Throws

    if a server doesnt have "instanceInfo.port" defined<

start

Protected stateChange

Protected stateChange

stop

  • stop(cleanupOptions?): Promise<boolean>

  • Stop the current In-Memory Instance

    +

Returns void

stop

Static create

  • create(opts?): Promise<MongoMemoryServer>

  • Create a Mongo-Memory-Sever Instance that can be awaited

    +

Returns Promise<boolean>

Static create

Static getEventListeners

  • getEventListeners(emitter, name): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    +

Returns Promise<MongoMemoryServer>

Static getEventListeners

Settings

Member Visibility

Theme

On This Page

constructorbinaryCachecombineBinaryNamegenerateDownloadPathgenerateOptionsgeneratePathsgetBinaryNamegetEnsuredOptionsgetSystemPathlocateBinaryparseArchiveNameRegex
\ No newline at end of file diff --git a/typedoc/classes/util_MongoBinary.MongoBinary.html b/typedoc/classes/util_MongoBinary.MongoBinary.html index 6ab32891..f39a788f 100644 --- a/typedoc/classes/util_MongoBinary.MongoBinary.html +++ b/typedoc/classes/util_MongoBinary.MongoBinary.html @@ -1,12 +1,12 @@ MongoBinary | mongodb-memory-server-core

Class MongoBinary

Class used to combine "DryMongoBinary" & "MongoBinaryDownload"

-

Constructors

constructor +

Constructors

constructor

Methods

download getPath

Constructors

constructor

Methods

Static download

Static getPath

Static getPath

Settings

Member Visibility

Theme

On This Page

constructordownloadgetPath
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordownloadgetPath
\ No newline at end of file diff --git a/typedoc/classes/util_MongoBinaryDownload.MongoBinaryDownload.html b/typedoc/classes/util_MongoBinaryDownload.MongoBinaryDownload.html index fc0dfbe7..672b740d 100644 --- a/typedoc/classes/util_MongoBinaryDownload.MongoBinaryDownload.html +++ b/typedoc/classes/util_MongoBinaryDownload.MongoBinaryDownload.html @@ -1,5 +1,5 @@ MongoBinaryDownload | mongodb-memory-server-core

Class MongoBinaryDownload

Download and extract the "mongod" binary

-

Constructors

constructor +

Constructors

constructor

Properties

_downloadingUrl? binaryOpts dlProgress @@ -14,37 +14,37 @@ makeMD5check printDownloadProgress startDownload -

Constructors

constructor

Properties

Protected Optional _downloadingUrl

_downloadingUrl?: string

binaryOpts

binaryOpts: Required<MongoBinaryOpts>

These options are kind of raw, they are not run through DryMongoBinary.generateOptions

-

dlProgress

dlProgress: MongoBinaryDownloadProgress

Methods

assignDownloadingURL

download

  • download(downloadUrl): Promise<string>

  • Download file from downloadUrl

    +

Constructors

constructor

Properties

Protected Optional _downloadingUrl

_downloadingUrl?: string

binaryOpts

binaryOpts: Required<MongoBinaryOpts>

These options are kind of raw, they are not run through DryMongoBinary.generateOptions

+

dlProgress

dlProgress: MongoBinaryDownloadProgress

Methods

assignDownloadingURL

download

extract

extract

extractTarGz

extractTarGz

  • extractTarGz(mongoDBArchive, extractPath, filter): Promise<void>

  • Extract a .tar.gz archive

    Parameters

    • mongoDBArchive: string

      Archive location

    • extractPath: string

      Directory to extract to

    • filter: ((file) => boolean)

      Method to determine which files to extract

      -
        • (file): boolean

        • Parameters

          • file: string

          Returns boolean

    Returns Promise<void>

extractZip

  • extractZip(mongoDBArchive, extractPath, filter): Promise<void>

  • Extract a .zip archive

    +
      • (file): boolean

      • Parameters

        • file: string

        Returns boolean

Returns Promise<void>

extractZip

  • extractZip(mongoDBArchive, extractPath, filter): Promise<void>

  • Extract a .zip archive

    Parameters

    • mongoDBArchive: string

      Archive location

    • extractPath: string

      Directory to extract to

    • filter: ((file) => boolean)

      Method to determine which files to extract

      -
        • (file): boolean

        • Parameters

          • file: string

          Returns boolean

    Returns Promise<void>

getMongodPath

  • getMongodPath(): Promise<string>

  • Get the path of the already downloaded "mongod" file +

      • (file): boolean

      • Parameters

        • file: string

        Returns boolean

Returns Promise<void>

getMongodPath

Protected getPath

Protected getPath

httpDownload

httpDownload

  • httpDownload(url, httpOptions, downloadLocation, tempDownloadLocation): Promise<string>

  • Downlaod given httpOptions to tempDownloadLocation, then move it to downloadLocation

    Parameters

    • url: URL
    • httpOptions: RequestOptions

      The httpOptions directly passed to https.get

    • downloadLocation: string

      The location the File should be after the download

    • tempDownloadLocation: string

      The location the File should be while downloading

      -

    Returns Promise<string>

makeMD5check

  • makeMD5check(urlForReferenceMD5, mongoDBArchive): Promise<undefined | boolean>

  • Download MD5 file and check it against the MongoDB Archive

    +

Returns Promise<string>

makeMD5check

  • makeMD5check(urlForReferenceMD5, mongoDBArchive): Promise<undefined | boolean>

  • Download MD5 file and check it against the MongoDB Archive

    Parameters

    • urlForReferenceMD5: string

      URL to download the MD5

    • mongoDBArchive: string

      The MongoDB Archive file location

    Returns Promise<undefined | boolean>

    if "checkMD5" is falsey

    Throws

    if the md5 check failed

    -

printDownloadProgress

printDownloadProgress

startDownload

  • startDownload(): Promise<string>

  • Download the MongoDB Archive and check it against an MD5

    +
    • length: number
  • forcePrint: boolean = false

Returns void

startDownload

Settings

Member Visibility

Theme

On This Page

constructor_downloadingUrlbinaryOptsdlProgressassignDownloadingURLdownloadextractextractTarGzextractZipgetMongodPathgetPathhttpDownloadmakeMD5checkprintDownloadProgressstartDownload
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructor_downloadingUrlbinaryOptsdlProgressassignDownloadingURLdownloadextractextractTarGzextractZipgetMongodPathgetPathhttpDownloadmakeMD5checkprintDownloadProgressstartDownload
\ No newline at end of file diff --git a/typedoc/classes/util_MongoBinaryDownloadUrl.MongoBinaryDownloadUrl.html b/typedoc/classes/util_MongoBinaryDownloadUrl.MongoBinaryDownloadUrl.html index 8e894faa..4aec5d5a 100644 --- a/typedoc/classes/util_MongoBinaryDownloadUrl.MongoBinaryDownloadUrl.html +++ b/typedoc/classes/util_MongoBinaryDownloadUrl.MongoBinaryDownloadUrl.html @@ -1,5 +1,5 @@ MongoBinaryDownloadUrl | mongodb-memory-server-core

Class MongoBinaryDownloadUrl

Download URL generator

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

arch os? platform @@ -19,36 +19,36 @@ overwriteDistro translatePlatform translateArch -

Constructors

constructor

Properties

arch

arch: string

Optional os

os?: AnyOS

platform

platform: string

version

version: string

Methods

getAmazonVersionString

  • getAmazonVersionString(os): string

  • Get the version string for Amazon Distro

    +

Constructors

constructor

Properties

arch

arch: string

Optional os

os?: AnyOS

platform

platform: string

version

version: string

Methods

getAmazonVersionString

getArchiveName

getArchiveNameLinux

  • getArchiveNameLinux(): Promise<string>

  • Get the archive for Linux +

Returns string

getArchiveName

getArchiveNameLinux

getArchiveNameOsx

getArchiveNameOsx

getArchiveNameWin

getArchiveNameWin

getDebianVersionString

getDebianVersionString

getDownloadUrl

  • getDownloadUrl(): Promise<string>

  • Assemble the URL to download +

Returns string

getDownloadUrl

getFedoraVersionString

getFedoraVersionString

getLinuxOSVersionString

  • getLinuxOSVersionString(os): string

  • Get the version string (with distro)

    +

Returns string

getLinuxOSVersionString

getRhelVersionString

  • getRhelVersionString(os): string

  • Get the version string for Red Hat Enterprise Linux

    +

Returns string

getRhelVersionString

getSuseVersionString

  • getSuseVersionString(os): string

  • Get the version string for Suse / OpenSuse

    +

Returns string

getSuseVersionString

getUbuntuVersionString

  • getUbuntuVersionString(os): string

  • Get the version string for Ubuntu

    +

Returns string

getUbuntuVersionString

Protected overwriteDistro

translatePlatform

  • translatePlatform(platform): string

  • Translate input platform to mongodb-archive useable platform

    +

Returns string

Protected overwriteDistro

translatePlatform

Static translateArch

Static translateArch

Settings

Member Visibility

Theme

On This Page

constructorarchosplatformversiongetAmazonVersionStringgetArchiveNamegetArchiveNameLinuxgetArchiveNameOsxgetArchiveNameWingetDebianVersionStringgetDownloadUrlgetFedoraVersionStringgetLinuxOSVersionStringgetRhelVersionStringgetSuseVersionStringgetUbuntuVersionStringoverwriteDistrotranslatePlatformtranslateArch
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorarchosplatformversiongetAmazonVersionStringgetArchiveNamegetArchiveNameLinuxgetArchiveNameOsxgetArchiveNameWingetDebianVersionStringgetDownloadUrlgetFedoraVersionStringgetLinuxOSVersionStringgetRhelVersionStringgetSuseVersionStringgetUbuntuVersionStringoverwriteDistrotranslatePlatformtranslateArch
\ No newline at end of file diff --git a/typedoc/classes/util_MongoInstance.MongoInstance.html b/typedoc/classes/util_MongoInstance.MongoInstance.html index 2894d0e9..9466543c 100644 --- a/typedoc/classes/util_MongoInstance.MongoInstance.html +++ b/typedoc/classes/util_MongoInstance.MongoInstance.html @@ -1,6 +1,6 @@ MongoInstance | mongodb-memory-server-core

Class MongoInstance

MongoDB Instance Handler Class This Class starts & stops the "mongod" process directly and handles stdout, sterr and close events

-

Hierarchy

  • EventEmitter
    • MongoInstance

Implements

Constructors

constructor +

Hierarchy

  • EventEmitter
    • MongoInstance

Implements

Constructors

constructor

Properties

binaryOpts extraConnectionOptions? instanceOpts @@ -48,44 +48,44 @@ on once setMaxListeners -

Constructors

constructor

Properties

Readonly binaryOpts

binaryOpts: Readonly<MongoBinaryOpts>

Optional extraConnectionOptions

extraConnectionOptions?: MongoClientOptions

Extra options to append to "mongoclient.connect" +

Constructors

constructor

Properties

Readonly binaryOpts

binaryOpts: Readonly<MongoBinaryOpts>

Optional extraConnectionOptions

extraConnectionOptions?: MongoClientOptions

Extra options to append to "mongoclient.connect" Mainly used for authentication

-

instanceOpts

instanceOpts: MongoMemoryInstanceOpts

isInstancePrimary

isInstancePrimary: boolean = false

This boolean is "true" if the instance is elected to be PRIMARY

-

isInstanceReady

isInstanceReady: boolean = false

This boolean is "true" if the instance is successfully started

-

isReplSet

isReplSet: boolean = false

This boolean is "true" if the instance is part of an replset

-

Optional killerProcess

killerProcess?: ChildProcess

The "mongo_killer" Process reference

-

Optional mongodProcess

mongodProcess?: ChildProcess

The "mongod" Process reference

-

Readonly spawnOpts

spawnOpts: Readonly<SpawnOptions>

Optional stopPromise

stopPromise?: Promise<boolean>

Extra promise to avoid multiple calls of .stop at the same time

+

instanceOpts

instanceOpts: MongoMemoryInstanceOpts

isInstancePrimary

isInstancePrimary: boolean = false

This boolean is "true" if the instance is elected to be PRIMARY

+

isInstanceReady

isInstanceReady: boolean = false

This boolean is "true" if the instance is successfully started

+

isReplSet

isReplSet: boolean = false

This boolean is "true" if the instance is part of an replset

+

Optional killerProcess

killerProcess?: ChildProcess

The "mongo_killer" Process reference

+

Optional mongodProcess

mongodProcess?: ChildProcess

The "mongod" Process reference

+

Readonly spawnOpts

spawnOpts: Readonly<SpawnOptions>

Optional stopPromise

stopPromise?: Promise<boolean>

Extra promise to avoid multiple calls of .stop at the same time

See

https://github.com/typegoose/mongodb-memory-server/issues/802

-

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

+

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

-

Methods

[asyncDispose]

_launchKiller

  • _launchKiller(parentPid, childPid): ChildProcess

  • Spawn an seperate process to kill the parent and the mongod instance to ensure "mongod" gets stopped in any case

    +

Methods

[asyncDispose]

_launchKiller

  • _launchKiller(parentPid, childPid): ChildProcess

  • Spawn an seperate process to kill the parent and the mongod instance to ensure "mongod" gets stopped in any case

    Parameters

    • parentPid: number

      Parent nodejs process

    • childPid: number

      Mongod process to kill

    Returns ChildProcess

    Fires

    MongoInstance#killerLaunched

    -

_launchMongod

_launchMongod

addListener

addListener

  • addListener(eventName, listener): this

  • Alias for emitter.on(eventName, listener).

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

Protected checkErrorInLine

closeHandler

  • closeHandler(code, signal): void

  • Write the CLOSE event to the debug function

    +

Returns void

closeHandler

Protected debug

Protected debug

emit

errorHandler

  • errorHandler(err): void

  • Event "error" handler

    +
  • Rest ...extra: unknown[]

Returns void

emit

errorHandler

eventNames

eventNames

  • eventNames(): (string | symbol)[]

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    @@ -102,8 +102,8 @@

    Fires

    MongoInstance#instanceError

    Parameters

    • eventName: string | symbol

    Returns Function[]

    Since

    v0.1.26

off

  • off(eventName, listener): this

  • Alias for emitter.removeListener().

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v10.0.0

    -

on

once

prepareCommandArgs

prependListener

  • prependListener(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the +

on

once

prepareCommandArgs

prependListener

  • prependListener(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    @@ -164,20 +164,20 @@

    Fires

    MongoInstance#instanceError

    Parameters

    • n: number

    Returns this

    Since

    v0.3.5

start

stderrHandler

stderrHandler

stdoutHandler

stdoutHandler

  • stdoutHandler(message): void

  • Write STDOUT to debug function and process some special messages

    Parameters

    • message: string | Buffer

      The STDOUT line to write/parse

    Returns void

    Fires

    MongoInstance#instanceSTDOUT

    Fires

    MongoInstance#instanceReady

    Fires

    MongoInstance#instanceError

    Fires

    MongoInstance#instancePrimary

    Fires

    MongoInstance#instanceReplState

    -

stop

Static create

stop

Static create

Static getEventListeners

  • getEventListeners(emitter, name): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    +

Returns Promise<MongoInstance>

Static getEventListeners

Static Protected checkLock

Static Protected createLock

  • createLock(file): Promise<LockFile>

  • Function create the path and lock file

    +
  • Optional uuid: string

Returns Promise<LockFileStatus>

Static Protected createLock

Static lock

  • lock(file): Promise<LockFile>

  • Acquire an lockfile

    +

Returns Promise<LockFile>

Static lock

Static Protected waitForLock

  • waitForLock(file): Promise<LockFile>

  • Wait for the Lock file to become available

    +

Returns Promise<LockFile>

Static Protected waitForLock

Settings

Member Visibility

Theme

On This Page

constructorfileuuideventsfilesmutexunlockunlockCleanupcheckLockcreateLocklockwaitForLock
\ No newline at end of file +

Returns Promise<LockFile>

Settings

Member Visibility

Theme

On This Page

constructorfileuuideventsfilesmutexunlockunlockCleanupcheckLockcreateLocklockwaitForLock
\ No newline at end of file diff --git a/typedoc/classes/util_utils.ManagerAdvanced.html b/typedoc/classes/util_utils.ManagerAdvanced.html index c7cd8365..a50eea26 100644 --- a/typedoc/classes/util_utils.ManagerAdvanced.html +++ b/typedoc/classes/util_utils.ManagerAdvanced.html @@ -1,8 +1,8 @@ ManagerAdvanced | mongodb-memory-server-core

Class ManagerAdvancedAbstract

This Class is used to have unified types for advanced-manager functions

-

Hierarchy (view full)

Implemented by

Constructors

constructor +

Hierarchy (view full)

Implemented by

Constructors

constructor

Methods

[asyncDispose] cleanup getUri start stop -

Constructors

constructor

Methods

Abstract [asyncDispose]

Abstract cleanup

Abstract getUri

Abstract start

Abstract stop

Settings

Member Visibility

Theme

On This Page

constructor[asyncDispose]cleanupgetUristartstop
\ No newline at end of file +

Constructors

constructor

Methods

Abstract [asyncDispose]

Abstract cleanup

Abstract getUri

Abstract start

Abstract stop

Settings

Member Visibility

Theme

On This Page

constructor[asyncDispose]cleanupgetUristartstop
\ No newline at end of file diff --git a/typedoc/classes/util_utils.ManagerBase.html b/typedoc/classes/util_utils.ManagerBase.html index 731d1b06..867d31e7 100644 --- a/typedoc/classes/util_utils.ManagerBase.html +++ b/typedoc/classes/util_utils.ManagerBase.html @@ -1,6 +1,6 @@ ManagerBase | mongodb-memory-server-core

Class ManagerBaseAbstract

This Class is used to have unified types for base-manager functions

-

Hierarchy (view full)

Implemented by

Constructors

constructor +

Hierarchy (view full)

Implemented by

Constructors

constructor

Methods

[asyncDispose] start stop -

Constructors

constructor

Methods

Abstract [asyncDispose]

Abstract start

Abstract stop

Settings

Member Visibility

Theme

On This Page

constructor[asyncDispose]startstop
\ No newline at end of file +

Constructors

constructor

Methods

Abstract [asyncDispose]

Abstract start

Abstract stop

Settings

Member Visibility

Theme

On This Page

constructor[asyncDispose]startstop
\ No newline at end of file diff --git a/typedoc/enums/MongoMemoryReplSet.MongoMemoryReplSetEvents.html b/typedoc/enums/MongoMemoryReplSet.MongoMemoryReplSetEvents.html index a1a2e735..bcc3917f 100644 --- a/typedoc/enums/MongoMemoryReplSet.MongoMemoryReplSetEvents.html +++ b/typedoc/enums/MongoMemoryReplSet.MongoMemoryReplSetEvents.html @@ -1,3 +1,3 @@ MongoMemoryReplSetEvents | mongodb-memory-server-core

Enumeration MongoMemoryReplSetEvents

All Events for "MongoMemoryReplSet"

-

Enumeration Members

stateChange -

Enumeration Members

stateChange

stateChange: "stateChange"

Settings

Member Visibility

Theme

On This Page

stateChange
\ No newline at end of file +

Enumeration Members

stateChange +

Enumeration Members

stateChange

stateChange: "stateChange"

Settings

Member Visibility

Theme

On This Page

stateChange
\ No newline at end of file diff --git a/typedoc/enums/MongoMemoryReplSet.MongoMemoryReplSetStates.html b/typedoc/enums/MongoMemoryReplSet.MongoMemoryReplSetStates.html index 715d9831..3e627df5 100644 --- a/typedoc/enums/MongoMemoryReplSet.MongoMemoryReplSetStates.html +++ b/typedoc/enums/MongoMemoryReplSet.MongoMemoryReplSetStates.html @@ -1,5 +1,5 @@ MongoMemoryReplSetStates | mongodb-memory-server-core

Enumeration MongoMemoryReplSetStates

Enum for "_state" inside "MongoMemoryReplSet"

-

Enumeration Members

init +

Enumeration Members

init running stopped -

Enumeration Members

init

init: "init"

running

running: "running"

stopped

stopped: "stopped"

Settings

Member Visibility

Theme

On This Page

initrunningstopped
\ No newline at end of file +

Enumeration Members

init

init: "init"

running

running: "running"

stopped

stopped: "stopped"

Settings

Member Visibility

Theme

On This Page

initrunningstopped
\ No newline at end of file diff --git a/typedoc/enums/MongoMemoryServer.MongoMemoryServerEvents.html b/typedoc/enums/MongoMemoryServer.MongoMemoryServerEvents.html index 8966f09a..a95eab3d 100644 --- a/typedoc/enums/MongoMemoryServer.MongoMemoryServerEvents.html +++ b/typedoc/enums/MongoMemoryServer.MongoMemoryServerEvents.html @@ -1,3 +1,3 @@ MongoMemoryServerEvents | mongodb-memory-server-core

Enumeration MongoMemoryServerEvents

All Events for "MongoMemoryServer"

-

Enumeration Members

stateChange -

Enumeration Members

stateChange

stateChange: "stateChange"

Settings

Member Visibility

Theme

On This Page

stateChange
\ No newline at end of file +

Enumeration Members

stateChange +

Enumeration Members

stateChange

stateChange: "stateChange"

Settings

Member Visibility

Theme

On This Page

stateChange
\ No newline at end of file diff --git a/typedoc/enums/MongoMemoryServer.MongoMemoryServerStates.html b/typedoc/enums/MongoMemoryServer.MongoMemoryServerStates.html index 45d094e2..e882553f 100644 --- a/typedoc/enums/MongoMemoryServer.MongoMemoryServerStates.html +++ b/typedoc/enums/MongoMemoryServer.MongoMemoryServerStates.html @@ -1,6 +1,6 @@ MongoMemoryServerStates | mongodb-memory-server-core

Enumeration MongoMemoryServerStates

All States for "MongoMemoryServer._state"

-

Enumeration Members

new +

Enumeration Members

new running starting stopped -

Enumeration Members

new

new: "new"

running

running: "running"

starting

starting: "starting"

stopped

stopped: "stopped"

Settings

Member Visibility

Theme

On This Page

newrunningstartingstopped
\ No newline at end of file +

Enumeration Members

new

new: "new"

running

running: "running"

starting

starting: "starting"

stopped

stopped: "stopped"

Settings

Member Visibility

Theme

On This Page

newrunningstartingstopped
\ No newline at end of file diff --git a/typedoc/enums/util_MongoInstance.MongoInstanceEvents.html b/typedoc/enums/util_MongoInstance.MongoInstanceEvents.html index 0b42abc7..5f950bd4 100644 --- a/typedoc/enums/util_MongoInstance.MongoInstanceEvents.html +++ b/typedoc/enums/util_MongoInstance.MongoInstanceEvents.html @@ -1,4 +1,4 @@ -MongoInstanceEvents | mongodb-memory-server-core

Enumeration MongoInstanceEvents

Enumeration Members

instanceClosed +MongoInstanceEvents | mongodb-memory-server-core

Enumeration MongoInstanceEvents

Enumeration Members

instanceClosed instanceError instanceLaunched instancePrimary @@ -9,6 +9,6 @@ instanceSTDOUT instanceStarted killerLaunched -

Enumeration Members

instanceClosed

instanceClosed: "instanceClosed"

instanceError

instanceError: "instanceError"

Raw Errors and Custom Errors

-

instanceLaunched

instanceLaunched: "instanceLaunched"

instancePrimary

instancePrimary: "instancePrimary"

instanceRawError

instanceRawError: "instanceRawError"

Only Raw Error (emitted by mongodProcess)

-

instanceReady

instanceReady: "instanceReady"

instanceReplState

instanceReplState: "instanceReplState"

instanceSTDERR

instanceSTDERR: "instanceSTDERR"

instanceSTDOUT

instanceSTDOUT: "instanceSTDOUT"

instanceStarted

instanceStarted: "instanceStarted"

killerLaunched

killerLaunched: "killerLaunched"

Settings

Member Visibility

Theme

On This Page

instanceClosedinstanceErrorinstanceLaunchedinstancePrimaryinstanceRawErrorinstanceReadyinstanceReplStateinstanceSTDERRinstanceSTDOUTinstanceStartedkillerLaunched
\ No newline at end of file +

Enumeration Members

instanceClosed

instanceClosed: "instanceClosed"

instanceError

instanceError: "instanceError"

Raw Errors and Custom Errors

+

instanceLaunched

instanceLaunched: "instanceLaunched"

instancePrimary

instancePrimary: "instancePrimary"

instanceRawError

instanceRawError: "instanceRawError"

Only Raw Error (emitted by mongodProcess)

+

instanceReady

instanceReady: "instanceReady"

instanceReplState

instanceReplState: "instanceReplState"

instanceSTDERR

instanceSTDERR: "instanceSTDERR"

instanceSTDOUT

instanceSTDOUT: "instanceSTDOUT"

instanceStarted

instanceStarted: "instanceStarted"

killerLaunched

killerLaunched: "killerLaunched"

Settings

Member Visibility

Theme

On This Page

instanceClosedinstanceErrorinstanceLaunchedinstancePrimaryinstanceRawErrorinstanceReadyinstanceReplStateinstanceSTDERRinstanceSTDOUTinstanceStartedkillerLaunched
\ No newline at end of file diff --git a/typedoc/enums/util_lockfile.LockFileEvents.html b/typedoc/enums/util_lockfile.LockFileEvents.html index ebcdc487..9c155b13 100644 --- a/typedoc/enums/util_lockfile.LockFileEvents.html +++ b/typedoc/enums/util_lockfile.LockFileEvents.html @@ -1,3 +1,3 @@ -LockFileEvents | mongodb-memory-server-core

Enumeration LockFileEvents

Enumeration Members

lock +LockFileEvents | mongodb-memory-server-core

Enumeration LockFileEvents

Enumeration Members

lock unlock -

Enumeration Members

lock

lock: "lock"

unlock

unlock: "unlock"

Settings

Member Visibility

Theme

On This Page

lockunlock
\ No newline at end of file +

Enumeration Members

lock

lock: "lock"

unlock

unlock: "unlock"

Settings

Member Visibility

Theme

On This Page

lockunlock
\ No newline at end of file diff --git a/typedoc/enums/util_lockfile.LockFileStatus.html b/typedoc/enums/util_lockfile.LockFileStatus.html index a9b154f2..a60d88d7 100644 --- a/typedoc/enums/util_lockfile.LockFileStatus.html +++ b/typedoc/enums/util_lockfile.LockFileStatus.html @@ -1,9 +1,9 @@ -LockFileStatus | mongodb-memory-server-core

Enumeration LockFileStatus

Enumeration Members

available +LockFileStatus | mongodb-memory-server-core

Enumeration LockFileStatus

Enumeration Members

available availableInstance lockedDifferent lockedSelf

Enumeration Members

available

available: 0

Status is "available" to be grabbed (lockfile not existing or being invalid)

-

availableInstance

availableInstance: 1

Status is "available for asking instance" (instance that asked has the lock)

-

lockedDifferent

lockedDifferent: 3

Status is "locked by another process"

-

lockedSelf

lockedSelf: 2

Status is "locked by another instance in this process"

-

Settings

Member Visibility

Theme

On This Page

availableavailableInstancelockedDifferentlockedSelf
\ No newline at end of file +

availableInstance

availableInstance: 1

Status is "available for asking instance" (instance that asked has the lock)

+

lockedDifferent

lockedDifferent: 3

Status is "locked by another process"

+

lockedSelf

lockedSelf: 2

Status is "locked by another instance in this process"

+

Settings

Member Visibility

Theme

On This Page

availableavailableInstancelockedDifferentlockedSelf
\ No newline at end of file diff --git a/typedoc/enums/util_resolveConfig.ResolveConfigVariables.html b/typedoc/enums/util_resolveConfig.ResolveConfigVariables.html index 4620d951..9d393e3f 100644 --- a/typedoc/enums/util_resolveConfig.ResolveConfigVariables.html +++ b/typedoc/enums/util_resolveConfig.ResolveConfigVariables.html @@ -1,5 +1,5 @@ ResolveConfigVariables | mongodb-memory-server-core

Enumeration ResolveConfigVariables

Enum of all possible config options

-

Enumeration Members

ARCH +

Enumeration Members

ARCH ARCHIVE_NAME DEBUG DISABLE_POSTINSTALL @@ -18,4 +18,4 @@ USE_ARCHIVE_NAME_FOR_BINARY_NAME USE_HTTP VERSION -

Enumeration Members

ARCH

ARCH: "ARCH"

ARCHIVE_NAME

ARCHIVE_NAME: "ARCHIVE_NAME"

DEBUG

DEBUG: "DEBUG"

DISABLE_POSTINSTALL

DISABLE_POSTINSTALL: "DISABLE_POSTINSTALL"

DISTRO

DISTRO: "DISTRO"

DOWNLOAD_DIR

DOWNLOAD_DIR: "DOWNLOAD_DIR"

DOWNLOAD_IGNORE_MISSING_HEADER

DOWNLOAD_IGNORE_MISSING_HEADER: "DOWNLOAD_IGNORE_MISSING_HEADER"

DOWNLOAD_MIRROR

DOWNLOAD_MIRROR: "DOWNLOAD_MIRROR"

DOWNLOAD_URL

DOWNLOAD_URL: "DOWNLOAD_URL"

MAX_REDIRECTS

MAX_REDIRECTS: "MAX_REDIRECTS"

MD5_CHECK

MD5_CHECK: "MD5_CHECK"

PLATFORM

PLATFORM: "PLATFORM"

PREFER_GLOBAL_PATH

PREFER_GLOBAL_PATH: "PREFER_GLOBAL_PATH"

RUNTIME_DOWNLOAD

RUNTIME_DOWNLOAD: "RUNTIME_DOWNLOAD"

SYSTEM_BINARY

SYSTEM_BINARY: "SYSTEM_BINARY"

SYSTEM_BINARY_VERSION_CHECK

SYSTEM_BINARY_VERSION_CHECK: "SYSTEM_BINARY_VERSION_CHECK"

USE_ARCHIVE_NAME_FOR_BINARY_NAME

USE_ARCHIVE_NAME_FOR_BINARY_NAME: "USE_ARCHIVE_NAME_FOR_BINARY_NAME"

USE_HTTP

USE_HTTP: "USE_HTTP"

VERSION

VERSION: "VERSION"

Settings

Member Visibility

Theme

On This Page

ARCHARCHIVE_NAMEDEBUGDISABLE_POSTINSTALLDISTRODOWNLOAD_DIRDOWNLOAD_IGNORE_MISSING_HEADERDOWNLOAD_MIRRORDOWNLOAD_URLMAX_REDIRECTSMD5_CHECKPLATFORMPREFER_GLOBAL_PATHRUNTIME_DOWNLOADSYSTEM_BINARYSYSTEM_BINARY_VERSION_CHECKUSE_ARCHIVE_NAME_FOR_BINARY_NAMEUSE_HTTPVERSION
\ No newline at end of file +

Enumeration Members

ARCH

ARCH: "ARCH"

ARCHIVE_NAME

ARCHIVE_NAME: "ARCHIVE_NAME"

DEBUG

DEBUG: "DEBUG"

DISABLE_POSTINSTALL

DISABLE_POSTINSTALL: "DISABLE_POSTINSTALL"

DISTRO

DISTRO: "DISTRO"

DOWNLOAD_DIR

DOWNLOAD_DIR: "DOWNLOAD_DIR"

DOWNLOAD_IGNORE_MISSING_HEADER

DOWNLOAD_IGNORE_MISSING_HEADER: "DOWNLOAD_IGNORE_MISSING_HEADER"

DOWNLOAD_MIRROR

DOWNLOAD_MIRROR: "DOWNLOAD_MIRROR"

DOWNLOAD_URL

DOWNLOAD_URL: "DOWNLOAD_URL"

MAX_REDIRECTS

MAX_REDIRECTS: "MAX_REDIRECTS"

MD5_CHECK

MD5_CHECK: "MD5_CHECK"

PLATFORM

PLATFORM: "PLATFORM"

PREFER_GLOBAL_PATH

PREFER_GLOBAL_PATH: "PREFER_GLOBAL_PATH"

RUNTIME_DOWNLOAD

RUNTIME_DOWNLOAD: "RUNTIME_DOWNLOAD"

SYSTEM_BINARY

SYSTEM_BINARY: "SYSTEM_BINARY"

SYSTEM_BINARY_VERSION_CHECK

SYSTEM_BINARY_VERSION_CHECK: "SYSTEM_BINARY_VERSION_CHECK"

USE_ARCHIVE_NAME_FOR_BINARY_NAME

USE_ARCHIVE_NAME_FOR_BINARY_NAME: "USE_ARCHIVE_NAME_FOR_BINARY_NAME"

USE_HTTP

USE_HTTP: "USE_HTTP"

VERSION

VERSION: "VERSION"

Settings

Member Visibility

Theme

On This Page

ARCHARCHIVE_NAMEDEBUGDISABLE_POSTINSTALLDISTRODOWNLOAD_DIRDOWNLOAD_IGNORE_MISSING_HEADERDOWNLOAD_MIRRORDOWNLOAD_URLMAX_REDIRECTSMD5_CHECKPLATFORMPREFER_GLOBAL_PATHRUNTIME_DOWNLOADSYSTEM_BINARYSYSTEM_BINARY_VERSION_CHECKUSE_ARCHIVE_NAME_FOR_BINARY_NAMEUSE_HTTPVERSION
\ No newline at end of file diff --git a/typedoc/functions/util_getos.getOS.html b/typedoc/functions/util_getos.getOS.html index bc4b3945..d4ffd05f 100644 --- a/typedoc/functions/util_getos.getOS.html +++ b/typedoc/functions/util_getos.getOS.html @@ -1,2 +1,2 @@ getOS | mongodb-memory-server-core

Function getOS

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns Promise<AnyOS>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/typedoc/functions/util_getos.isLinuxOS.html b/typedoc/functions/util_getos.isLinuxOS.html index 3cf269e6..77b0d647 100644 --- a/typedoc/functions/util_getos.isLinuxOS.html +++ b/typedoc/functions/util_getos.isLinuxOS.html @@ -1,3 +1,3 @@ isLinuxOS | mongodb-memory-server-core

Function isLinuxOS

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns os is LinuxOS

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/typedoc/functions/util_getos.isValidOs.html b/typedoc/functions/util_getos.isValidOs.html index fed6c2a1..1c602758 100644 --- a/typedoc/functions/util_getos.isValidOs.html +++ b/typedoc/functions/util_getos.isValidOs.html @@ -1,4 +1,4 @@ isValidOs | mongodb-memory-server-core

Function isValidOs

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/typedoc/functions/util_getos.parseLSB.html b/typedoc/functions/util_getos.parseLSB.html index 5aa1ac53..dc1d9c99 100644 --- a/typedoc/functions/util_getos.parseLSB.html +++ b/typedoc/functions/util_getos.parseLSB.html @@ -1,2 +1,2 @@ parseLSB | mongodb-memory-server-core

Function parseLSB

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

  • input: string

Returns LinuxOS

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/typedoc/functions/util_getos.parseOS.html b/typedoc/functions/util_getos.parseOS.html index 6c23a786..3f0e85c0 100644 --- a/typedoc/functions/util_getos.parseOS.html +++ b/typedoc/functions/util_getos.parseOS.html @@ -1,2 +1,2 @@ parseOS | mongodb-memory-server-core

Function parseOS

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

  • input: string

Returns LinuxOS

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/typedoc/functions/util_getport.getFreePort.html b/typedoc/functions/util_getport.getFreePort.html index 7c3b7c94..69e594e4 100644 --- a/typedoc/functions/util_getport.getFreePort.html +++ b/typedoc/functions/util_getport.getFreePort.html @@ -3,4 +3,4 @@
  • max_tries: number = MAX_DEFAULT_TRIES

    maximum amount of tries to get a port, default to MAX_DEFAULT_TRIES

    • Returns Promise<number>

    A valid free port

    Throws

    if "max_tries" is exceeded

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_getport.resetPortsCache.html b/typedoc/functions/util_getport.resetPortsCache.html index 1ae3d504..e2ec1397 100644 --- a/typedoc/functions/util_getport.resetPortsCache.html +++ b/typedoc/functions/util_getport.resetPortsCache.html @@ -1,3 +1,3 @@ resetPortsCache | mongodb-memory-server-core

    Function resetPortsCache

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_getport.tryPort.html b/typedoc/functions/util_getport.tryPort.html index e9e39034..83f29f8c 100644 --- a/typedoc/functions/util_getport.tryPort.html +++ b/typedoc/functions/util_getport.tryPort.html @@ -2,4 +2,4 @@

    Parameters

    • port: number

      The port to try

    Returns Promise<number>

    the port if successful, "-1" in case of EADDRINUSE, all other errors reject

    Throws

    The error given if the code is not "EADDRINUSE"

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_getport.validPort.html b/typedoc/functions/util_getport.validPort.html index e16be3f5..f258a9a7 100644 --- a/typedoc/functions/util_getport.validPort.html +++ b/typedoc/functions/util_getport.validPort.html @@ -2,4 +2,4 @@ If more than MAX_PORT, wrap around, if less than MIN_PORT use MIN_PORT.

    Parameters

    • port: number

      The Number to check

    Returns number

    A Valid number in port range

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_postinstallHelper.postInstallEnsureBinary.html b/typedoc/functions/util_postinstallHelper.postInstallEnsureBinary.html index cb0bcad8..7b44dfa0 100644 --- a/typedoc/functions/util_postinstallHelper.postInstallEnsureBinary.html +++ b/typedoc/functions/util_postinstallHelper.postInstallEnsureBinary.html @@ -1 +1 @@ -postInstallEnsureBinary | mongodb-memory-server-core

    Function postInstallEnsureBinary

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +postInstallEnsureBinary | mongodb-memory-server-core

    Function postInstallEnsureBinary

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_resolveConfig.envName.html b/typedoc/functions/util_resolveConfig.envName.html index 80bf71f5..e89ba388 100644 --- a/typedoc/functions/util_resolveConfig.envName.html +++ b/typedoc/functions/util_resolveConfig.envName.html @@ -1,2 +1,2 @@ envName | mongodb-memory-server-core

    Function envName

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_resolveConfig.envToBool.html b/typedoc/functions/util_resolveConfig.envToBool.html index 5dfaec1b..ce4970b2 100644 --- a/typedoc/functions/util_resolveConfig.envToBool.html +++ b/typedoc/functions/util_resolveConfig.envToBool.html @@ -1,3 +1,3 @@ envToBool | mongodb-memory-server-core

    Function envToBool

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_resolveConfig.findPackageJson.html b/typedoc/functions/util_resolveConfig.findPackageJson.html index acbacf29..c268ffdd 100644 --- a/typedoc/functions/util_resolveConfig.findPackageJson.html +++ b/typedoc/functions/util_resolveConfig.findPackageJson.html @@ -1,4 +1,4 @@ findPackageJson | mongodb-memory-server-core

    Function findPackageJson

    • findPackageJson(directory?): PackageJSON | undefined

    • Find the nearest package.json (that has an non-empty config field) for the provided directory

      Parameters

      • Optional directory: string

        Set an custom directory to search the config in (default: process.cwd())

      Returns PackageJSON | undefined

      what "packagejson" variable is

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_resolveConfig.packageJsonPath.html b/typedoc/functions/util_resolveConfig.packageJsonPath.html index 585aa639..69bf7c8b 100644 --- a/typedoc/functions/util_resolveConfig.packageJsonPath.html +++ b/typedoc/functions/util_resolveConfig.packageJsonPath.html @@ -1,3 +1,3 @@ packageJsonPath | mongodb-memory-server-core

    Function packageJsonPath

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_resolveConfig.processConfigOption.html b/typedoc/functions/util_resolveConfig.processConfigOption.html index b2a8a6e3..e608ee31 100644 --- a/typedoc/functions/util_resolveConfig.processConfigOption.html +++ b/typedoc/functions/util_resolveConfig.processConfigOption.html @@ -2,4 +2,4 @@

    Parameters

    • input: unknown

      The input to process

    • filepath: string

      The FilePath for the input to resolve relative paths to (needs to be a dirname and absolute)

    Returns Record<string, string>

    always returns a object

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_resolveConfig.resolveConfig.html b/typedoc/functions/util_resolveConfig.resolveConfig.html index 389d8905..f5bdcb36 100644 --- a/typedoc/functions/util_resolveConfig.resolveConfig.html +++ b/typedoc/functions/util_resolveConfig.resolveConfig.html @@ -1,3 +1,3 @@ resolveConfig | mongodb-memory-server-core

    Function resolveConfig

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string | undefined

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_resolveConfig.setDefaultValue.html b/typedoc/functions/util_resolveConfig.setDefaultValue.html index b9c159de..3e91fa88 100644 --- a/typedoc/functions/util_resolveConfig.setDefaultValue.html +++ b/typedoc/functions/util_resolveConfig.setDefaultValue.html @@ -2,4 +2,4 @@ Mostly only used internally (for the "global-x.x" packages)

    Parameters

    • key: ResolveConfigVariables

      The Key the default value should be assigned to

    • value: string

      The Value what the default should be

      -

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.assertion.html b/typedoc/functions/util_utils.assertion.html index 05b47490..c6d65178 100644 --- a/typedoc/functions/util_utils.assertion.html +++ b/typedoc/functions/util_utils.assertion.html @@ -2,4 +2,4 @@ Note: it is not named "assert" to differentiate between node and jest types

    Parameters

    • cond: unknown

      The Condition to throw

    • Optional error: Error

      An Custom Error to throw

      -

    Returns asserts cond

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns asserts cond

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.authDefault.html b/typedoc/functions/util_utils.authDefault.html index c94908fb..efb99178 100644 --- a/typedoc/functions/util_utils.authDefault.html +++ b/typedoc/functions/util_utils.authDefault.html @@ -1,3 +1,3 @@ authDefault | mongodb-memory-server-core

    Function authDefault

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Required<AutomaticAuth>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.checkBinaryPermissions.html b/typedoc/functions/util_utils.checkBinaryPermissions.html index e15212b8..f1bd0ff8 100644 --- a/typedoc/functions/util_utils.checkBinaryPermissions.html +++ b/typedoc/functions/util_utils.checkBinaryPermissions.html @@ -1,3 +1,3 @@ checkBinaryPermissions | mongodb-memory-server-core

    Function checkBinaryPermissions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.createTmpDir.html b/typedoc/functions/util_utils.createTmpDir.html index 19ad2876..fdd18a56 100644 --- a/typedoc/functions/util_utils.createTmpDir.html +++ b/typedoc/functions/util_utils.createTmpDir.html @@ -2,4 +2,4 @@

    Parameters

    • prefix: string

      The prefix to use to create the tmpdir

    • Optional atPath: string

      Optionally set a custom path other than "os.tmpdir"

    Returns Promise<string>

    The created Path

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.ensureAsync.html b/typedoc/functions/util_utils.ensureAsync.html index 9213e4e3..a321cb5c 100644 --- a/typedoc/functions/util_utils.ensureAsync.html +++ b/typedoc/functions/util_utils.ensureAsync.html @@ -1,3 +1,3 @@ ensureAsync | mongodb-memory-server-core

    Function ensureAsync

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.errorWithCode.html b/typedoc/functions/util_utils.errorWithCode.html index 6c9826cb..ce7520a3 100644 --- a/typedoc/functions/util_utils.errorWithCode.html +++ b/typedoc/functions/util_utils.errorWithCode.html @@ -1,4 +1,4 @@ errorWithCode | mongodb-memory-server-core

    Function errorWithCode

    • errorWithCode(err): err is ErrorWithCode

    • This is here, because NodeJS does not have a FSError type

      Parameters

      • err: unknown

        Value to check agains

      Returns err is ErrorWithCode

      true if it is a error with code, false if not

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.generateDbName.html b/typedoc/functions/util_utils.generateDbName.html index 6971e0d1..92abac46 100644 --- a/typedoc/functions/util_utils.generateDbName.html +++ b/typedoc/functions/util_utils.generateDbName.html @@ -1,2 +1,2 @@ generateDbName | mongodb-memory-server-core

    Function generateDbName

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    • Optional dbName: string

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.getHost.html b/typedoc/functions/util_utils.getHost.html index 5278ecb0..621b961b 100644 --- a/typedoc/functions/util_utils.getHost.html +++ b/typedoc/functions/util_utils.getHost.html @@ -1,3 +1,3 @@ getHost | mongodb-memory-server-core

    Function getHost

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.getStorageEngine.html b/typedoc/functions/util_utils.getStorageEngine.html index 41a4ea74..2c03b66e 100644 --- a/typedoc/functions/util_utils.getStorageEngine.html +++ b/typedoc/functions/util_utils.getStorageEngine.html @@ -2,4 +2,4 @@

    Parameters

    • storageEngine: undefined | StorageEngine

      The engine that is configured

    • coercedVersion: SemVer

      The binary version as semver

    Returns StorageEngine

    The engine that actually will run in the given binary version

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.isAlive.html b/typedoc/functions/util_utils.isAlive.html index c51479fd..aff1cddf 100644 --- a/typedoc/functions/util_utils.isAlive.html +++ b/typedoc/functions/util_utils.isAlive.html @@ -1,3 +1,3 @@ isAlive | mongodb-memory-server-core

    Function isAlive

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.isNullOrUndefined.html b/typedoc/functions/util_utils.isNullOrUndefined.html index cf22f90f..2174d7f4 100644 --- a/typedoc/functions/util_utils.isNullOrUndefined.html +++ b/typedoc/functions/util_utils.isNullOrUndefined.html @@ -1,3 +1,3 @@ isNullOrUndefined | mongodb-memory-server-core

    Function isNullOrUndefined

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns val is undefined | null

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.killProcess.html b/typedoc/functions/util_utils.killProcess.html index 7259669d..82e41cab 100644 --- a/typedoc/functions/util_utils.killProcess.html +++ b/typedoc/functions/util_utils.killProcess.html @@ -2,4 +2,4 @@

    Parameters

    • childprocess: ChildProcess

      The Process to kill

    • name: string

      the name used in the logs

    • Optional mongodPort: number

      the port for the mongod process (for easier logging)

      -

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.lockfilePath.html b/typedoc/functions/util_utils.lockfilePath.html index 6b851ff6..19f76175 100644 --- a/typedoc/functions/util_utils.lockfilePath.html +++ b/typedoc/functions/util_utils.lockfilePath.html @@ -2,4 +2,4 @@

    Parameters

    • downloadDir: string

      The Download directory of the binary

    • version: string

      The version to be downlaoded

    Returns string

    The lockfile path

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.md5.html b/typedoc/functions/util_utils.md5.html index 25e5cae9..b14925be 100644 --- a/typedoc/functions/util_utils.md5.html +++ b/typedoc/functions/util_utils.md5.html @@ -1,4 +1,4 @@ md5 | mongodb-memory-server-core

    Function md5

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.md5FromFile.html b/typedoc/functions/util_utils.md5FromFile.html index 203cbd21..d23faa9a 100644 --- a/typedoc/functions/util_utils.md5FromFile.html +++ b/typedoc/functions/util_utils.md5FromFile.html @@ -1,4 +1,4 @@ md5FromFile | mongodb-memory-server-core

    Function md5FromFile

    • md5FromFile(file): Promise<string>

    • Helper function to have md5 generation and definition in one place for a file

      Parameters

      • file: string

        the location of a file to read for a hash

      Returns Promise<string>

      a md5 of the input file

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.mkdir.html b/typedoc/functions/util_utils.mkdir.html index 39f4de1a..b3fd98c0 100644 --- a/typedoc/functions/util_utils.mkdir.html +++ b/typedoc/functions/util_utils.mkdir.html @@ -1,4 +1,4 @@ mkdir | mongodb-memory-server-core

    Function mkdir

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.pathExists.html b/typedoc/functions/util_utils.pathExists.html index 9949bb19..d35bd380 100644 --- a/typedoc/functions/util_utils.pathExists.html +++ b/typedoc/functions/util_utils.pathExists.html @@ -2,4 +2,4 @@ uses "utils.statPath" follows symlinks

    Parameters

    • path: string

      The Path to check for

      -

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.removeDir.html b/typedoc/functions/util_utils.removeDir.html index 05ec30c6..928263b4 100644 --- a/typedoc/functions/util_utils.removeDir.html +++ b/typedoc/functions/util_utils.removeDir.html @@ -1,4 +1,4 @@ removeDir | mongodb-memory-server-core

    Function removeDir

    • removeDir(dirPath): Promise<void>

    • Removes the given "path", if it is a directory, and does not throw a error if not existing

      Parameters

      • dirPath: string

        The Directory Path to delete

      Returns Promise<void>

      "true" if deleted, otherwise "false"

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.statPath.html b/typedoc/functions/util_utils.statPath.html index 9cbdfed3..900299c4 100644 --- a/typedoc/functions/util_utils.statPath.html +++ b/typedoc/functions/util_utils.statPath.html @@ -2,4 +2,4 @@ follows symlinks

    Parameters

    • path: string

      The Path to Stat

    Returns Promise<Stats | undefined>

    Throws

    if the error is not "ENOENT" or "EACCES"

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.tryReleaseFile.html b/typedoc/functions/util_utils.tryReleaseFile.html index f6de6315..8e774223 100644 --- a/typedoc/functions/util_utils.tryReleaseFile.html +++ b/typedoc/functions/util_utils.tryReleaseFile.html @@ -1,4 +1,4 @@ tryReleaseFile | mongodb-memory-server-core

    Function tryReleaseFile

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
      • (output): undefined | LinuxOS

      • Parameters

        • output: string

        Returns undefined | LinuxOS

    Returns Promise<LinuxOS | undefined>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.uriTemplate.html b/typedoc/functions/util_utils.uriTemplate.html index 47c58b37..cb509653 100644 --- a/typedoc/functions/util_utils.uriTemplate.html +++ b/typedoc/functions/util_utils.uriTemplate.html @@ -3,4 +3,4 @@
  • port: undefined | number

    the host port or undefined if "host" is an list of hosts

  • dbName: string

    the database to add to the uri (in mongodb its the auth database, in mongoose its the default database for models)

  • Optional query: string[]

    extra uri-query options (joined with "&")

    -

    • Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/functions/util_utils.uuidv4.html b/typedoc/functions/util_utils.uuidv4.html index 9c2c3a51..af9e5665 100644 --- a/typedoc/functions/util_utils.uuidv4.html +++ b/typedoc/functions/util_utils.uuidv4.html @@ -1,3 +1,3 @@ uuidv4 | mongodb-memory-server-core

    Function uuidv4

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryReplSet.MongoMemoryReplSetConfigSettings.html b/typedoc/interfaces/MongoMemoryReplSet.MongoMemoryReplSetConfigSettings.html index f4c48aa9..47dd88d2 100644 --- a/typedoc/interfaces/MongoMemoryReplSet.MongoMemoryReplSetConfigSettings.html +++ b/typedoc/interfaces/MongoMemoryReplSet.MongoMemoryReplSetConfigSettings.html @@ -1,7 +1,7 @@ MongoMemoryReplSetConfigSettings | mongodb-memory-server-core

    Interface MongoMemoryReplSetConfigSettings

    Options for "rsConfig"

    -
    interface MongoMemoryReplSetConfigSettings {
        catchUpTimeoutMillis?: number;
        chainingAllowed?: boolean;
        electionTimeoutMillis?: number;
        heartbeatIntervalMillis?: number;
        heartbeatTimeoutSecs?: number;
    }

    Properties

    catchUpTimeoutMillis? +
    interface MongoMemoryReplSetConfigSettings {
        catchUpTimeoutMillis?: number;
        chainingAllowed?: boolean;
        electionTimeoutMillis?: number;
        heartbeatIntervalMillis?: number;
        heartbeatTimeoutSecs?: number;
    }

    Properties

    catchUpTimeoutMillis? chainingAllowed? electionTimeoutMillis? heartbeatIntervalMillis? heartbeatTimeoutSecs? -

    Properties

    Optional catchUpTimeoutMillis

    catchUpTimeoutMillis?: number

    Optional chainingAllowed

    chainingAllowed?: boolean

    Optional electionTimeoutMillis

    electionTimeoutMillis?: number

    Optional heartbeatIntervalMillis

    heartbeatIntervalMillis?: number

    Optional heartbeatTimeoutSecs

    heartbeatTimeoutSecs?: number

    Settings

    Member Visibility

    Theme

    On This Page

    catchUpTimeoutMillischainingAllowedelectionTimeoutMillisheartbeatIntervalMillisheartbeatTimeoutSecs
    \ No newline at end of file +

    Properties

    Optional catchUpTimeoutMillis

    catchUpTimeoutMillis?: number

    Optional chainingAllowed

    chainingAllowed?: boolean

    Optional electionTimeoutMillis

    electionTimeoutMillis?: number

    Optional heartbeatIntervalMillis

    heartbeatIntervalMillis?: number

    Optional heartbeatTimeoutSecs

    heartbeatTimeoutSecs?: number

    Settings

    Member Visibility

    Theme

    On This Page

    catchUpTimeoutMillischainingAllowedelectionTimeoutMillisheartbeatIntervalMillisheartbeatTimeoutSecs
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryReplSet.MongoMemoryReplSetOpts.html b/typedoc/interfaces/MongoMemoryReplSet.MongoMemoryReplSetOpts.html index 5ea71136..63635e94 100644 --- a/typedoc/interfaces/MongoMemoryReplSet.MongoMemoryReplSetOpts.html +++ b/typedoc/interfaces/MongoMemoryReplSet.MongoMemoryReplSetOpts.html @@ -1,9 +1,9 @@ MongoMemoryReplSetOpts | mongodb-memory-server-core

    Interface MongoMemoryReplSetOpts

    Options for the replSet

    -
    interface MongoMemoryReplSetOpts {
        binary: MongoBinaryOpts;
        instanceOpts: MongoMemoryInstanceOptsBase[];
        replSet: ReplSetOpts;
    }

    Properties

    binary +
    interface MongoMemoryReplSetOpts {
        binary: MongoBinaryOpts;
        instanceOpts: MongoMemoryInstanceOptsBase[];
        replSet: ReplSetOpts;
    }

    Properties

    binary instanceOpts replSet

    Properties

    binary

    binary: MongoBinaryOpts

    Binary Options used for all instances

    -

    instanceOpts

    instanceOpts: MongoMemoryInstanceOptsBase[]

    Specific Options to use for some instances

    -

    replSet

    replSet: ReplSetOpts

    Options used for all instances +

    instanceOpts

    instanceOpts: MongoMemoryInstanceOptsBase[]

    Specific Options to use for some instances

    +

    replSet

    replSet: ReplSetOpts

    Options used for all instances -> gets overwritten by specific "instanceOpts"

    -

    Settings

    Member Visibility

    Theme

    On This Page

    binaryinstanceOptsreplSet
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    binaryinstanceOptsreplSet
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryReplSet.ReplSetOpts.html b/typedoc/interfaces/MongoMemoryReplSet.ReplSetOpts.html index 7881a97e..6838b19e 100644 --- a/typedoc/interfaces/MongoMemoryReplSet.ReplSetOpts.html +++ b/typedoc/interfaces/MongoMemoryReplSet.ReplSetOpts.html @@ -1,5 +1,5 @@ ReplSetOpts | mongodb-memory-server-core

    Interface ReplSetOpts

    Replica set specific options.

    -
    interface ReplSetOpts {
        args?: string[];
        auth?: AutomaticAuth;
        configSettings?: MongoMemoryReplSetConfigSettings;
        count?: number;
        dbName?: string;
        dispose?: DisposeOptions;
        ip?: string;
        name?: string;
        spawn?: SpawnOptions;
        storageEngine?: StorageEngine;
    }

    Properties

    args? +
    interface ReplSetOpts {
        args?: string[];
        auth?: AutomaticAuth;
        configSettings?: MongoMemoryReplSetConfigSettings;
        count?: number;
        dbName?: string;
        dispose?: DisposeOptions;
        ip?: string;
        name?: string;
        spawn?: SpawnOptions;
        storageEngine?: StorageEngine;
    }

    Properties

    args? auth? configSettings? count? @@ -12,29 +12,29 @@

    Properties

    Optional args

    args?: string[]

    additional command line arguments passed to mongod

    Default

    []
    -

    Optional auth

    auth?: AutomaticAuth

    Enable Authentication

    +

    Optional auth

    auth?: AutomaticAuth

    Enable Authentication

    Default

    false
    -

    Optional configSettings

    configSettings?: MongoMemoryReplSetConfigSettings

    Options for "rsConfig"

    +

    Optional configSettings

    configSettings?: MongoMemoryReplSetConfigSettings

    Options for "rsConfig"

    Default

    {}
    -

    Optional count

    count?: number

    if this number is bigger than "instanceOpts.length", more "generic" servers get started +

    Optional count

    count?: number

    if this number is bigger than "instanceOpts.length", more "generic" servers get started if this number is lower than "instanceOpts.length", no more "generic" servers get started (server count will be "instanceOpts.length")

    Default

    1
    -

    Optional dbName

    dbName?: string

    add an database into the uri (in mongodb its the auth database, in mongoose its the default database for models)

    +

    Optional dbName

    dbName?: string

    add an database into the uri (in mongodb its the auth database, in mongoose its the default database for models)

    Default

    ""
    -

    Optional dispose

    dispose?: DisposeOptions

    Options for automatic dispose for "Explicit Resource Management"

    -

    Optional ip

    ip?: string

    bind to all IP addresses specify ::,0.0.0.0

    +

    Optional dispose

    dispose?: DisposeOptions

    Options for automatic dispose for "Explicit Resource Management"

    +

    Optional ip

    ip?: string

    bind to all IP addresses specify ::,0.0.0.0

    Default

    '127.0.0.1'
    -

    Optional name

    name?: string

    replSet name

    +

    Optional name

    name?: string

    replSet name

    Default

    'testset'
    -

    Optional spawn

    spawn?: SpawnOptions

    Childprocess spawn options

    +

    Optional spawn

    spawn?: SpawnOptions

    Childprocess spawn options

    Default

    {}
    -

    Optional storageEngine

    storageEngine?: StorageEngine

    mongod storage engine type

    +

    Optional storageEngine

    storageEngine?: StorageEngine

    mongod storage engine type

    Default

    'ephemeralForTest' unless mongodb version is 7.0.0, where its wiredTiger

    -

    Settings

    Member Visibility

    Theme

    On This Page

    argsauthconfigSettingscountdbNamedisposeipnamespawnstorageEngine
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    argsauthconfigSettingscountdbNamedisposeipnamespawnstorageEngine
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.AutomaticAuth.html b/typedoc/interfaces/MongoMemoryServer.AutomaticAuth.html index 9e7485e2..4715cdb2 100644 --- a/typedoc/interfaces/MongoMemoryServer.AutomaticAuth.html +++ b/typedoc/interfaces/MongoMemoryServer.AutomaticAuth.html @@ -1,4 +1,4 @@ -AutomaticAuth | mongodb-memory-server-core

    Interface AutomaticAuth

    interface AutomaticAuth {
        customRootName?: string;
        customRootPwd?: string;
        enable?: boolean;
        extraUsers?: CreateUser[];
        force?: boolean;
        keyfileContent?: string;
    }

    Properties

    customRootName? +AutomaticAuth | mongodb-memory-server-core

    Interface AutomaticAuth

    interface AutomaticAuth {
        customRootName?: string;
        customRootPwd?: string;
        enable?: boolean;
        extraUsers?: CreateUser[];
        force?: boolean;
        keyfileContent?: string;
    }

    Properties

    customRootName? customRootPwd? enable? extraUsers? @@ -7,20 +7,20 @@

    Properties

    Optional customRootName

    customRootName?: string

    mongodb-memory-server automatically creates a root user (with "root" role)

    Default

    'mongodb-memory-server-root'
    -

    Optional customRootPwd

    customRootPwd?: string

    mongodb-memory-server automatically creates a root user with this password

    +

    Optional customRootPwd

    customRootPwd?: string

    mongodb-memory-server automatically creates a root user with this password

    Default

    'rootuser'
    -

    Optional enable

    enable?: boolean

    Enable Automatic User creation

    +

    Optional enable

    enable?: boolean

    Enable Automatic User creation

    Default

    false
    -

    Optional extraUsers

    extraUsers?: CreateUser[]

    Extra Users to create besides the root user

    +

    Optional extraUsers

    extraUsers?: CreateUser[]

    Extra Users to create besides the root user

    Default

    []
    -

    Optional force

    force?: boolean

    Force to run "createAuth"

    +

    Optional force

    force?: boolean

    Force to run "createAuth"

    Default

    false "createAuth" is normally only run when the given "dbPath" is empty (no files)
    -

    Optional keyfileContent

    keyfileContent?: string

    Custom Keyfile content to use (only has an effect in replset's) +

    Optional keyfileContent

    keyfileContent?: string

    Custom Keyfile content to use (only has an effect in replset's) Note: This is not secure, this is for test environments only!

    Default

    "0123456789"
    -

    Settings

    Member Visibility

    Theme

    On This Page

    customRootNamecustomRootPwdenableextraUsersforcekeyfileContent
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    customRootNamecustomRootPwdenableextraUsersforcekeyfileContent
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.CreateUser.html b/typedoc/interfaces/MongoMemoryServer.CreateUser.html index 76606f4c..2be24563 100644 --- a/typedoc/interfaces/MongoMemoryServer.CreateUser.html +++ b/typedoc/interfaces/MongoMemoryServer.CreateUser.html @@ -1,7 +1,7 @@ CreateUser | mongodb-memory-server-core

    Interface CreateUser

    Interface options for "db.createUser" (used for this package) This interface is WITH the custom options from this package (Some text copied from https://docs.mongodb.com/manual/reference/method/db.createUser/#definition)

    -
    interface CreateUser {
        authenticationRestrictions?: {
            clientSource?: string;
            serverAddress?: string;
        }[];
        createUser: string;
        customData?: {
            [key: string]: any;
        };
        database?: string;
        digestPassword?: boolean;
        mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[];
        pwd: string;
        roles: string | string[] | RoleSpecification | RoleSpecification[];
    }

    Hierarchy (view full)

    Properties

    authenticationRestrictions? +
    interface CreateUser {
        authenticationRestrictions?: {
            clientSource?: string;
            serverAddress?: string;
        }[];
        createUser: string;
        customData?: {
            [key: string]: any;
        };
        database?: string;
        digestPassword?: boolean;
        mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[];
        pwd: string;
        roles: string | string[] | RoleSpecification | RoleSpecification[];
    }

    Hierarchy (view full)

    Properties

    authenticationRestrictions? createUser customData? database? @@ -11,18 +11,18 @@ roles

    Properties

    Optional authenticationRestrictions

    authenticationRestrictions?: {
        clientSource?: string;
        serverAddress?: string;
    }[]

    The authentication restrictions the server enforces on the created user. Specifies a list of IP addresses and CIDR ranges from which the user is allowed to connect to the server or from which the server can accept users.

    -

    Type declaration

    • Optional clientSource?: string
    • Optional serverAddress?: string

    createUser

    createUser: string

    Username

    -

    Optional customData

    customData?: {
        [key: string]: any;
    }

    Any arbitrary information. +

    Type declaration

    • Optional clientSource?: string
    • Optional serverAddress?: string

    createUser

    createUser: string

    Username

    +

    Optional customData

    customData?: {
        [key: string]: any;
    }

    Any arbitrary information. This field can be used to store any data an admin wishes to associate with this particular user.

    Type declaration

    • [key: string]: any

    Example

    this could be the user’s full name or employee id.
    -

    Optional database

    database?: string

    In which Database to create this user in

    +

    Optional database

    database?: string

    In which Database to create this user in

    Default

    'admin' by default the "admin" database is used
    -

    Optional digestPassword

    digestPassword?: boolean

    Indicates whether the server or the client digests the password. +

    Optional digestPassword

    digestPassword?: boolean

    Indicates whether the server or the client digests the password. "true" - The Server digests the Password "false" - The Client digests the Password

    -

    Optional mechanisms

    mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[]

    Specify the specific SCRAM mechanism or mechanisms for creating SCRAM user credentials.

    -

    pwd

    pwd: string

    Password

    -

    roles

    roles: string | string[] | RoleSpecification | RoleSpecification[]

    The Roles for the user, can be an empty array

    -

    Settings

    Member Visibility

    Theme

    On This Page

    authenticationRestrictionscreateUsercustomDatadatabasedigestPasswordmechanismspwdroles
    \ No newline at end of file +

    Optional mechanisms

    mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[]

    Specify the specific SCRAM mechanism or mechanisms for creating SCRAM user credentials.

    +

    pwd

    pwd: string

    Password

    +

    roles

    roles: string | string[] | RoleSpecification | RoleSpecification[]

    The Roles for the user, can be an empty array

    +

    Settings

    Member Visibility

    Theme

    On This Page

    authenticationRestrictionscreateUsercustomDatadatabasedigestPasswordmechanismspwdroles
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.CreateUserMongoDB.html b/typedoc/interfaces/MongoMemoryServer.CreateUserMongoDB.html index d3f93039..dfa44b21 100644 --- a/typedoc/interfaces/MongoMemoryServer.CreateUserMongoDB.html +++ b/typedoc/interfaces/MongoMemoryServer.CreateUserMongoDB.html @@ -2,7 +2,7 @@ This interface is WITHOUT the custom options from this package (Some text copied from https://docs.mongodb.com/manual/reference/method/db.createUser/#definition) This interface only exists, because mongodb dosnt provide such an interface for "createUser" (or as just very basic types) as of 6.7.0

    -
    interface CreateUserMongoDB {
        authenticationRestrictions?: {
            clientSource?: string;
            serverAddress?: string;
        }[];
        createUser: string;
        customData?: {
            [key: string]: any;
        };
        digestPassword?: boolean;
        mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[];
        pwd: string;
        roles: string | string[] | RoleSpecification | RoleSpecification[];
    }

    Hierarchy (view full)

    Properties

    authenticationRestrictions? +
    interface CreateUserMongoDB {
        authenticationRestrictions?: {
            clientSource?: string;
            serverAddress?: string;
        }[];
        createUser: string;
        customData?: {
            [key: string]: any;
        };
        digestPassword?: boolean;
        mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[];
        pwd: string;
        roles: string | string[] | RoleSpecification | RoleSpecification[];
    }

    Hierarchy (view full)

    Properties

    authenticationRestrictions? createUser customData? digestPassword? @@ -11,15 +11,15 @@ roles

    Properties

    Optional authenticationRestrictions

    authenticationRestrictions?: {
        clientSource?: string;
        serverAddress?: string;
    }[]

    The authentication restrictions the server enforces on the created user. Specifies a list of IP addresses and CIDR ranges from which the user is allowed to connect to the server or from which the server can accept users.

    -

    Type declaration

    • Optional clientSource?: string
    • Optional serverAddress?: string

    createUser

    createUser: string

    Username

    -

    Optional customData

    customData?: {
        [key: string]: any;
    }

    Any arbitrary information. +

    Type declaration

    • Optional clientSource?: string
    • Optional serverAddress?: string

    createUser

    createUser: string

    Username

    +

    Optional customData

    customData?: {
        [key: string]: any;
    }

    Any arbitrary information. This field can be used to store any data an admin wishes to associate with this particular user.

    Type declaration

    • [key: string]: any

    Example

    this could be the user’s full name or employee id.
    -

    Optional digestPassword

    digestPassword?: boolean

    Indicates whether the server or the client digests the password. +

    Optional digestPassword

    digestPassword?: boolean

    Indicates whether the server or the client digests the password. "true" - The Server digests the Password "false" - The Client digests the Password

    -

    Optional mechanisms

    mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[]

    Specify the specific SCRAM mechanism or mechanisms for creating SCRAM user credentials.

    -

    pwd

    pwd: string

    Password

    -

    roles

    roles: string | string[] | RoleSpecification | RoleSpecification[]

    The Roles for the user, can be an empty array

    -

    Settings

    Member Visibility

    Theme

    On This Page

    authenticationRestrictionscreateUsercustomDatadigestPasswordmechanismspwdroles
    \ No newline at end of file +

    Optional mechanisms

    mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[]

    Specify the specific SCRAM mechanism or mechanisms for creating SCRAM user credentials.

    +

    pwd

    pwd: string

    Password

    +

    roles

    roles: string | string[] | RoleSpecification | RoleSpecification[]

    The Roles for the user, can be an empty array

    +

    Settings

    Member Visibility

    Theme

    On This Page

    authenticationRestrictionscreateUsercustomDatadigestPasswordmechanismspwdroles
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.DisposeOptions.html b/typedoc/interfaces/MongoMemoryServer.DisposeOptions.html index d33de74e..c2d5924e 100644 --- a/typedoc/interfaces/MongoMemoryServer.DisposeOptions.html +++ b/typedoc/interfaces/MongoMemoryServer.DisposeOptions.html @@ -1,11 +1,11 @@ DisposeOptions | mongodb-memory-server-core

    Interface DisposeOptions

    Options to configure Symbol.asyncDispose behavior

    -
    interface DisposeOptions {
        cleanup?: Cleanup;
        enabled?: boolean;
    }

    Properties

    cleanup? +
    interface DisposeOptions {
        cleanup?: Cleanup;
        enabled?: boolean;
    }

    Properties

    cleanup? enabled?

    Properties

    Optional cleanup

    cleanup?: Cleanup

    Pass custom options for cleanup

    Default

    { doCleanup: true, force: false }
    -

    Optional enabled

    enabled?: boolean

    Set whether to run the dispose hook or not. +

    Optional enabled

    enabled?: boolean

    Set whether to run the dispose hook or not. Note that this only applies when Symbol.asyncDispose is actually called

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    cleanupenabled
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    cleanupenabled
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.ExtraInstanceOpts.html b/typedoc/interfaces/MongoMemoryServer.ExtraInstanceOpts.html index 26e157af..6e73faaa 100644 --- a/typedoc/interfaces/MongoMemoryServer.ExtraInstanceOpts.html +++ b/typedoc/interfaces/MongoMemoryServer.ExtraInstanceOpts.html @@ -1,5 +1,5 @@ ExtraInstanceOpts | mongodb-memory-server-core

    Interface ExtraInstanceOpts

    Extra Instance options specifically for MongoMemoryServer

    -
    interface ExtraInstanceOpts {
        portGeneration?: boolean;
    }

    Properties

    portGeneration? +
    interface ExtraInstanceOpts {
        portGeneration?: boolean;
    }

    Properties

    portGeneration?

    Properties

    Optional portGeneration

    portGeneration?: boolean

    Change if port generation is enabled or not.

    If enabled and a port is set, that port is tried, if locked a new one will be generated. If disabled and a port is set, only that port is tried, if locked a error will be thrown. @@ -7,4 +7,4 @@

    This setting will get overwritten by start's forceSamePort parameter if set

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    portGeneration
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    portGeneration
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.MongoInstanceData.html b/typedoc/interfaces/MongoMemoryServer.MongoInstanceData.html index 737507c9..1af47ad0 100644 --- a/typedoc/interfaces/MongoMemoryServer.MongoInstanceData.html +++ b/typedoc/interfaces/MongoMemoryServer.MongoInstanceData.html @@ -1,5 +1,5 @@ MongoInstanceData | mongodb-memory-server-core

    Interface MongoInstanceData

    Information about the currently running instance

    -
    interface MongoInstanceData {
        dbName: string;
        dbPath: string;
        instance: MongoInstance;
        ip: string;
        keyfileLocation?: string;
        launchTimeout?: number;
        port: number;
        replSet?: string;
        storageEngine: NonNullable<undefined | StorageEngine>;
        tmpDir?: string;
    }

    Hierarchy (view full)

    Properties

    dbName +
    interface MongoInstanceData {
        dbName: string;
        dbPath: string;
        instance: MongoInstance;
        ip: string;
        keyfileLocation?: string;
        launchTimeout?: number;
        port: number;
        replSet?: string;
        storageEngine: NonNullable<undefined | StorageEngine>;
        tmpDir?: string;
    }

    Hierarchy (view full)

    Properties

    dbName dbPath instance ip @@ -9,4 +9,4 @@ replSet? storageEngine tmpDir? -

    Properties

    dbName

    dbName: string

    dbPath

    dbPath: string

    instance

    instance: MongoInstance

    ip

    ip: string

    Optional keyfileLocation

    keyfileLocation?: string

    Optional launchTimeout

    launchTimeout?: number

    port

    port: number

    Optional replSet

    replSet?: string

    storageEngine

    storageEngine: NonNullable<undefined | StorageEngine>

    Optional tmpDir

    tmpDir?: string

    Settings

    Member Visibility

    Theme

    On This Page

    dbNamedbPathinstanceipkeyfileLocationlaunchTimeoutportreplSetstorageEnginetmpDir
    \ No newline at end of file +

    Properties

    dbName

    dbName: string

    dbPath

    dbPath: string

    instance

    instance: MongoInstance

    ip

    ip: string

    Optional keyfileLocation

    keyfileLocation?: string

    Optional launchTimeout

    launchTimeout?: number

    port

    port: number

    Optional replSet

    replSet?: string

    storageEngine

    storageEngine: NonNullable<undefined | StorageEngine>

    Optional tmpDir

    tmpDir?: string

    Settings

    Member Visibility

    Theme

    On This Page

    dbNamedbPathinstanceipkeyfileLocationlaunchTimeoutportreplSetstorageEnginetmpDir
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.MongoMemoryServerGetStartOptions.html b/typedoc/interfaces/MongoMemoryServer.MongoMemoryServerGetStartOptions.html index 218978c6..3004a369 100644 --- a/typedoc/interfaces/MongoMemoryServer.MongoMemoryServerGetStartOptions.html +++ b/typedoc/interfaces/MongoMemoryServer.MongoMemoryServerGetStartOptions.html @@ -1,5 +1,5 @@ -MongoMemoryServerGetStartOptions | mongodb-memory-server-core

    Interface MongoMemoryServerGetStartOptions

    interface MongoMemoryServerGetStartOptions {
        createAuth: boolean;
        data: StartupInstanceData;
        mongodOptions: Partial<MongodOpts>;
    }

    Properties

    createAuth +MongoMemoryServerGetStartOptions | mongodb-memory-server-core

    Interface MongoMemoryServerGetStartOptions

    interface MongoMemoryServerGetStartOptions {
        createAuth: boolean;
        data: StartupInstanceData;
        mongodOptions: Partial<MongodOpts>;
    }

    Properties

    createAuth data mongodOptions

    Properties

    createAuth

    createAuth: boolean

    Defines wheter should MongoMemoryServer.createAuth be run

    -

    data

    data: StartupInstanceData

    mongodOptions

    mongodOptions: Partial<MongodOpts>

    Settings

    Member Visibility

    Theme

    On This Page

    createAuthdatamongodOptions
    \ No newline at end of file +

    data

    data: StartupInstanceData

    mongodOptions

    mongodOptions: Partial<MongodOpts>

    Settings

    Member Visibility

    Theme

    On This Page

    createAuthdatamongodOptions
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.MongoMemoryServerOpts.html b/typedoc/interfaces/MongoMemoryServer.MongoMemoryServerOpts.html index 6d032fe2..7e5df601 100644 --- a/typedoc/interfaces/MongoMemoryServer.MongoMemoryServerOpts.html +++ b/typedoc/interfaces/MongoMemoryServer.MongoMemoryServerOpts.html @@ -1,9 +1,9 @@ MongoMemoryServerOpts | mongodb-memory-server-core

    Interface MongoMemoryServerOpts

    MongoMemoryServer Stored Options

    -
    interface MongoMemoryServerOpts {
        auth?: AutomaticAuth;
        binary?: MongoBinaryOpts;
        dispose?: DisposeOptions;
        instance?: MemoryServerInstanceOpts;
        spawn?: SpawnOptions;
    }

    Properties

    auth? +
    interface MongoMemoryServerOpts {
        auth?: AutomaticAuth;
        binary?: MongoBinaryOpts;
        dispose?: DisposeOptions;
        instance?: MemoryServerInstanceOpts;
        spawn?: SpawnOptions;
    }

    Properties

    auth? binary? dispose? instance? spawn?

    Properties

    Optional auth

    auth?: AutomaticAuth

    Defining this enables automatic user creation

    -

    Optional binary

    binary?: MongoBinaryOpts

    Optional dispose

    dispose?: DisposeOptions

    Options for automatic dispose for "Explicit Resource Management"

    -

    Optional instance

    instance?: MemoryServerInstanceOpts

    Optional spawn

    spawn?: SpawnOptions

    Settings

    Member Visibility

    Theme

    On This Page

    authbinarydisposeinstancespawn
    \ No newline at end of file +

    Optional binary

    binary?: MongoBinaryOpts

    Optional dispose

    dispose?: DisposeOptions

    Options for automatic dispose for "Explicit Resource Management"

    +

    Optional instance

    instance?: MemoryServerInstanceOpts

    Optional spawn

    spawn?: SpawnOptions

    Settings

    Member Visibility

    Theme

    On This Page

    authbinarydisposeinstancespawn
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.RoleSpecification.html b/typedoc/interfaces/MongoMemoryServer.RoleSpecification.html index 1a68267c..8c0a5cf0 100644 --- a/typedoc/interfaces/MongoMemoryServer.RoleSpecification.html +++ b/typedoc/interfaces/MongoMemoryServer.RoleSpecification.html @@ -1,6 +1,6 @@ -RoleSpecification | mongodb-memory-server-core

    Interface RoleSpecification

    interface RoleSpecification {
        db: string;
        role: string;
    }

    Properties

    db +RoleSpecification | mongodb-memory-server-core

    Interface RoleSpecification

    interface RoleSpecification {
        db: string;
        role: string;
    }

    Properties

    db role

    Properties

    db

    db: string

    The database this user's role should effect.

    -

    role

    role: string

    A role grants privileges to perform sets of actions on defined resources. +

    role

    role: string

    A role grants privileges to perform sets of actions on defined resources. A given role applies to the database on which it is defined and can grant access down to a collection level of granularity.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    dbrole
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    dbrole
    \ No newline at end of file diff --git a/typedoc/interfaces/MongoMemoryServer.StartupInstanceData.html b/typedoc/interfaces/MongoMemoryServer.StartupInstanceData.html index 21e9417b..a3e3ff80 100644 --- a/typedoc/interfaces/MongoMemoryServer.StartupInstanceData.html +++ b/typedoc/interfaces/MongoMemoryServer.StartupInstanceData.html @@ -1,5 +1,5 @@ StartupInstanceData | mongodb-memory-server-core

    Interface StartupInstanceData

    Data used by _startUpInstance's "data" variable

    -
    interface StartupInstanceData {
        dbName: string;
        dbPath?: string;
        ip: string;
        keyfileLocation?: string;
        launchTimeout?: number;
        port: number;
        replSet?: string;
        storageEngine: NonNullable<undefined | StorageEngine>;
        tmpDir?: string;
    }

    Hierarchy (view full)

    Properties

    dbName +
    interface StartupInstanceData {
        dbName: string;
        dbPath?: string;
        ip: string;
        keyfileLocation?: string;
        launchTimeout?: number;
        port: number;
        replSet?: string;
        storageEngine: NonNullable<undefined | StorageEngine>;
        tmpDir?: string;
    }

    Hierarchy (view full)

    Properties

    dbName dbPath? ip keyfileLocation? @@ -8,4 +8,4 @@ replSet? storageEngine tmpDir? -

    Properties

    dbName

    dbName: string

    Optional dbPath

    dbPath?: string

    ip

    ip: string

    Optional keyfileLocation

    keyfileLocation?: string

    Optional launchTimeout

    launchTimeout?: number

    port

    port: number

    Optional replSet

    replSet?: string

    storageEngine

    storageEngine: NonNullable<undefined | StorageEngine>

    Optional tmpDir

    tmpDir?: string

    Settings

    Member Visibility

    Theme

    On This Page

    dbNamedbPathipkeyfileLocationlaunchTimeoutportreplSetstorageEnginetmpDir
    \ No newline at end of file +

    Properties

    dbName

    dbName: string

    Optional dbPath

    dbPath?: string

    ip

    ip: string

    Optional keyfileLocation

    keyfileLocation?: string

    Optional launchTimeout

    launchTimeout?: number

    port

    port: number

    Optional replSet

    replSet?: string

    storageEngine

    storageEngine: NonNullable<undefined | StorageEngine>

    Optional tmpDir

    tmpDir?: string

    Settings

    Member Visibility

    Theme

    On This Page

    dbNamedbPathipkeyfileLocationlaunchTimeoutportreplSetstorageEnginetmpDir
    \ No newline at end of file diff --git a/typedoc/interfaces/util_DryMongoBinary.BaseDryMongoBinaryOptions.html b/typedoc/interfaces/util_DryMongoBinary.BaseDryMongoBinaryOptions.html index e13e9db1..b69c70c9 100644 --- a/typedoc/interfaces/util_DryMongoBinary.BaseDryMongoBinaryOptions.html +++ b/typedoc/interfaces/util_DryMongoBinary.BaseDryMongoBinaryOptions.html @@ -1,8 +1,8 @@ BaseDryMongoBinaryOptions | mongodb-memory-server-core

    Interface BaseDryMongoBinaryOptions

    Interface for general options required to pass-around (all optional)

    -
    interface BaseDryMongoBinaryOptions {
        arch?: string;
        downloadDir?: string;
        os?: AnyOS;
        platform?: string;
        systemBinary?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    arch? +
    interface BaseDryMongoBinaryOptions {
        arch?: string;
        downloadDir?: string;
        os?: AnyOS;
        platform?: string;
        systemBinary?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    arch? downloadDir? os? platform? systemBinary? version? -

    Properties

    Optional arch

    arch?: string

    Optional downloadDir

    downloadDir?: string

    Optional os

    os?: AnyOS

    Optional platform

    platform?: string

    Optional systemBinary

    systemBinary?: string

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    archdownloadDirosplatformsystemBinaryversion
    \ No newline at end of file +

    Properties

    Optional arch

    arch?: string

    Optional downloadDir

    downloadDir?: string

    Optional os

    os?: AnyOS

    Optional platform

    platform?: string

    Optional systemBinary

    systemBinary?: string

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    archdownloadDirosplatformsystemBinaryversion
    \ No newline at end of file diff --git a/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryArchiveRegexGroups.html b/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryArchiveRegexGroups.html index 71d5b614..2f03b258 100644 --- a/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryArchiveRegexGroups.html +++ b/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryArchiveRegexGroups.html @@ -1,6 +1,6 @@ DryMongoBinaryArchiveRegexGroups | mongodb-memory-server-core

    Interface DryMongoBinaryArchiveRegexGroups

    Interface for "DryMongoBinary.parseArchiveNameRegex"'s regex groups

    -
    interface DryMongoBinaryArchiveRegexGroups {
        arch?: string;
        dist?: string;
        platform?: string;
        version?: string;
    }

    Properties

    arch? +
    interface DryMongoBinaryArchiveRegexGroups {
        arch?: string;
        dist?: string;
        platform?: string;
        version?: string;
    }

    Properties

    arch? dist? platform? version? -

    Properties

    Optional arch

    arch?: string

    Optional dist

    dist?: string

    Optional platform

    platform?: string

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    archdistplatformversion
    \ No newline at end of file +

    Properties

    Optional arch

    arch?: string

    Optional dist

    dist?: string

    Optional platform

    platform?: string

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    archdistplatformversion
    \ No newline at end of file diff --git a/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryNameOptions.html b/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryNameOptions.html index 1bc2cee8..5bbc8487 100644 --- a/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryNameOptions.html +++ b/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryNameOptions.html @@ -1,6 +1,6 @@ DryMongoBinaryNameOptions | mongodb-memory-server-core

    Interface DryMongoBinaryNameOptions

    Interface for the options arguments in function "DryMongoBinary.getBinaryName"

    -
    interface DryMongoBinaryNameOptions {
        arch: string;
        os: NonNullable<undefined | AnyOS>;
        platform: string;
        version: string;
    }

    Properties

    arch +
    interface DryMongoBinaryNameOptions {
        arch: string;
        os: NonNullable<undefined | AnyOS>;
        platform: string;
        version: string;
    }

    Properties

    arch os platform version -

    Properties

    arch

    arch: string

    os

    os: NonNullable<undefined | AnyOS>

    platform

    platform: string

    version

    version: string

    Settings

    Member Visibility

    Theme

    On This Page

    archosplatformversion
    \ No newline at end of file +

    Properties

    arch

    arch: string

    os

    os: NonNullable<undefined | AnyOS>

    platform

    platform: string

    version

    version: string

    Settings

    Member Visibility

    Theme

    On This Page

    archosplatformversion
    \ No newline at end of file diff --git a/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryOptions.html b/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryOptions.html index bc0369ed..b6699569 100644 --- a/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryOptions.html +++ b/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryOptions.html @@ -1,8 +1,8 @@ DryMongoBinaryOptions | mongodb-memory-server-core

    Interface DryMongoBinaryOptions

    Interface for general options required to pass-aroung (version not optional)

    -
    interface DryMongoBinaryOptions {
        arch?: string;
        downloadDir?: string;
        os?: AnyOS;
        platform?: string;
        systemBinary?: string;
        version: string;
    }

    Hierarchy (view full)

    Properties

    arch? +
    interface DryMongoBinaryOptions {
        arch?: string;
        downloadDir?: string;
        os?: AnyOS;
        platform?: string;
        systemBinary?: string;
        version: string;
    }

    Hierarchy (view full)

    Properties

    arch? downloadDir? os? platform? systemBinary? version -

    Properties

    Optional arch

    arch?: string

    Optional downloadDir

    downloadDir?: string

    Optional os

    os?: AnyOS

    Optional platform

    platform?: string

    Optional systemBinary

    systemBinary?: string

    version

    version: string

    Settings

    Member Visibility

    Theme

    On This Page

    archdownloadDirosplatformsystemBinaryversion
    \ No newline at end of file +

    Properties

    Optional arch

    arch?: string

    Optional downloadDir

    downloadDir?: string

    Optional os

    os?: AnyOS

    Optional platform

    platform?: string

    Optional systemBinary

    systemBinary?: string

    version

    version: string

    Settings

    Member Visibility

    Theme

    On This Page

    archdownloadDirosplatformsystemBinaryversion
    \ No newline at end of file diff --git a/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryPaths.html b/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryPaths.html index 4bc0f1b3..391725d2 100644 --- a/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryPaths.html +++ b/typedoc/interfaces/util_DryMongoBinary.DryMongoBinaryPaths.html @@ -1,10 +1,10 @@ DryMongoBinaryPaths | mongodb-memory-server-core

    Interface DryMongoBinaryPaths

    Interface to store all generated Paths that would be possible a binary would be in

    -
    interface DryMongoBinaryPaths {
        homeCache: string;
        modulesCache: string;
        relative: string;
        resolveConfig: string;
    }

    Properties

    homeCache +
    interface DryMongoBinaryPaths {
        homeCache: string;
        modulesCache: string;
        relative: string;
        resolveConfig: string;
    }

    Properties

    homeCache modulesCache relative resolveConfig

    Properties

    homeCache

    homeCache: string

    Path for "~/.config/" (user home)

    -

    modulesCache

    modulesCache: string

    Path for "PROJECT/node_modules/.cache/" (project local cache)

    -

    relative

    relative: string

    Path for relative to CWD "CWD/" (relative CWD path)

    -

    resolveConfig

    resolveConfig: string

    Path from DOWNLOAD_DIR config option

    -

    Settings

    Member Visibility

    Theme

    On This Page

    homeCachemodulesCacherelativeresolveConfig
    \ No newline at end of file +

    modulesCache

    modulesCache: string

    Path for "PROJECT/node_modules/.cache/" (project local cache)

    +

    relative

    relative: string

    Path for relative to CWD "CWD/" (relative CWD path)

    +

    resolveConfig

    resolveConfig: string

    Path from DOWNLOAD_DIR config option

    +

    Settings

    Member Visibility

    Theme

    On This Page

    homeCachemodulesCacherelativeresolveConfig
    \ No newline at end of file diff --git a/typedoc/interfaces/util_MongoBinary.MongoBinaryOpts.html b/typedoc/interfaces/util_MongoBinary.MongoBinaryOpts.html index 1d196790..14f2bb56 100644 --- a/typedoc/interfaces/util_MongoBinary.MongoBinaryOpts.html +++ b/typedoc/interfaces/util_MongoBinary.MongoBinaryOpts.html @@ -1,9 +1,9 @@ MongoBinaryOpts | mongodb-memory-server-core

    Interface MongoBinaryOpts

    Interface for general options required to pass-around (all optional)

    -
    interface MongoBinaryOpts {
        arch?: string;
        checkMD5?: boolean;
        downloadDir?: string;
        os?: AnyOS;
        platform?: string;
        systemBinary?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    arch? +
    interface MongoBinaryOpts {
        arch?: string;
        checkMD5?: boolean;
        downloadDir?: string;
        os?: AnyOS;
        platform?: string;
        systemBinary?: string;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    arch? checkMD5? downloadDir? os? platform? systemBinary? version? -

    Properties

    Optional arch

    arch?: string

    Optional checkMD5

    checkMD5?: boolean

    Optional downloadDir

    downloadDir?: string

    Optional os

    os?: AnyOS

    Optional platform

    platform?: string

    Optional systemBinary

    systemBinary?: string

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    archcheckMD5downloadDirosplatformsystemBinaryversion
    \ No newline at end of file +

    Properties

    Optional arch

    arch?: string

    Optional checkMD5

    checkMD5?: boolean

    Optional downloadDir

    downloadDir?: string

    Optional os

    os?: AnyOS

    Optional platform

    platform?: string

    Optional systemBinary

    systemBinary?: string

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    archcheckMD5downloadDirosplatformsystemBinaryversion
    \ No newline at end of file diff --git a/typedoc/interfaces/util_MongoBinaryDownload.MongoBinaryDownloadProgress.html b/typedoc/interfaces/util_MongoBinaryDownload.MongoBinaryDownloadProgress.html index 411563ac..f9be4cc4 100644 --- a/typedoc/interfaces/util_MongoBinaryDownload.MongoBinaryDownloadProgress.html +++ b/typedoc/interfaces/util_MongoBinaryDownload.MongoBinaryDownloadProgress.html @@ -1,5 +1,5 @@ -MongoBinaryDownloadProgress | mongodb-memory-server-core

    Interface MongoBinaryDownloadProgress

    interface MongoBinaryDownloadProgress {
        current: number;
        lastPrintedAt: number;
        length: number;
        totalMb: number;
    }

    Properties

    current +MongoBinaryDownloadProgress | mongodb-memory-server-core

    Interface MongoBinaryDownloadProgress

    interface MongoBinaryDownloadProgress {
        current: number;
        lastPrintedAt: number;
        length: number;
        totalMb: number;
    }

    Properties

    current lastPrintedAt length totalMb -

    Properties

    current

    current: number

    lastPrintedAt

    lastPrintedAt: number

    length

    length: number

    totalMb

    totalMb: number

    Settings

    Member Visibility

    Theme

    On This Page

    currentlastPrintedAtlengthtotalMb
    \ No newline at end of file +

    Properties

    current

    current: number

    lastPrintedAt

    lastPrintedAt: number

    length

    length: number

    totalMb

    totalMb: number

    Settings

    Member Visibility

    Theme

    On This Page

    currentlastPrintedAtlengthtotalMb
    \ No newline at end of file diff --git a/typedoc/interfaces/util_MongoBinaryDownloadUrl.MongoBinaryDownloadUrlOpts.html b/typedoc/interfaces/util_MongoBinaryDownloadUrl.MongoBinaryDownloadUrlOpts.html index 28e95ce6..89ab8d10 100644 --- a/typedoc/interfaces/util_MongoBinaryDownloadUrl.MongoBinaryDownloadUrlOpts.html +++ b/typedoc/interfaces/util_MongoBinaryDownloadUrl.MongoBinaryDownloadUrlOpts.html @@ -1,5 +1,5 @@ -MongoBinaryDownloadUrlOpts | mongodb-memory-server-core

    Interface MongoBinaryDownloadUrlOpts

    interface MongoBinaryDownloadUrlOpts {
        arch: string;
        os?: AnyOS;
        platform: string;
        version: string;
    }

    Implemented by

    Properties

    arch +MongoBinaryDownloadUrlOpts | mongodb-memory-server-core

    Interface MongoBinaryDownloadUrlOpts

    interface MongoBinaryDownloadUrlOpts {
        arch: string;
        os?: AnyOS;
        platform: string;
        version: string;
    }

    Implemented by

    Properties

    arch os? platform version -

    Properties

    arch

    arch: string

    Optional os

    os?: AnyOS

    platform

    platform: string

    version

    version: string

    Settings

    Member Visibility

    Theme

    On This Page

    archosplatformversion
    \ No newline at end of file +

    Properties

    arch

    arch: string

    Optional os

    os?: AnyOS

    platform

    platform: string

    version

    version: string

    Settings

    Member Visibility

    Theme

    On This Page

    archosplatformversion
    \ No newline at end of file diff --git a/typedoc/interfaces/util_MongoInstance.MongoMemoryInstanceOpts.html b/typedoc/interfaces/util_MongoInstance.MongoMemoryInstanceOpts.html index 581acb4a..2c0b95a1 100644 --- a/typedoc/interfaces/util_MongoInstance.MongoMemoryInstanceOpts.html +++ b/typedoc/interfaces/util_MongoInstance.MongoMemoryInstanceOpts.html @@ -1,4 +1,4 @@ -MongoMemoryInstanceOpts | mongodb-memory-server-core

    Interface MongoMemoryInstanceOpts

    interface MongoMemoryInstanceOpts {
        args?: string[];
        auth?: boolean;
        dbName?: string;
        dbPath?: string;
        ip?: string;
        keyfileLocation?: string;
        launchTimeout?: number;
        port?: number;
        replSet?: string;
        replicaMemberConfig?: ReplicaMemberConfig;
        storageEngine?: StorageEngine;
    }

    Hierarchy (view full)

    Properties

    args? +MongoMemoryInstanceOpts | mongodb-memory-server-core

    Interface MongoMemoryInstanceOpts

    interface MongoMemoryInstanceOpts {
        args?: string[];
        auth?: boolean;
        dbName?: string;
        dbPath?: string;
        ip?: string;
        keyfileLocation?: string;
        launchTimeout?: number;
        port?: number;
        replSet?: string;
        replicaMemberConfig?: ReplicaMemberConfig;
        storageEngine?: StorageEngine;
    }

    Hierarchy (view full)

    Properties

    args? auth? dbName? dbPath? @@ -10,43 +10,43 @@ replicaMemberConfig? storageEngine?

    Properties

    Optional args

    args?: string[]

    Extra Arguments to add

    -

    Optional auth

    auth?: boolean

    Set which parameter will be used +

    Optional auth

    auth?: boolean

    Set which parameter will be used true -> "--auth" false -> "--noauth"

    Default

    false
    -

    Optional dbName

    dbName?: string

    Currently unused option

    +

    Optional dbName

    dbName?: string

    Currently unused option

    Default

    undefined
    -

    Optional dbPath

    dbPath?: string

    Set which storage path to use +

    Optional dbPath

    dbPath?: string

    Set which storage path to use Adds "--dbpath"

    Default

    TmpDir
    -

    Optional ip

    ip?: string

    for binding to all IP addresses set it to ::,0.0.0.0, by default '127.0.0.1' +

    Optional ip

    ip?: string

    for binding to all IP addresses set it to ::,0.0.0.0, by default '127.0.0.1' Adds "--bind_ip"

    Default

    undefined
    -

    Optional keyfileLocation

    keyfileLocation?: string

    Location for the "--keyfile" argument +

    Optional keyfileLocation

    keyfileLocation?: string

    Location for the "--keyfile" argument Only has an effect when "auth" is enabled and is a replset Adds "--keyfile"

    Default

    undefined
    -

    Optional launchTimeout

    launchTimeout?: number

    Define a custom timeout for when out of some reason the binary cannot get started correctly +

    Optional launchTimeout

    launchTimeout?: number

    Define a custom timeout for when out of some reason the binary cannot get started correctly Time in MS

    Default

    10000 10 seconds
    -

    Optional port

    port?: number

    Set which port to use +

    Optional port

    port?: number

    Set which port to use Adds "--port"

    Default

    from get-port
    -

    Optional replSet

    replSet?: string

    Set that this instance is part of a replset +

    Optional replSet

    replSet?: string

    Set that this instance is part of a replset Adds "--replSet"

    Default

    undefined
    -

    Optional replicaMemberConfig

    replicaMemberConfig?: ReplicaMemberConfig

    Set the Replica-Member-Config +

    Optional replicaMemberConfig

    replicaMemberConfig?: ReplicaMemberConfig

    Set the Replica-Member-Config Only has a effect when started with "MongoMemoryReplSet"

    -

    Optional storageEngine

    storageEngine?: StorageEngine

    Set which Storage Engine to use +

    Optional storageEngine

    storageEngine?: StorageEngine

    Set which Storage Engine to use Adds "--storageEngine"

    Default

    "ephemeralForTest"
    -

    Settings

    Member Visibility

    Theme

    On This Page

    argsauthdbNamedbPathipkeyfileLocationlaunchTimeoutportreplSetreplicaMemberConfigstorageEngine
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    argsauthdbNamedbPathipkeyfileLocationlaunchTimeoutportreplSetreplicaMemberConfigstorageEngine
    \ No newline at end of file diff --git a/typedoc/interfaces/util_MongoInstance.MongoMemoryInstanceOptsBase.html b/typedoc/interfaces/util_MongoInstance.MongoMemoryInstanceOptsBase.html index 72e35631..edca4c41 100644 --- a/typedoc/interfaces/util_MongoInstance.MongoMemoryInstanceOptsBase.html +++ b/typedoc/interfaces/util_MongoInstance.MongoMemoryInstanceOptsBase.html @@ -1,26 +1,26 @@ -MongoMemoryInstanceOptsBase | mongodb-memory-server-core

    Interface MongoMemoryInstanceOptsBase

    interface MongoMemoryInstanceOptsBase {
        args?: string[];
        dbPath?: string;
        launchTimeout?: number;
        port?: number;
        replicaMemberConfig?: ReplicaMemberConfig;
        storageEngine?: StorageEngine;
    }

    Hierarchy (view full)

    Properties

    args? +MongoMemoryInstanceOptsBase | mongodb-memory-server-core

    Interface MongoMemoryInstanceOptsBase

    interface MongoMemoryInstanceOptsBase {
        args?: string[];
        dbPath?: string;
        launchTimeout?: number;
        port?: number;
        replicaMemberConfig?: ReplicaMemberConfig;
        storageEngine?: StorageEngine;
    }

    Hierarchy (view full)

    Properties

    args? dbPath? launchTimeout? port? replicaMemberConfig? storageEngine?

    Properties

    Optional args

    args?: string[]

    Extra Arguments to add

    -

    Optional dbPath

    dbPath?: string

    Set which storage path to use +

    Optional dbPath

    dbPath?: string

    Set which storage path to use Adds "--dbpath"

    Default

    TmpDir
    -

    Optional launchTimeout

    launchTimeout?: number

    Define a custom timeout for when out of some reason the binary cannot get started correctly +

    Optional launchTimeout

    launchTimeout?: number

    Define a custom timeout for when out of some reason the binary cannot get started correctly Time in MS

    Default

    10000 10 seconds
    -

    Optional port

    port?: number

    Set which port to use +

    Optional port

    port?: number

    Set which port to use Adds "--port"

    Default

    from get-port
    -

    Optional replicaMemberConfig

    replicaMemberConfig?: ReplicaMemberConfig

    Set the Replica-Member-Config +

    Optional replicaMemberConfig

    replicaMemberConfig?: ReplicaMemberConfig

    Set the Replica-Member-Config Only has a effect when started with "MongoMemoryReplSet"

    -

    Optional storageEngine

    storageEngine?: StorageEngine

    Set which Storage Engine to use +

    Optional storageEngine

    storageEngine?: StorageEngine

    Set which Storage Engine to use Adds "--storageEngine"

    Default

    "ephemeralForTest"
    -

    Settings

    Member Visibility

    Theme

    On This Page

    argsdbPathlaunchTimeoutportreplicaMemberConfigstorageEngine
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    argsdbPathlaunchTimeoutportreplicaMemberConfigstorageEngine
    \ No newline at end of file diff --git a/typedoc/interfaces/util_MongoInstance.MongodOpts.html b/typedoc/interfaces/util_MongoInstance.MongodOpts.html index 74c2c724..6e1b36ac 100644 --- a/typedoc/interfaces/util_MongoInstance.MongodOpts.html +++ b/typedoc/interfaces/util_MongoInstance.MongodOpts.html @@ -1,7 +1,7 @@ -MongodOpts | mongodb-memory-server-core

    Interface MongodOpts

    interface MongodOpts {
        binary: MongoBinaryOpts;
        instance: MongoMemoryInstanceOpts;
        spawn: SpawnOptions;
    }

    Properties

    binary +MongodOpts | mongodb-memory-server-core

    Interface MongodOpts

    interface MongodOpts {
        binary: MongoBinaryOpts;
        instance: MongoMemoryInstanceOpts;
        spawn: SpawnOptions;
    }

    Properties

    binary instance spawn

    Properties

    binary

    binary: MongoBinaryOpts

    mongo binary options

    -

    instance

    instance: MongoMemoryInstanceOpts

    instance options

    -

    spawn

    spawn: SpawnOptions

    child process spawn options

    -

    Settings

    Member Visibility

    Theme

    On This Page

    binaryinstancespawn
    \ No newline at end of file +

    instance

    instance: MongoMemoryInstanceOpts

    instance options

    +

    spawn

    spawn: SpawnOptions

    child process spawn options

    +

    Settings

    Member Visibility

    Theme

    On This Page

    binaryinstancespawn
    \ No newline at end of file diff --git a/typedoc/interfaces/util_MongoInstance.ReplicaMemberConfig.html b/typedoc/interfaces/util_MongoInstance.ReplicaMemberConfig.html index c25a7ec0..c16baa42 100644 --- a/typedoc/interfaces/util_MongoInstance.ReplicaMemberConfig.html +++ b/typedoc/interfaces/util_MongoInstance.ReplicaMemberConfig.html @@ -2,7 +2,7 @@

    See

    https://docs.mongodb.com/manual/reference/replica-configuration/#replica-set-configuration-document-example

    Example

    {
      priority: 2,
      buildIndexes: false,
      votes: 2,
    }
    -
    interface ReplicaMemberConfig {
        arbiterOnly?: boolean;
        buildIndexes?: boolean;
        hidden?: boolean;
        priority?: number;
        secondaryDelaySecs?: number;
        slaveDelay?: number;
        tags?: any;
        votes?: number;
    }

    Properties

    arbiterOnly? +
    interface ReplicaMemberConfig {
        arbiterOnly?: boolean;
        buildIndexes?: boolean;
        hidden?: boolean;
        priority?: number;
        secondaryDelaySecs?: number;
        slaveDelay?: number;
        tags?: any;
        votes?: number;
    }

    Properties

    arbiterOnly? buildIndexes? hidden? priority? @@ -12,32 +12,32 @@

    Example

    {
    <
 votes?

    Properties

    Optional arbiterOnly

    arbiterOnly?: boolean

    A boolean that identifies an arbiter.

    Default

    false - A value of true indicates that the member is an arbiter.

    -

    Optional buildIndexes

    buildIndexes?: boolean

    A boolean that indicates whether the mongod builds indexes on this member. +

    Optional buildIndexes

    buildIndexes?: boolean

    A boolean that indicates whether the mongod builds indexes on this member. You can only set this value when adding a member to a replica set.

    Default

    true
    -

    Optional hidden

    hidden?: boolean

    The replica set hides this instance and does not include the member in the output of db.hello() or hello.

    +

    Optional hidden

    hidden?: boolean

    The replica set hides this instance and does not include the member in the output of db.hello() or hello.

    Default

    true
    -

    Optional priority

    priority?: number

    A number that indicates the relative eligibility of a member to become a primary. +

    Optional priority

    priority?: number

    A number that indicates the relative eligibility of a member to become a primary. Specify higher values to make a member more eligible to become primary, and lower values to make the member less eligible.

    Default

    1 for primary/secondary; 0 for arbiters.
    -

    Optional secondaryDelaySecs

    secondaryDelaySecs?: number

    Mongodb 5.x only - The number of seconds "behind" the primary that this replica set member should "lag".

    +

    Optional secondaryDelaySecs

    secondaryDelaySecs?: number

    Mongodb 5.x only - The number of seconds "behind" the primary that this replica set member should "lag".

    Default

    0
    -

    Optional slaveDelay

    slaveDelay?: number

    Mongodb 4.x only - The number of seconds "behind" the primary that this replica set member should "lag". +

    Optional slaveDelay

    slaveDelay?: number

    Mongodb 4.x only - The number of seconds "behind" the primary that this replica set member should "lag". For mongodb 5.x, use secondaryDelaySecs instead.

    See

    https://docs.mongodb.com/v4.4/tutorial/configure-a-delayed-replica-set-member/

    Default

    0
    -

    Optional tags

    tags?: any

    A tags document contains user-defined tag field and value pairs for the replica set member.

    +

    Optional tags

    tags?: any

    A tags document contains user-defined tag field and value pairs for the replica set member.

    Default

    null

    Example

    { "<tag1>": "<string1>", "<tag2>": "<string2>",... }
    -

    Optional votes

    votes?: number

    The number of votes a server will cast in a replica set election. +

    Optional votes

    votes?: number

    The number of votes a server will cast in a replica set election. The number of votes each member has is either 1 or 0, and arbiters always have exactly 1 vote.

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    arbiterOnlybuildIndexeshiddenprioritysecondaryDelaySecsslaveDelaytagsvotes
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    arbiterOnlybuildIndexeshiddenprioritysecondaryDelaySecsslaveDelaytagsvotes
    \ No newline at end of file diff --git a/typedoc/interfaces/util_getos.LinuxOS.html b/typedoc/interfaces/util_getos.LinuxOS.html index 31a37013..703c132c 100644 --- a/typedoc/interfaces/util_getos.LinuxOS.html +++ b/typedoc/interfaces/util_getos.LinuxOS.html @@ -1,6 +1,6 @@ -LinuxOS | mongodb-memory-server-core

    Interface LinuxOS

    interface LinuxOS {
        codename?: string;
        dist: string;
        id_like?: string[];
        os: "linux";
        release: string;
    }

    Hierarchy (view full)

    Properties

    codename? +LinuxOS | mongodb-memory-server-core

    Interface LinuxOS

    interface LinuxOS {
        codename?: string;
        dist: string;
        id_like?: string[];
        os: "linux";
        release: string;
    }

    Hierarchy (view full)

    Properties

    codename? dist id_like? os release -

    Properties

    Optional codename

    codename?: string

    dist

    dist: string

    Optional id_like

    id_like?: string[]

    os

    os: "linux"

    release

    release: string

    Settings

    Member Visibility

    Theme

    On This Page

    codenamedistid_likeosrelease
    \ No newline at end of file +

    Properties

    Optional codename

    codename?: string

    dist

    dist: string

    Optional id_like

    id_like?: string[]

    os

    os: "linux"

    release

    release: string

    Settings

    Member Visibility

    Theme

    On This Page

    codenamedistid_likeosrelease
    \ No newline at end of file diff --git a/typedoc/interfaces/util_getos.OtherOS.html b/typedoc/interfaces/util_getos.OtherOS.html index db3b9844..56def4d5 100644 --- a/typedoc/interfaces/util_getos.OtherOS.html +++ b/typedoc/interfaces/util_getos.OtherOS.html @@ -1,2 +1,2 @@ -OtherOS | mongodb-memory-server-core

    Interface OtherOS

    interface OtherOS {
        os: string;
    }

    Hierarchy (view full)

    Properties

    os -

    Properties

    os

    os: string

    Settings

    Member Visibility

    Theme

    On This Page

    os
    \ No newline at end of file +OtherOS | mongodb-memory-server-core

    Interface OtherOS

    interface OtherOS {
        os: string;
    }

    Hierarchy (view full)

    Properties

    os +

    Properties

    os

    os: string

    Settings

    Member Visibility

    Theme

    On This Page

    os
    \ No newline at end of file diff --git a/typedoc/interfaces/util_utils.Cleanup.html b/typedoc/interfaces/util_utils.Cleanup.html index f7bd109a..baa9f765 100644 --- a/typedoc/interfaces/util_utils.Cleanup.html +++ b/typedoc/interfaces/util_utils.Cleanup.html @@ -1,10 +1,10 @@ Cleanup | mongodb-memory-server-core

    Interface Cleanup

    Cleanup interface to provide easy to understand arguments for clean-up

    -
    interface Cleanup {
        doCleanup?: boolean;
        force?: boolean;
    }

    Properties

    doCleanup? +
    interface Cleanup {
        doCleanup?: boolean;
        force?: boolean;
    }

    Properties

    doCleanup? force?

    Properties

    Optional doCleanup

    doCleanup?: boolean

    Setting this to true will activate cleanup

    Default

    true
    -

    Optional force

    force?: boolean

    Setting this to true will cleanup the directory even if it is not a temporary directory

    +

    Optional force

    force?: boolean

    Setting this to true will cleanup the directory even if it is not a temporary directory

    Default

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    doCleanupforce
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    doCleanupforce
    \ No newline at end of file diff --git a/typedoc/modules/MongoMemoryReplSet.html b/typedoc/modules/MongoMemoryReplSet.html index 79c603ab..b6592cae 100644 --- a/typedoc/modules/MongoMemoryReplSet.html +++ b/typedoc/modules/MongoMemoryReplSet.html @@ -1,4 +1,4 @@ -MongoMemoryReplSet | mongodb-memory-server-core

    Module MongoMemoryReplSet

    References

    default +MongoMemoryReplSet | mongodb-memory-server-core

    Module MongoMemoryReplSet

    References

    default

    Enumerations

    MongoMemoryReplSetEvents MongoMemoryReplSetStates

    Classes

    MongoMemoryReplSet diff --git a/typedoc/modules/MongoMemoryServer.html b/typedoc/modules/MongoMemoryServer.html index 123fc36f..1cdb1e9a 100644 --- a/typedoc/modules/MongoMemoryServer.html +++ b/typedoc/modules/MongoMemoryServer.html @@ -1,4 +1,4 @@ -MongoMemoryServer | mongodb-memory-server-core

    Module MongoMemoryServer

    References

    default +MongoMemoryServer | mongodb-memory-server-core

    Module MongoMemoryServer

    References

    default

    Enumerations

    MongoMemoryServerEvents MongoMemoryServerStates

    Classes

    MongoMemoryServer diff --git a/typedoc/modules/index.html b/typedoc/modules/index.html index e8118fc5..c0e3946c 100644 --- a/typedoc/modules/index.html +++ b/typedoc/modules/index.html @@ -1,4 +1,4 @@ -index | mongodb-memory-server-core

    Module index

    References

    DryMongoBinary +index | mongodb-memory-server-core

    Module index

    References

    DryMongoBinary MongoBinary MongoInstance MongoMemoryReplSet diff --git a/typedoc/modules/util_DryMongoBinary.html b/typedoc/modules/util_DryMongoBinary.html index f33d6d20..020c5642 100644 --- a/typedoc/modules/util_DryMongoBinary.html +++ b/typedoc/modules/util_DryMongoBinary.html @@ -1,4 +1,4 @@ -util/DryMongoBinary | mongodb-memory-server-core

    Module util/DryMongoBinary

    Index

    Classes

    DryMongoBinary +util/DryMongoBinary | mongodb-memory-server-core

    Module util/DryMongoBinary

    Index

    Classes

    DryMongoBinary

    Interfaces

    BaseDryMongoBinaryOptions DryMongoBinaryArchiveRegexGroups DryMongoBinaryNameOptions diff --git a/typedoc/modules/util_MongoBinary.html b/typedoc/modules/util_MongoBinary.html index 19681fd7..9167ffe9 100644 --- a/typedoc/modules/util_MongoBinary.html +++ b/typedoc/modules/util_MongoBinary.html @@ -1,4 +1,4 @@ -util/MongoBinary | mongodb-memory-server-core

    Module util/MongoBinary

    References

    default +util/MongoBinary | mongodb-memory-server-core

    Module util/MongoBinary

    References

    default

    Classes

    MongoBinary

    Interfaces

    MongoBinaryOpts

    References

    default

    Renames and re-exports MongoBinary

    Settings

    Member Visibility

    Theme

    On This Page

    default
    \ No newline at end of file diff --git a/typedoc/modules/util_MongoBinaryDownload.html b/typedoc/modules/util_MongoBinaryDownload.html index fff89a5d..e90b88a0 100644 --- a/typedoc/modules/util_MongoBinaryDownload.html +++ b/typedoc/modules/util_MongoBinaryDownload.html @@ -1,4 +1,4 @@ -util/MongoBinaryDownload | mongodb-memory-server-core

    Module util/MongoBinaryDownload

    References

    default +util/MongoBinaryDownload | mongodb-memory-server-core

    Module util/MongoBinaryDownload

    References

    default

    Classes

    MongoBinaryDownload

    Interfaces

    MongoBinaryDownloadProgress

    References

    default

    Renames and re-exports MongoBinaryDownload

    Settings

    Member Visibility

    Theme

    On This Page

    default
    \ No newline at end of file diff --git a/typedoc/modules/util_MongoBinaryDownloadUrl.html b/typedoc/modules/util_MongoBinaryDownloadUrl.html index ca961911..acf6f8b0 100644 --- a/typedoc/modules/util_MongoBinaryDownloadUrl.html +++ b/typedoc/modules/util_MongoBinaryDownloadUrl.html @@ -1,4 +1,4 @@ -util/MongoBinaryDownloadUrl | mongodb-memory-server-core

    Module util/MongoBinaryDownloadUrl

    References

    default +util/MongoBinaryDownloadUrl | mongodb-memory-server-core

    Module util/MongoBinaryDownloadUrl

    References

    default

    Classes

    MongoBinaryDownloadUrl

    Interfaces

    MongoBinaryDownloadUrlOpts

    Variables

    DEFAULT_UBUNTU_YEAR diff --git a/typedoc/modules/util_MongoInstance.html b/typedoc/modules/util_MongoInstance.html index 92435710..e9207c8d 100644 --- a/typedoc/modules/util_MongoInstance.html +++ b/typedoc/modules/util_MongoInstance.html @@ -1,4 +1,4 @@ -util/MongoInstance | mongodb-memory-server-core

    Module util/MongoInstance

    References

    default +util/MongoInstance | mongodb-memory-server-core

    Module util/MongoInstance

    References

    default

    Enumerations

    MongoInstanceEvents

    Classes

    MongoInstance

    Interfaces

    MongoMemoryInstanceOpts diff --git a/typedoc/modules/util_errors.html b/typedoc/modules/util_errors.html index 6c4d8774..a8e77812 100644 --- a/typedoc/modules/util_errors.html +++ b/typedoc/modules/util_errors.html @@ -1,4 +1,4 @@ -util/errors | mongodb-memory-server-core

    Module util/errors

    Index

    Classes

    AssertionFallbackError +util/errors | mongodb-memory-server-core

    Module util/errors

    Index

    Classes

    AssertionFallbackError AuthNotObjectError BinaryNotFoundError DownloadError diff --git a/typedoc/modules/util_getos.html b/typedoc/modules/util_getos.html index 0470348e..9352aad9 100644 --- a/typedoc/modules/util_getos.html +++ b/typedoc/modules/util_getos.html @@ -1,4 +1,4 @@ -util/getos | mongodb-memory-server-core

    Module util/getos

    Index

    Interfaces

    LinuxOS +util/getos | mongodb-memory-server-core

    Module util/getos

    Index

    Interfaces

    LinuxOS OtherOS

    Type Aliases

    AnyOS

    Variables

    UNKNOWN diff --git a/typedoc/modules/util_getport.html b/typedoc/modules/util_getport.html index 39c05355..af0b9c1b 100644 --- a/typedoc/modules/util_getport.html +++ b/typedoc/modules/util_getport.html @@ -1,4 +1,4 @@ -util/getport | mongodb-memory-server-core

    Module util/getport

    References

    default +util/getport | mongodb-memory-server-core

    Module util/getport

    References

    default

    Variables

    MAX_PORT MIN_PORT

    Functions

    getFreePort diff --git a/typedoc/modules/util_lockfile.html b/typedoc/modules/util_lockfile.html index c4c5d325..73f3b894 100644 --- a/typedoc/modules/util_lockfile.html +++ b/typedoc/modules/util_lockfile.html @@ -1,4 +1,4 @@ -util/lockfile | mongodb-memory-server-core

    Module util/lockfile

    Index

    Enumerations

    LockFileEvents +util/lockfile | mongodb-memory-server-core

    Module util/lockfile

    Index

    Enumerations

    LockFileEvents LockFileStatus

    Classes

    LockFile

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/modules/util_postinstallHelper.html b/typedoc/modules/util_postinstallHelper.html index c7d8430d..1ebaf66a 100644 --- a/typedoc/modules/util_postinstallHelper.html +++ b/typedoc/modules/util_postinstallHelper.html @@ -1,2 +1,2 @@ -util/postinstallHelper | mongodb-memory-server-core

    Module util/postinstallHelper

    Index

    Functions

    postInstallEnsureBinary +util/postinstallHelper | mongodb-memory-server-core

    Module util/postinstallHelper

    Index

    Functions

    postInstallEnsureBinary

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/modules/util_resolveConfig.html b/typedoc/modules/util_resolveConfig.html index e7456593..b51188fa 100644 --- a/typedoc/modules/util_resolveConfig.html +++ b/typedoc/modules/util_resolveConfig.html @@ -1,4 +1,4 @@ -util/resolveConfig | mongodb-memory-server-core

    Module util/resolveConfig

    References

    default +util/resolveConfig | mongodb-memory-server-core

    Module util/resolveConfig

    References

    default

    Enumerations

    ResolveConfigVariables

    Variables

    DEFAULT_VERSION ENV_CONFIG_PREFIX diff --git a/typedoc/modules/util_utils.html b/typedoc/modules/util_utils.html index 31a9982e..cc94ed6f 100644 --- a/typedoc/modules/util_utils.html +++ b/typedoc/modules/util_utils.html @@ -1,4 +1,4 @@ -util/utils | mongodb-memory-server-core

    Module util/utils

    Index

    Classes

    ManagerAdvanced +util/utils | mongodb-memory-server-core

    Module util/utils

    Index

    Classes

    ManagerAdvanced ManagerBase

    Interfaces

    Cleanup

    Functions

    assertion diff --git a/typedoc/types/MongoMemoryServer.MemoryServerInstanceOpts.html b/typedoc/types/MongoMemoryServer.MemoryServerInstanceOpts.html index 65a97021..ce65cb30 100644 --- a/typedoc/types/MongoMemoryServer.MemoryServerInstanceOpts.html +++ b/typedoc/types/MongoMemoryServer.MemoryServerInstanceOpts.html @@ -1,3 +1,3 @@ MemoryServerInstanceOpts | mongodb-memory-server-core

    Type alias MemoryServerInstanceOpts

    MemoryServerInstanceOpts: Omit<MongoMemoryInstanceOpts, "auth"> & ExtraInstanceOpts

    Type with automatic options removed "auth" is automatically handled and set via AutomaticAuth

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/types/MongoMemoryServer.UserRoles.html b/typedoc/types/MongoMemoryServer.UserRoles.html index 598651b0..081c6397 100644 --- a/typedoc/types/MongoMemoryServer.UserRoles.html +++ b/typedoc/types/MongoMemoryServer.UserRoles.html @@ -1,3 +1,3 @@ UserRoles | mongodb-memory-server-core

    Type alias UserRoles

    UserRoles: "read" | "readWrite" | "dbAdmin" | "dbOwner" | "userAdmin" | "clusterAdmin" | "clusterManager" | "clusterMonitor" | "hostManager" | "backup" | "restore" | "readAnyDatabase" | "readWriteAnyDatabase" | "userAdminAnyDatabase" | "dbAdminAnyDatabase" | "root" | string

    All MongoDB Built-in Roles

    See

    https://docs.mongodb.com/manual/reference/built-in-roles/

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/types/util_MongoInstance.StorageEngine.html b/typedoc/types/util_MongoInstance.StorageEngine.html index 609938e6..4c783a0d 100644 --- a/typedoc/types/util_MongoInstance.StorageEngine.html +++ b/typedoc/types/util_MongoInstance.StorageEngine.html @@ -1 +1 @@ -StorageEngine | mongodb-memory-server-core

    Type alias StorageEngine

    StorageEngine: "ephemeralForTest" | "wiredTiger"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +StorageEngine | mongodb-memory-server-core

    Type alias StorageEngine

    StorageEngine: "ephemeralForTest" | "wiredTiger"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/types/util_getos.AnyOS.html b/typedoc/types/util_getos.AnyOS.html index 7ff392bc..12c9f286 100644 --- a/typedoc/types/util_getos.AnyOS.html +++ b/typedoc/types/util_getos.AnyOS.html @@ -1 +1 @@ -AnyOS | mongodb-memory-server-core

    Type alias AnyOS

    AnyOS: OtherOS | LinuxOS

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +AnyOS | mongodb-memory-server-core

    Type alias AnyOS

    AnyOS: OtherOS | LinuxOS

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/variables/util_MongoBinaryDownloadUrl.DEFAULT_UBUNTU_YEAR.html b/typedoc/variables/util_MongoBinaryDownloadUrl.DEFAULT_UBUNTU_YEAR.html index 7112e55b..db1472f4 100644 --- a/typedoc/variables/util_MongoBinaryDownloadUrl.DEFAULT_UBUNTU_YEAR.html +++ b/typedoc/variables/util_MongoBinaryDownloadUrl.DEFAULT_UBUNTU_YEAR.html @@ -1,2 +1,2 @@ DEFAULT_UBUNTU_YEAR | mongodb-memory-server-core

    Variable DEFAULT_UBUNTU_YEARConst

    DEFAULT_UBUNTU_YEAR: 22 = 22

    Set the default ubuntu version number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/variables/util_getos.UNKNOWN.html b/typedoc/variables/util_getos.UNKNOWN.html index 9498dffe..70bf5dc7 100644 --- a/typedoc/variables/util_getos.UNKNOWN.html +++ b/typedoc/variables/util_getos.UNKNOWN.html @@ -1,2 +1,2 @@ UNKNOWN | mongodb-memory-server-core

    Variable UNKNOWNConst

    UNKNOWN: "unknown" = 'unknown'

    Helper Static so that a consistent UNKNOWN value is used

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/variables/util_getport.MAX_PORT.html b/typedoc/variables/util_getport.MAX_PORT.html index 1e653a03..fd10511f 100644 --- a/typedoc/variables/util_getport.MAX_PORT.html +++ b/typedoc/variables/util_getport.MAX_PORT.html @@ -1,2 +1,2 @@ MAX_PORT | mongodb-memory-server-core

    Variable MAX_PORTConst

    MAX_PORT: 65535 = 65535

    u16 max number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/variables/util_getport.MIN_PORT.html b/typedoc/variables/util_getport.MIN_PORT.html index 24a506c7..49bd7137 100644 --- a/typedoc/variables/util_getport.MIN_PORT.html +++ b/typedoc/variables/util_getport.MIN_PORT.html @@ -1,2 +1,2 @@ MIN_PORT | mongodb-memory-server-core

    Variable MIN_PORTConst

    MIN_PORT: 1024 = 1024

    Linux min port that does not require root permissions

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/variables/util_resolveConfig.DEFAULT_VERSION.html b/typedoc/variables/util_resolveConfig.DEFAULT_VERSION.html index b579c53e..29426399 100644 --- a/typedoc/variables/util_resolveConfig.DEFAULT_VERSION.html +++ b/typedoc/variables/util_resolveConfig.DEFAULT_VERSION.html @@ -1,2 +1,2 @@ -DEFAULT_VERSION | mongodb-memory-server-core

    Variable DEFAULT_VERSIONConst

    DEFAULT_VERSION: "7.0.11" = '7.0.11'

    This Value exists here, because "defaultValues" can be changed with "setDefaultValue", but this property is constant

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +DEFAULT_VERSION | mongodb-memory-server-core

    Variable DEFAULT_VERSIONConst

    DEFAULT_VERSION: "7.0.14" = '7.0.14'

    This Value exists here, because "defaultValues" can be changed with "setDefaultValue", but this property is constant

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/variables/util_resolveConfig.ENV_CONFIG_PREFIX.html b/typedoc/variables/util_resolveConfig.ENV_CONFIG_PREFIX.html index a4b78d7e..daf20b86 100644 --- a/typedoc/variables/util_resolveConfig.ENV_CONFIG_PREFIX.html +++ b/typedoc/variables/util_resolveConfig.ENV_CONFIG_PREFIX.html @@ -1,2 +1,2 @@ ENV_CONFIG_PREFIX | mongodb-memory-server-core

    Variable ENV_CONFIG_PREFIXConst

    ENV_CONFIG_PREFIX: "MONGOMS_" = 'MONGOMS_'

    The Prefix for Environmental values

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/typedoc/variables/util_resolveConfig.defaultValues.html b/typedoc/variables/util_resolveConfig.defaultValues.html index a2fd7f23..f5409178 100644 --- a/typedoc/variables/util_resolveConfig.defaultValues.html +++ b/typedoc/variables/util_resolveConfig.defaultValues.html @@ -1,2 +1,2 @@ defaultValues | mongodb-memory-server-core

    Variable defaultValuesConst

    defaultValues: Map<ResolveConfigVariables, string> = ...

    Default values for some config options that require explicit setting, it is constant so that the default values cannot be interfered with

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file