From 1513b2b182c766180f4bd3f4e0210f8341cf45e2 Mon Sep 17 00:00:00 2001 From: github-pages-deploy <> Date: Sat, 31 Aug 2024 10:21:03 +0000 Subject: [PATCH] Deploying to gh-pages from @ 154794bb0107d65b106239f5614362159803df5e --- 404.html | 10 ++-- ...tyles.2360b0bf.css => styles.5128c9ed.css} | 2 +- assets/js/088ea2b2.46a5db36.js | 1 + assets/js/088ea2b2.dd84045d.js | 1 - assets/js/111fcaee.2c579aaf.js | 1 - assets/js/111fcaee.da60d174.js | 1 + assets/js/12f3979d.7bf7516b.js | 1 - assets/js/12f3979d.7ea1d274.js | 1 + assets/js/17896441.869ac5de.js | 1 + assets/js/17896441.89614cd5.js | 1 - assets/js/1bdfe715.140f729e.js | 1 - assets/js/1bdfe715.ce84fdc7.js | 1 + assets/js/1be78505.540812ce.js | 1 - assets/js/1be78505.9a55653b.js | 1 + assets/js/1cfa44aa.17d0eb64.js | 1 + assets/js/1cfa44aa.70d4e039.js | 1 - assets/js/24f38be7.2cf6d8ab.js | 1 + assets/js/24f38be7.3147988c.js | 1 - assets/js/28ece197.8d506c68.js | 1 + assets/js/28ece197.e68f1224.js | 1 - assets/js/32c6e8e6.ee12d14c.js | 1 - assets/js/32c6e8e6.ee77b853.js | 1 + assets/js/44df2d52.3df3f8af.js | 1 - assets/js/44df2d52.d56d6678.js | 1 + ...4ae68.c28ea5c8.js => 66a4ae68.3438cff4.js} | 2 +- assets/js/6d7d5585.c78ba8c4.js | 1 + assets/js/6d7d5585.f5050671.js | 1 - assets/js/6fc6bd8d.7fc7d735.js | 1 - assets/js/6fc6bd8d.9ebe3e1d.js | 1 + assets/js/75d87773.34a1814f.js | 1 - assets/js/75d87773.fcf4f8ce.js | 1 + assets/js/774.3a7b2b43.js | 1 + assets/js/7f2a500a.05aa4ddd.js | 1 - assets/js/7f2a500a.6574e89c.js | 1 + assets/js/812a5cd9.82e78240.js | 1 - assets/js/812a5cd9.91062a0e.js | 1 + assets/js/83cdaeac.4b7de614.js | 1 + assets/js/83cdaeac.ff301086.js | 1 - ...84a34.d0592815.js => 84a84a34.c64b8d14.js} | 2 +- assets/js/85f7b89a.bc11b049.js | 1 - assets/js/85f7b89a.de5ac5b2.js | 1 + assets/js/8f715786.c4dc1396.js | 1 - assets/js/8f715786.f986d602.js | 1 + assets/js/9082ebdf.77115fcc.js | 1 - assets/js/9082ebdf.dd089d94.js | 1 + assets/js/935f2afb.3691dd17.js | 1 + assets/js/935f2afb.e95c590f.js | 1 - assets/js/972.d4b21274.js | 1 - ...5f834.29d02e91.js => 9795f834.41690aba.js} | 2 +- assets/js/9f6ab2c9.09478866.js | 1 - assets/js/9f6ab2c9.2055a04e.js | 1 + assets/js/a5852e81.358fc4f2.js | 1 - assets/js/a5852e81.6e284725.js | 1 + assets/js/a8d48a20.2eed5ea4.js | 1 - assets/js/a8d48a20.3b9558a9.js | 1 + assets/js/a97422aa.6196a1a2.js | 1 + assets/js/a97422aa.98947165.js | 1 - assets/js/af543849.bea8151c.js | 1 - assets/js/af543849.ed0acd37.js | 1 + assets/js/b0db94fd.42364ff9.js | 1 + assets/js/b0db94fd.70789046.js | 1 - ...a53f4.65d83139.js => b46a53f4.afca2b6e.js} | 2 +- assets/js/c4f5d8e4.6b49d40d.js | 1 + assets/js/c4f5d8e4.998c3770.js | 1 - assets/js/ca5259b8.06396863.js | 1 + assets/js/ca5259b8.088eb869.js | 1 - assets/js/d351376f.0b1991ff.js | 1 - assets/js/d351376f.ba3000bd.js | 1 + ...16940.366a2e06.js => d5016940.b55e0830.js} | 2 +- assets/js/db74d20c.8910a6a5.js | 1 - assets/js/db74d20c.8a8e9f59.js | 1 + assets/js/e3728ee4.8241cdc5.js | 1 - assets/js/e3728ee4.884ec387.js | 1 + assets/js/e9ab2b32.9d5cf28d.js | 1 - assets/js/e9ab2b32.e6fa4011.js | 1 + assets/js/ea46b895.c7d5235c.js | 1 + assets/js/ea46b895.f3896ddf.js | 1 - assets/js/f9ecf5d9.d6473097.js | 1 + assets/js/f9ecf5d9.f96edee4.js | 1 - assets/js/faafc594.6278622b.js | 1 + assets/js/faafc594.ef58ede4.js | 1 - assets/js/fc8b4723.2ffa073f.js | 1 - assets/js/fc8b4723.f1e3fbe1.js | 1 + assets/js/main.81c2b3cb.js | 2 - assets/js/main.ed4fd4f8.js | 2 + ...CENSE.txt => main.ed4fd4f8.js.LICENSE.txt} | 0 assets/js/runtime~main.5ef48574.js | 1 + assets/js/runtime~main.af602612.js | 1 - docs/api/classes/dry-mongo-binary/index.html | 10 ++-- docs/api/classes/mongo-binary/index.html | 10 ++-- docs/api/classes/mongo-instance/index.html | 10 ++-- .../classes/mongo-memory-replset/index.html | 10 ++-- .../classes/mongo-memory-server/index.html | 10 ++-- docs/api/config-options/index.html | 10 ++-- .../mongo-memory-replset-states/index.html | 10 ++-- .../mongo-memory-server-states/index.html | 10 ++-- docs/api/index-api/index.html | 10 ++-- docs/api/index.html | 10 ++-- .../mongo-memory-binary-opts/index.html | 10 ++-- .../mongo-memory-dispose-opts/index.html | 10 ++-- .../mongo-memory-instance-opts/index.html | 10 ++-- .../index.html | 10 ++-- .../mongo-memory-replset-opts/index.html | 10 ++-- .../index.html | 10 ++-- .../mongo-memory-server-createuser/index.html | 10 ++-- .../mongo-memory-server-opts/index.html | 10 ++-- docs/api/interfaces/replset-opts/index.html | 10 ++-- docs/guides/common-issues/index.html | 10 ++-- docs/guides/enable-debug-mode/index.html | 10 ++-- docs/guides/error-warning-details/index.html | 10 ++-- docs/guides/faq/index.html | 10 ++-- docs/guides/index.html | 10 ++-- .../integration-examples/docker/index.html | 10 ++-- .../test-runners/index.html | 10 ++-- docs/guides/known-issues/index.html | 10 ++-- docs/guides/migration/migrate10/index.html | 10 ++-- docs/guides/migration/migrate7/index.html | 10 ++-- docs/guides/migration/migrate8/index.html | 10 ++-- docs/guides/migration/migrate9/index.html | 10 ++-- .../guides/mongodb-server-versions/index.html | 10 ++-- docs/guides/quick-start-guide/index.html | 10 ++-- docs/guides/supported-systems/index.html | 10 ++-- docs/index.html | 10 ++-- docs/test/index.html | 10 ++-- index.html | 10 ++-- ...MongoMemoryReplSet.MongoMemoryReplSet.html | 52 +++++++++---------- .../MongoMemoryServer.MongoMemoryServer.html | 40 +++++++------- .../util_DryMongoBinary.DryMongoBinary.html | 22 ++++---- .../classes/util_MongoBinary.MongoBinary.html | 6 +-- ...ngoBinaryDownload.MongoBinaryDownload.html | 28 +++++----- ...aryDownloadUrl.MongoBinaryDownloadUrl.html | 34 ++++++------ .../util_MongoInstance.MongoInstance.html | 46 ++++++++-------- .../util_errors.AssertionFallbackError.html | 4 +- .../util_errors.AuthNotObjectError.html | 4 +- .../util_errors.BinaryNotFoundError.html | 4 +- .../classes/util_errors.DownloadError.html | 4 +- .../classes/util_errors.GenericMMSError.html | 2 +- .../util_errors.InstanceInfoError.html | 4 +- ...l_errors.InsufficientPermissionsError.html | 4 +- .../util_errors.KeyFileMissingError.html | 4 +- ...rors.KnownVersionIncompatibilityError.html | 4 +- .../util_errors.Md5CheckFailedError.html | 4 +- .../util_errors.NoRegexMatchError.html | 4 +- .../util_errors.ParseArchiveRegexError.html | 4 +- .../util_errors.ReplsetCountLowError.html | 4 +- .../util_errors.StartBinaryFailedError.html | 4 +- typedoc/classes/util_errors.StateError.html | 4 +- .../util_errors.StdoutInstanceError.html | 4 +- ...il_errors.UnableToUnlockLockfileError.html | 4 +- .../util_errors.UnexpectedCloseError.html | 4 +- .../util_errors.UnknownArchitectureError.html | 4 +- .../util_errors.UnknownLinuxDistro.html | 4 +- ...til_errors.UnknownLockfileStatusError.html | 4 +- .../util_errors.UnknownPlatformError.html | 4 +- .../util_errors.UnknownVersionError.html | 4 +- ...til_errors.WaitForPrimaryTimeoutError.html | 4 +- typedoc/classes/util_lockfile.LockFile.html | 26 +++++----- .../classes/util_utils.ManagerAdvanced.html | 4 +- typedoc/classes/util_utils.ManagerBase.html | 4 +- ...emoryReplSet.MongoMemoryReplSetEvents.html | 4 +- ...emoryReplSet.MongoMemoryReplSetStates.html | 4 +- ...oMemoryServer.MongoMemoryServerEvents.html | 4 +- ...oMemoryServer.MongoMemoryServerStates.html | 4 +- ...til_MongoInstance.MongoInstanceEvents.html | 8 +-- .../enums/util_lockfile.LockFileEvents.html | 4 +- .../enums/util_lockfile.LockFileStatus.html | 10 ++-- ..._resolveConfig.ResolveConfigVariables.html | 4 +- typedoc/functions/util_getos.getOS.html | 2 +- typedoc/functions/util_getos.isLinuxOS.html | 2 +- typedoc/functions/util_getos.isValidOs.html | 2 +- typedoc/functions/util_getos.parseLSB.html | 2 +- typedoc/functions/util_getos.parseOS.html | 2 +- .../functions/util_getport.getFreePort.html | 2 +- .../util_getport.resetPortsCache.html | 2 +- typedoc/functions/util_getport.tryPort.html | 2 +- typedoc/functions/util_getport.validPort.html | 2 +- ...installHelper.postInstallEnsureBinary.html | 2 +- .../functions/util_resolveConfig.envName.html | 2 +- .../util_resolveConfig.envToBool.html | 2 +- .../util_resolveConfig.findPackageJson.html | 2 +- .../util_resolveConfig.packageJsonPath.html | 2 +- ...til_resolveConfig.processConfigOption.html | 2 +- .../util_resolveConfig.resolveConfig.html | 2 +- .../util_resolveConfig.setDefaultValue.html | 2 +- typedoc/functions/util_utils.assertion.html | 2 +- typedoc/functions/util_utils.authDefault.html | 2 +- .../util_utils.checkBinaryPermissions.html | 2 +- .../functions/util_utils.createTmpDir.html | 2 +- typedoc/functions/util_utils.ensureAsync.html | 2 +- .../functions/util_utils.errorWithCode.html | 2 +- .../functions/util_utils.generateDbName.html | 2 +- typedoc/functions/util_utils.getHost.html | 2 +- .../util_utils.getStorageEngine.html | 2 +- typedoc/functions/util_utils.isAlive.html | 2 +- .../util_utils.isNullOrUndefined.html | 2 +- typedoc/functions/util_utils.killProcess.html | 2 +- .../functions/util_utils.lockfilePath.html | 2 +- typedoc/functions/util_utils.md5.html | 2 +- typedoc/functions/util_utils.md5FromFile.html | 2 +- typedoc/functions/util_utils.mkdir.html | 2 +- typedoc/functions/util_utils.pathExists.html | 2 +- typedoc/functions/util_utils.removeDir.html | 2 +- typedoc/functions/util_utils.statPath.html | 2 +- .../functions/util_utils.tryReleaseFile.html | 2 +- typedoc/functions/util_utils.uriTemplate.html | 2 +- typedoc/functions/util_utils.uuidv4.html | 2 +- ...lSet.MongoMemoryReplSetConfigSettings.html | 4 +- ...oMemoryReplSet.MongoMemoryReplSetOpts.html | 8 +-- .../MongoMemoryReplSet.ReplSetOpts.html | 22 ++++---- .../MongoMemoryServer.AutomaticAuth.html | 14 ++--- .../MongoMemoryServer.CreateUser.html | 18 +++---- .../MongoMemoryServer.CreateUserMongoDB.html | 16 +++--- .../MongoMemoryServer.DisposeOptions.html | 6 +-- .../MongoMemoryServer.ExtraInstanceOpts.html | 4 +- .../MongoMemoryServer.MongoInstanceData.html | 4 +- ...rver.MongoMemoryServerGetStartOptions.html | 4 +- ...ngoMemoryServer.MongoMemoryServerOpts.html | 6 +-- .../MongoMemoryServer.RoleSpecification.html | 6 +-- ...MongoMemoryServer.StartupInstanceData.html | 4 +- ...MongoBinary.BaseDryMongoBinaryOptions.html | 4 +- ...nary.DryMongoBinaryArchiveRegexGroups.html | 4 +- ...MongoBinary.DryMongoBinaryNameOptions.html | 4 +- ..._DryMongoBinary.DryMongoBinaryOptions.html | 4 +- ...il_DryMongoBinary.DryMongoBinaryPaths.html | 10 ++-- .../util_MongoBinary.MongoBinaryOpts.html | 4 +- ...yDownload.MongoBinaryDownloadProgress.html | 4 +- ...ownloadUrl.MongoBinaryDownloadUrlOpts.html | 4 +- ...MongoInstance.MongoMemoryInstanceOpts.html | 24 ++++----- ...oInstance.MongoMemoryInstanceOptsBase.html | 14 ++--- .../util_MongoInstance.MongodOpts.html | 8 +-- ...til_MongoInstance.ReplicaMemberConfig.html | 18 +++---- typedoc/interfaces/util_getos.LinuxOS.html | 4 +- typedoc/interfaces/util_getos.OtherOS.html | 4 +- typedoc/interfaces/util_utils.Cleanup.html | 6 +-- typedoc/modules/MongoMemoryReplSet.html | 2 +- typedoc/modules/MongoMemoryServer.html | 2 +- typedoc/modules/index.html | 2 +- typedoc/modules/util_DryMongoBinary.html | 2 +- typedoc/modules/util_MongoBinary.html | 2 +- typedoc/modules/util_MongoBinaryDownload.html | 2 +- .../modules/util_MongoBinaryDownloadUrl.html | 2 +- typedoc/modules/util_MongoInstance.html | 2 +- typedoc/modules/util_errors.html | 2 +- typedoc/modules/util_getos.html | 2 +- typedoc/modules/util_getport.html | 2 +- typedoc/modules/util_lockfile.html | 2 +- typedoc/modules/util_postinstallHelper.html | 2 +- typedoc/modules/util_resolveConfig.html | 2 +- typedoc/modules/util_utils.html | 2 +- ...MemoryServer.MemoryServerInstanceOpts.html | 2 +- .../types/MongoMemoryServer.UserRoles.html | 2 +- .../util_MongoInstance.StorageEngine.html | 2 +- typedoc/types/util_getos.AnyOS.html | 2 +- ...BinaryDownloadUrl.DEFAULT_UBUNTU_YEAR.html | 2 +- typedoc/variables/util_getos.UNKNOWN.html | 2 +- typedoc/variables/util_getport.MAX_PORT.html | 2 +- typedoc/variables/util_getport.MIN_PORT.html | 2 +- .../util_resolveConfig.DEFAULT_VERSION.html | 2 +- .../util_resolveConfig.ENV_CONFIG_PREFIX.html | 2 +- .../util_resolveConfig.defaultValues.html | 2 +- 260 files changed, 617 insertions(+), 617 deletions(-) rename assets/css/{styles.2360b0bf.css => styles.5128c9ed.css} (60%) create mode 100644 assets/js/088ea2b2.46a5db36.js delete mode 100644 assets/js/088ea2b2.dd84045d.js delete mode 100644 assets/js/111fcaee.2c579aaf.js create mode 100644 assets/js/111fcaee.da60d174.js delete mode 100644 assets/js/12f3979d.7bf7516b.js create mode 100644 assets/js/12f3979d.7ea1d274.js create mode 100644 assets/js/17896441.869ac5de.js delete mode 100644 assets/js/17896441.89614cd5.js delete mode 100644 assets/js/1bdfe715.140f729e.js create mode 100644 assets/js/1bdfe715.ce84fdc7.js delete mode 100644 assets/js/1be78505.540812ce.js create mode 100644 assets/js/1be78505.9a55653b.js create mode 100644 assets/js/1cfa44aa.17d0eb64.js delete mode 100644 assets/js/1cfa44aa.70d4e039.js create mode 100644 assets/js/24f38be7.2cf6d8ab.js delete mode 100644 assets/js/24f38be7.3147988c.js create mode 100644 assets/js/28ece197.8d506c68.js delete mode 100644 assets/js/28ece197.e68f1224.js delete mode 100644 assets/js/32c6e8e6.ee12d14c.js create mode 100644 assets/js/32c6e8e6.ee77b853.js delete mode 100644 assets/js/44df2d52.3df3f8af.js create mode 100644 assets/js/44df2d52.d56d6678.js rename assets/js/{66a4ae68.c28ea5c8.js => 66a4ae68.3438cff4.js} (51%) create mode 100644 assets/js/6d7d5585.c78ba8c4.js delete mode 100644 assets/js/6d7d5585.f5050671.js delete mode 100644 assets/js/6fc6bd8d.7fc7d735.js create mode 100644 assets/js/6fc6bd8d.9ebe3e1d.js delete mode 100644 assets/js/75d87773.34a1814f.js create mode 100644 assets/js/75d87773.fcf4f8ce.js create mode 100644 assets/js/774.3a7b2b43.js delete mode 100644 assets/js/7f2a500a.05aa4ddd.js create mode 100644 assets/js/7f2a500a.6574e89c.js delete mode 100644 assets/js/812a5cd9.82e78240.js create mode 100644 assets/js/812a5cd9.91062a0e.js create mode 100644 assets/js/83cdaeac.4b7de614.js delete mode 100644 assets/js/83cdaeac.ff301086.js rename assets/js/{84a84a34.d0592815.js => 84a84a34.c64b8d14.js} (52%) delete mode 100644 assets/js/85f7b89a.bc11b049.js create mode 100644 assets/js/85f7b89a.de5ac5b2.js delete mode 100644 assets/js/8f715786.c4dc1396.js create mode 100644 assets/js/8f715786.f986d602.js delete mode 100644 assets/js/9082ebdf.77115fcc.js create mode 100644 assets/js/9082ebdf.dd089d94.js create mode 100644 assets/js/935f2afb.3691dd17.js delete mode 100644 assets/js/935f2afb.e95c590f.js delete mode 100644 assets/js/972.d4b21274.js rename assets/js/{9795f834.29d02e91.js => 9795f834.41690aba.js} (62%) delete mode 100644 assets/js/9f6ab2c9.09478866.js create mode 100644 assets/js/9f6ab2c9.2055a04e.js delete mode 100644 assets/js/a5852e81.358fc4f2.js create mode 100644 assets/js/a5852e81.6e284725.js delete mode 100644 assets/js/a8d48a20.2eed5ea4.js create mode 100644 assets/js/a8d48a20.3b9558a9.js create mode 100644 assets/js/a97422aa.6196a1a2.js delete mode 100644 assets/js/a97422aa.98947165.js delete mode 100644 assets/js/af543849.bea8151c.js create mode 100644 assets/js/af543849.ed0acd37.js create mode 100644 assets/js/b0db94fd.42364ff9.js delete mode 100644 assets/js/b0db94fd.70789046.js rename assets/js/{b46a53f4.65d83139.js => b46a53f4.afca2b6e.js} (80%) create mode 100644 assets/js/c4f5d8e4.6b49d40d.js delete mode 100644 assets/js/c4f5d8e4.998c3770.js create mode 100644 assets/js/ca5259b8.06396863.js delete mode 100644 assets/js/ca5259b8.088eb869.js delete mode 100644 assets/js/d351376f.0b1991ff.js create mode 100644 assets/js/d351376f.ba3000bd.js rename assets/js/{d5016940.366a2e06.js => d5016940.b55e0830.js} (59%) delete mode 100644 assets/js/db74d20c.8910a6a5.js create mode 100644 assets/js/db74d20c.8a8e9f59.js delete mode 100644 assets/js/e3728ee4.8241cdc5.js create mode 100644 assets/js/e3728ee4.884ec387.js delete mode 100644 assets/js/e9ab2b32.9d5cf28d.js create mode 100644 assets/js/e9ab2b32.e6fa4011.js create mode 100644 assets/js/ea46b895.c7d5235c.js delete mode 100644 assets/js/ea46b895.f3896ddf.js create mode 100644 assets/js/f9ecf5d9.d6473097.js delete mode 100644 assets/js/f9ecf5d9.f96edee4.js create mode 100644 assets/js/faafc594.6278622b.js delete mode 100644 assets/js/faafc594.ef58ede4.js delete mode 100644 assets/js/fc8b4723.2ffa073f.js create mode 100644 assets/js/fc8b4723.f1e3fbe1.js delete mode 100644 assets/js/main.81c2b3cb.js create mode 100644 assets/js/main.ed4fd4f8.js rename assets/js/{main.81c2b3cb.js.LICENSE.txt => main.ed4fd4f8.js.LICENSE.txt} (100%) create mode 100644 assets/js/runtime~main.5ef48574.js delete mode 100644 assets/js/runtime~main.af602612.js diff --git a/404.html b/404.html index 8e73149bf..efd54ada7 100644 --- a/404.html +++ b/404.html @@ -3,14 +3,14 @@ -Page Not Found | mongodb-memory-server - - +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/css/styles.2360b0bf.css b/assets/css/styles.5128c9ed.css similarity index 60% rename from assets/css/styles.2360b0bf.css rename to assets/css/styles.5128c9ed.css index 213d44454..68555b25c 100644 --- a/assets/css/styles.2360b0bf.css +++ b/assets/css/styles.5128c9ed.css @@ -1 +1 @@ -.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:transparent;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:rgba(0,0,0,.05);--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 rgba(0,0,0,.1);--ifm-global-shadow-md:0 5px 40px rgba(0,0,0,.2);--ifm-global-shadow-tl:0 12px 28px 0 rgba(0,0,0,.2),0 2px 4px 0 rgba(0,0,0,.1);--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:transparent;--ifm-table-stripe-background:rgba(0,0,0,.03);--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary);--ifm-color-primary:#25c2a0;--ifm-color-primary-dark:#21af90;--ifm-color-primary-darker:#1fa588;--ifm-color-primary-darkest:#1a8870;--ifm-color-primary-light:#46cbae;--ifm-color-primary-lighter:#66d4bd;--ifm-color-primary-lightest:#92e0d0;--ifm-code-font-size:95%;--docusaurus-announcement-bar-height:auto;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-collapse-button-bg:transparent;--docusaurus-collapse-button-bg-hover:rgba(0,0,0,.1);--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:transparent}*{box-sizing:border-box}html{-webkit-font-smoothing:antialiased;-webkit-text-size-adjust:100%;-moz-text-size-adjust:100%;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);text-rendering:optimizelegibility}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none,.tabItem_LNqP{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid rgba(0,0,0,.1);border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul,.tabList__CuJ{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_tbUL,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:rgba(53,120,229,.15);--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:rgba(235,237,240,.15);--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:rgba(0,164,0,.15);--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:rgba(84,199,236,.15);--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:rgba(255,186,0,.15);--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:rgba(250,56,62,.15);--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{-webkit-column-gap:var(--ifm-avatar-intro-margin);column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;-webkit-filter:var(--ifm-breadcrumb-separator-filter);filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:-webkit-any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:transparent;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;-webkit-transform:translateY(-1px);transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);-webkit-transform:translateY(-.625rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility,-webkit-transform;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor transparent;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;-webkit-transform:translateY(-50%);transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_S0QG>:last-child,.collapsibleContent_i85q>:last-child,.footer__items,.tabItem_Ymn6>:last-child{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.menu__caret:before,.menu__link--sublist-caret:after{-webkit-filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;width:1.25rem;content:""}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{-webkit-transform:rotate(90deg);transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;filter:var(--ifm-menu-link-sublist-icon-filter);margin-left:auto;min-width:1.25rem;-webkit-transform:rotate(180deg);transform:rotate(180deg);transition:-webkit-transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear,-webkit-transform var(--ifm-transition-fast) linear}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;filter:var(--ifm-menu-link-sublist-icon-filter);-webkit-transform:rotate(180deg);transform:rotate(180deg);transition:-webkit-transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear,-webkit-transform var(--ifm-transition-fast) linear}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:-webkit-sticky;position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;position:fixed;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;left:0;top:0;visibility:hidden}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:hsla(0,0%,100%,.1);--ifm-navbar-search-input-placeholder-color:hsla(0,0%,100%,.5);color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:hsla(0,0%,100%,.05);--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::-webkit-input-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);-webkit-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform,-webkit-transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar--show .navbar-sidebar{-webkit-transform:translateZ(0);transform:translateZ(0)}.navbar-sidebar__backdrop{background-color:rgba(0,0,0,.6);right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));-webkit-transform:translateZ(0);transform:translateZ(0);transition:-webkit-transform var(--ifm-transition-fast) ease-in-out;transition:transform var(--ifm-transition-fast) ease-in-out;transition:transform var(--ifm-transition-fast) ease-in-out,-webkit-transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{-webkit-transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0);transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{-webkit-column-gap:var(--ifm-pagination-page-spacing);column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{grid-gap:var(--ifm-spacing-horizontal);display:grid;gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid transparent;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:hsla(0,0%,100%,.05);--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:hsla(0,0%,100%,.1);--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:hsla(0,0%,100%,.07);--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;-webkit-transform:rotate(3deg) translateY(-4px);transform:rotate(3deg) translateY(-4px);width:100px}[data-theme=dark]{--ifm-badge-color:var(--ifm-font-color-base-inverse)}.docusaurus-highlight-code-line{background-color:#484d5b;display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}#__docusaurus-base-url-issue-banner-container,.themedImage_ToTc,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark] .themedImage--dark_i4oU,[data-theme=light] .themedImage--light_HNdA,html:not([data-theme]) .themedComponent--light_NU7w{display:initial}.iconExternalLink_nPIU{margin-left:.3rem}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:-webkit-transform var(--ifm-transition-fast) ease;transition:transform var(--ifm-transition-fast) ease;transition:transform var(--ifm-transition-fast) ease,-webkit-transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{-webkit-transform:translate3d(0,calc(-100% - 2px),0);transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;-webkit-transform:translate(50%,-50%) rotate(-45deg);transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;-webkit-transform:translateY(-50%);transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_vwxv{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";-webkit-filter:var(--ifm-menu-link-sublist-icon-filter);filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;-webkit-transform:rotate(180deg);transform:rotate(180deg);transition:-webkit-transform var(--ifm-transition-fast);transition:transform var(--ifm-transition-fast);transition:transform var(--ifm-transition-fast),-webkit-transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{-webkit-transform:none;transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.tocCollapsibleContent_vkbj a{display:block}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:-webkit-sticky;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{-webkit-column-gap:.2rem;column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:-webkit-sticky;position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;-webkit-transform:translate(-50%,-50%) scale(.33);transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;-webkit-transform:scale(.33);transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;-webkit-transform:translate(-50%,-50%) scale(1);transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:transparent transparent transparent var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;-webkit-transform:rotate(0);transform:rotate(0);-webkit-transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.img_ev3q{height:auto}.admonition_LlT9{margin-bottom:1em}.admonitionHeading_tbUL{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.3rem}.admonitionHeading_tbUL code{text-transform:none}.admonitionIcon_kALy{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_kALy svg{fill:var(--ifm-alert-foreground-color);display:inline-block;height:1.6em;width:1.6em}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;-webkit-transform:scale(0);transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;-webkit-transform:scale(1);transform:scale(1);visibility:visible}[data-theme=dark]:root{--docusaurus-collapse-button-bg:hsla(0,0%,100%,.05);--docusaurus-collapse-button-bg-hover:hsla(0,0%,100%,.1)}.collapseSidebarButton_PEFL{display:none;margin:0}.docSidebarContainer_b6E3,.sidebarLogo_isFc{display:none}.docMainContainer_gTbr,.docPage__5DB{display:flex;width:100%}.docPage__5DB{flex:1 0}.docsWrapper_BCFX{display:flex;flex:1 0 auto}.heroBanner_UJJx{overflow:hidden;padding:4rem 0;position:relative;text-align:center}.buttons_pzbO{justify-content:center}.buttons_pzbO,.features_keug{align-items:center;display:flex}.features_keug{padding:2rem 0;width:100%}.featureImage_yA8i{height:200px;width:200px}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_m80_{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.searchBox_ZlJk{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_vwxv{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn{max-width:75%!important}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:-webkit-sticky;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;-webkit-transform:rotate(180deg);transform:rotate(180deg)}.expandButtonIcon_BlDH,[dir=rtl] .collapseSidebarButtonIcon_kv0_{-webkit-transform:rotate(0);transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_m80_:focus,.expandButton_m80_:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_m80_{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_BlDH{-webkit-transform:rotate(180deg);transform:rotate(180deg)}.docSidebarContainer_b6E3{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_b3ry{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_Xe31{height:100%;max-height:100vh;position:-webkit-sticky;position:sticky;top:0}.docMainContainer_gTbr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_Uz_u{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_czyv{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.searchBox_ZlJk{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media screen and (max-width:966px){.heroBanner_UJJx{padding:2rem}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file +.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:transparent;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:rgba(0,0,0,.05);--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 rgba(0,0,0,.1);--ifm-global-shadow-md:0 5px 40px rgba(0,0,0,.2);--ifm-global-shadow-tl:0 12px 28px 0 rgba(0,0,0,.2),0 2px 4px 0 rgba(0,0,0,.1);--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:transparent;--ifm-table-stripe-background:rgba(0,0,0,.03);--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary);--ifm-color-primary:#25c2a0;--ifm-color-primary-dark:#21af90;--ifm-color-primary-darker:#1fa588;--ifm-color-primary-darkest:#1a8870;--ifm-color-primary-light:#46cbae;--ifm-color-primary-lighter:#66d4bd;--ifm-color-primary-lightest:#92e0d0;--ifm-code-font-size:95%;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:transparent;--docusaurus-collapse-button-bg-hover:rgba(0,0,0,.1);--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:transparent}*{box-sizing:border-box}html{-webkit-font-smoothing:antialiased;-webkit-text-size-adjust:100%;-moz-text-size-adjust:100%;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);text-rendering:optimizelegibility}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none,.tabItem_LNqP{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid rgba(0,0,0,.1);border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul,.tabList__CuJ{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_tbUL,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:rgba(53,120,229,.15);--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:rgba(235,237,240,.15);--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:rgba(0,164,0,.15);--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:rgba(84,199,236,.15);--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:rgba(255,186,0,.15);--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:rgba(250,56,62,.15);--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{-webkit-column-gap:var(--ifm-avatar-intro-margin);column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;-webkit-filter:var(--ifm-breadcrumb-separator-filter);filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:-webkit-any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:transparent;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;-webkit-transform:translateY(-1px);transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);-webkit-transform:translateY(-.625rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility,-webkit-transform;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor transparent;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;-webkit-transform:translateY(-50%);transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_S0QG>:last-child,.collapsibleContent_i85q>:last-child,.footer__items,.tabItem_Ymn6>:last-child{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.menu__caret:before,.menu__link--sublist-caret:after{-webkit-filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;width:1.25rem;content:""}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{-webkit-transform:rotate(90deg);transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;top:0;left:0;visibility:hidden}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;filter:var(--ifm-menu-link-sublist-icon-filter);margin-left:auto;min-width:1.25rem;-webkit-transform:rotate(180deg);transform:rotate(180deg);transition:-webkit-transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear,-webkit-transform var(--ifm-transition-fast) linear}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;filter:var(--ifm-menu-link-sublist-icon-filter);-webkit-transform:rotate(180deg);transform:rotate(180deg);transition:-webkit-transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear,-webkit-transform var(--ifm-transition-fast) linear}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:-webkit-sticky;position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:hsla(0,0%,100%,.1);--ifm-navbar-search-input-placeholder-color:hsla(0,0%,100%,.5);color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:hsla(0,0%,100%,.05);--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::-webkit-input-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);position:fixed;-webkit-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform,-webkit-transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar--show .navbar-sidebar{-webkit-transform:translateZ(0);transform:translateZ(0)}.navbar-sidebar__backdrop{background-color:rgba(0,0,0,.6);position:fixed;right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));-webkit-transform:translateZ(0);transform:translateZ(0);transition:-webkit-transform var(--ifm-transition-fast) ease-in-out;transition:transform var(--ifm-transition-fast) ease-in-out;transition:transform var(--ifm-transition-fast) ease-in-out,-webkit-transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{-webkit-transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0);transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{-webkit-column-gap:var(--ifm-pagination-page-spacing);column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{grid-gap:var(--ifm-spacing-horizontal);display:grid;gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid transparent;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:hsla(0,0%,100%,.05);--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:hsla(0,0%,100%,.1);--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:hsla(0,0%,100%,.07);--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;-webkit-transform:rotate(3deg) translateY(-4px);transform:rotate(3deg) translateY(-4px);width:100px}[data-theme=dark]{--ifm-badge-color:var(--ifm-font-color-base-inverse)}.docusaurus-highlight-code-line{background-color:#484d5b;display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;-webkit-transform:translate(50%,-50%) rotate(-45deg);transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;-webkit-transform:translateY(-50%);transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_vwxv{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";-webkit-filter:var(--ifm-menu-link-sublist-icon-filter);filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;-webkit-transform:rotate(180deg);transform:rotate(180deg);transition:-webkit-transform var(--ifm-transition-fast);transition:transform var(--ifm-transition-fast);transition:transform var(--ifm-transition-fast),-webkit-transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{-webkit-transform:none;transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.tocCollapsibleContent_vkbj a{display:block}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:-webkit-sticky;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{-webkit-column-gap:.2rem;column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:-webkit-sticky;position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;-webkit-transform:translate(-50%,-50%) scale(.33);transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;-webkit-transform:scale(.33);transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;-webkit-transform:translate(-50%,-50%) scale(1);transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:transparent transparent transparent var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;-webkit-transform:rotate(0);transform:rotate(0);-webkit-transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.img_ev3q{height:auto}.admonition_LlT9{margin-bottom:1em}.admonitionHeading_tbUL{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.3rem}.admonitionHeading_tbUL code{text-transform:none}.admonitionIcon_kALy{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_kALy svg{fill:var(--ifm-alert-foreground-color);display:inline-block;height:1.6em;width:1.6em}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}#__docusaurus-base-url-issue-banner-container,.docSidebarContainer_b6E3,.sidebarLogo_isFc,.themedImage_ToTc,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark] .themedImage--dark_i4oU,[data-theme=light] .themedImage--light_HNdA,html:not([data-theme]) .themedComponent--light_NU7w{display:initial}.iconExternalLink_nPIU{margin-left:.3rem}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:-webkit-transform var(--ifm-transition-fast) ease;transition:transform var(--ifm-transition-fast) ease;transition:transform var(--ifm-transition-fast) ease,-webkit-transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{-webkit-transform:translate3d(0,calc(-100% - 2px),0);transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;-webkit-transform:scale(0);transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;-webkit-transform:scale(1);transform:scale(1);visibility:visible}[data-theme=dark]:root{--docusaurus-collapse-button-bg:hsla(0,0%,100%,.05);--docusaurus-collapse-button-bg-hover:hsla(0,0%,100%,.1)}.collapseSidebarButton_PEFL{display:none;margin:0}.docMainContainer_gTbr,.docPage__5DB{display:flex;width:100%}.docPage__5DB{flex:1 0}.docsWrapper_BCFX{display:flex;flex:1 0 auto}.heroBanner_UJJx{overflow:hidden;padding:4rem 0;position:relative;text-align:center}.buttons_pzbO{justify-content:center}.buttons_pzbO,.features_keug{align-items:center;display:flex}.features_keug{padding:2rem 0;width:100%}.featureImage_yA8i{height:200px;width:200px}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_m80_{background-color:var(--docusaurus-collapse-button-bg)}.lastUpdated_vwxv{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn{max-width:75%!important}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.searchBox_ZlJk{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:-webkit-sticky;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;-webkit-transform:rotate(180deg);transform:rotate(180deg)}.expandButtonIcon_BlDH,[dir=rtl] .collapseSidebarButtonIcon_kv0_{-webkit-transform:rotate(0);transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_m80_:focus,.expandButton_m80_:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_m80_{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_BlDH{-webkit-transform:rotate(180deg);transform:rotate(180deg)}.docSidebarContainer_b6E3{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_b3ry{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_Xe31{height:100%;max-height:100vh;position:-webkit-sticky;position:sticky;top:0}.docMainContainer_gTbr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_Uz_u{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_czyv{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.docItemContainer_F8PC{padding:0 .3rem}.searchBox_ZlJk{position:absolute;right:var(--ifm-navbar-padding-horizontal)}}@media screen and (max-width:966px){.heroBanner_UJJx{padding:2rem}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/js/088ea2b2.46a5db36.js b/assets/js/088ea2b2.46a5db36.js new file mode 100644 index 000000000..950261c32 --- /dev/null +++ b/assets/js/088ea2b2.46a5db36.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[815],{5680:function(e,n,t){t.d(n,{xA:function(){return l},yg:function(){return g}});var r=t(6540);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var m=r.createContext({}),u=function(e){var n=r.useContext(m),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},l=function(e){var n=u(e.components);return r.createElement(m.Provider,{value:n},e.children)},p="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},y=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,m=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),p=u(t),y=o,g=p["".concat(m,".").concat(y)]||p[y]||c[y]||a;return t?r.createElement(g,i(i({ref:n},l),{},{components:t})):r.createElement(g,i({ref:n},l))}));function g(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=y;var s={};for(var m in n)hasOwnProperty.call(n,m)&&(s[m]=n[m]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;u=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var m=r.createContext({}),u=function(e){var t=r.useContext(m),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=u(e.components);return r.createElement(m.Provider,{value:t},e.children)},p="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,m=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),p=u(n),d=o,y=p["".concat(m,".").concat(d)]||p[d]||c[d]||a;return n?r.createElement(y,i(i({ref:t},l),{},{components:n})):r.createElement(y,i({ref:t},l))}));function y(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=d;var s={};for(var m in t)hasOwnProperty.call(t,m)&&(s[m]=t[m]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;u=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),l=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=l(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),c=l(n),f=o,d=c["".concat(s,".").concat(f)]||c[f]||u[f]||a;return n?r.createElement(d,i(i({ref:t},m),{},{components:n})):r.createElement(d,i({ref:t},m))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=f;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:o,i[1]=p;for(var l=2;l=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=r.createContext({}),l=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},m=function(e){var n=l(e.components);return r.createElement(s.Provider,{value:n},e.children)},c="mdxType",y={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),c=l(t),u=o,g=c["".concat(s,".").concat(u)]||c[u]||y[u]||a;return t?r.createElement(g,i(i({ref:n},m),{},{components:t})):r.createElement(g,i({ref:n},m))}));function g(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=u;var p={};for(var s in n)hasOwnProperty.call(n,s)&&(p[s]=n[s]);p.originalType=e,p[c]="string"==typeof e?e:o,i[1]=p;for(var l=2;l=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=o.createContext({}),d=function(e){var n=o.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=d(e.components);return o.createElement(s.Provider,{value:n},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},c=o.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),m=d(t),c=a,h=m["".concat(s,".").concat(c)]||m[c]||u[c]||r;return t?o.createElement(h,i(i({ref:n},p),{},{components:t})):o.createElement(h,i({ref:n},p))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,i=new Array(r);i[0]=c;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[m]="string"==typeof e?e:a,i[1]=l;for(var d=2;d14",id:"minimal-nodejs-version-is-now-14",level:3},{value:"Mongodb Driver Version upgraded to 5.x",id:"mongodb-driver-version-upgraded-to-5x",level:3},{value:"Default binary version is now 6.x",id:"default-binary-version-is-now-6x",level:3},{value:"Removed platform translations",id:"removed-platform-translations",level:3},{value:"Removed architectures",id:"removed-architectures",level:3},{value:"MongoMemoryServer instance.auth option is now ignored",id:"mongomemoryserver-instanceauth-option-is-now-ignored",level:3},{value:"AutomaticAuth changes",id:"automaticauth-changes",level:3},{value:"MongoMemoryServer and MongoReplSet .cleanup(boolean) and .stop(boolean) have been removed",id:"mongomemoryserver-and-mongoreplset-cleanupboolean-and-stopboolean-have-been-removed",level:3},{value:"MD5_CHECK is now enabled by default",id:"md5_check-is-now-enabled-by-default",level:3},{value:"Merged Error types",id:"merged-error-types",level:3},{value:"Removed Storage engine devnull and mmapv1",id:"removed-storage-engine-devnull-and-mmapv1",level:3},{value:"Linux fallback binary has been removed",id:"linux-fallback-binary-has-been-removed",level:3},{value:"Ubuntu fallback year has been updated",id:"ubuntu-fallback-year-has-been-updated",level:3},{value:"Non-Breaking changes / Additions",id:"non-breaking-changes--additions",level:2},{value:"Compiler target is now es2019",id:"compiler-target-is-now-es2019",level:3},{value:"Crypto function have been changed to use nodejs internals",id:"crypto-function-have-been-changed-to-use-nodejs-internals",level:2},{value:"Binary childprocess is now also .unref()",id:"binary-childprocess-is-now-also-unref",level:2},{value:"The port testing package has been replaced",id:"the-port-testing-package-has-been-replaced",level:2},{value:"Mongodb version 7.0.0 is now supported",id:"mongodb-version-700-is-now-supported",level:2}],u={toc:m},c="wrapper";function h(e){var n=e.components,t=(0,a.Z)(e,i);return(0,r.kt)(c,(0,o.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,"Here are the Important changes made for 9.0.0"),(0,r.kt)("admonition",{title:"Important, Read this first",type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"This Guide is written for migration from version ",(0,r.kt)("inlineCode",{parentName:"p"},"8.16.0")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"9.0.0"),", for versions ",(0,r.kt)("inlineCode",{parentName:"p"},">9.0.0 <10.0.0"),", please consult the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md"},"CHANGELOG"))),(0,r.kt)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,r.kt)("h3",{id:"minimal-nodejs-version-is-now-14"},"Minimal NodeJS version is now ",(0,r.kt)("inlineCode",{parentName:"h3"},"14")),(0,r.kt)("p",null,"With 9.0.0 the minimal nodejs required is ",(0,r.kt)("inlineCode",{parentName:"p"},"14.20.1"),"."),(0,r.kt)("h3",{id:"mongodb-driver-version-upgraded-to-5x"},"Mongodb Driver Version upgraded to 5.x"),(0,r.kt)("p",null,"The used MongoDB Driver version is now ",(0,r.kt)("inlineCode",{parentName:"p"},"5.9.0"),"."),(0,r.kt)("h3",{id:"default-binary-version-is-now-6x"},"Default binary version is now 6.x"),(0,r.kt)("p",null,"The default binary version has been upgraded from ",(0,r.kt)("inlineCode",{parentName:"p"},"5.0.x")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"6.0.x"),". For more specifics see ",(0,r.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/guides/mongodb-server-versions"},"mongodb-server-versions"),"."),(0,r.kt)("h3",{id:"removed-platform-translations"},"Removed platform translations"),(0,r.kt)("p",null,"Some platform translations have been removed, because they are either not needed anymore or werent properly supported in the first place:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"sunos")," -> ",(0,r.kt)("inlineCode",{parentName:"li"},"linux")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"elementary OS")," -> ",(0,r.kt)("inlineCode",{parentName:"li"},"linux"))),(0,r.kt)("h3",{id:"removed-architectures"},"Removed architectures"),(0,r.kt)("p",null,"Some architectures were removed because they were not being build by mongodb anymore and support in mongodb-memory-server has been largely untested:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ia32")," -> ",(0,r.kt)("inlineCode",{parentName:"li"},"i686")," / ",(0,r.kt)("inlineCode",{parentName:"li"},"i386"))),(0,r.kt)("h3",{id:"mongomemoryserver-instanceauth-option-is-now-ignored"},"MongoMemoryServer ",(0,r.kt)("inlineCode",{parentName:"h3"},"instance.auth")," option is now ignored"),(0,r.kt)("p",null,"With 9.0.0 the option ",(0,r.kt)("inlineCode",{parentName:"p"},"instance.auth")," option is going to be ignored, because its set via the (top-level) ",(0,r.kt)("inlineCode",{parentName:"p"},"auth")," option directly."),(0,r.kt)("p",null,"Example:"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"new MongoMemoryServer({ instance: { auth: true } })")," is going to be ignored, use ",(0,r.kt)("inlineCode",{parentName:"p"},"new MongoMemoryServer({ auth: { enable: true } })")),(0,r.kt)("h3",{id:"automaticauth-changes"},(0,r.kt)("inlineCode",{parentName:"h3"},"AutomaticAuth")," changes"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"AutomaticAuth")," has been changed to ",(0,r.kt)("strong",{parentName:"p"},"not")," be enabled anymore by just having a empty object. Also property ",(0,r.kt)("inlineCode",{parentName:"p"},"disable")," has been removed and ",(0,r.kt)("inlineCode",{parentName:"p"},"enable")," has been added."),(0,r.kt)("p",null,"Replace ",(0,r.kt)("inlineCode",{parentName:"p"},"auth: {}")," with ",(0,r.kt)("inlineCode",{parentName:"p"},"auth: { enable: true }"),".",(0,r.kt)("br",{parentName:"p"}),"\n","Replace ",(0,r.kt)("inlineCode",{parentName:"p"},"auth: { disable: true }")," with ",(0,r.kt)("inlineCode",{parentName:"p"},"auth: { enable: false }"),".",(0,r.kt)("br",{parentName:"p"}),"\n","Replace ",(0,r.kt)("inlineCode",{parentName:"p"},"auth: { disable: false }")," with ",(0,r.kt)("inlineCode",{parentName:"p"},"auth: { enable: true }"),". "),(0,r.kt)("h3",{id:"mongomemoryserver-and-mongoreplset-cleanupboolean-and-stopboolean-have-been-removed"},"MongoMemoryServer and MongoReplSet ",(0,r.kt)("inlineCode",{parentName:"h3"},".cleanup(boolean)")," and ",(0,r.kt)("inlineCode",{parentName:"h3"},".stop(boolean)")," have been removed"),(0,r.kt)("p",null,"Previously ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," was the only option for the ",(0,r.kt)("inlineCode",{parentName:"p"},".cleanup")," and ",(0,r.kt)("inlineCode",{parentName:"p"},".stop")," function, but they behaved differently between those 2 function and were replaced with ",(0,r.kt)("inlineCode",{parentName:"p"},"Cleanup")," object-options and now have been completely removed."),(0,r.kt)("p",null,"Replace ",(0,r.kt)("inlineCode",{parentName:"p"},".stop(true)")," with ",(0,r.kt)("inlineCode",{parentName:"p"},".stop({ doCleanup: true })"),".",(0,r.kt)("br",{parentName:"p"}),"\n","Replace ",(0,r.kt)("inlineCode",{parentName:"p"},".cleanup(true)")," with ",(0,r.kt)("inlineCode",{parentName:"p"},".stop({ doCleanup: true, force: true })"),". "),(0,r.kt)("p",null,"Default is still for both ",(0,r.kt)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }"),"."),(0,r.kt)("h3",{id:"md5_check-is-now-enabled-by-default"},(0,r.kt)("inlineCode",{parentName:"h3"},"MD5_CHECK")," is now enabled by default"),(0,r.kt)("p",null,"The config option ",(0,r.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#md5_check"},(0,r.kt)("inlineCode",{parentName:"a"},"MD5_CHECK"))," has been enabled by default now, resulting in always comparing the downloaded archive with a md5 after a download."),(0,r.kt)("h3",{id:"merged-error-types"},"Merged Error types"),(0,r.kt)("p",null,"Some error classes have been merged:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"EnsureInstanceError")," & ",(0,r.kt)("inlineCode",{parentName:"li"},"InstanceInfoError")," -> ",(0,r.kt)("inlineCode",{parentName:"li"},"InstanceInfoError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"NoSystemBinaryFoundError")," & ",(0,r.kt)("inlineCode",{parentName:"li"},"BinaryNotFoundError")," -> ",(0,r.kt)("inlineCode",{parentName:"li"},"BinaryNotFoundError"))),(0,r.kt)("h3",{id:"removed-storage-engine-devnull-and-mmapv1"},"Removed Storage engine ",(0,r.kt)("inlineCode",{parentName:"h3"},"devnull")," and ",(0,r.kt)("inlineCode",{parentName:"h3"},"mmapv1")),(0,r.kt)("p",null,"Storage Engines ",(0,r.kt)("inlineCode",{parentName:"p"},"devnull")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"mmapv1")," have been removed because they are not supported in newer versions of mongodb anymore, ",(0,r.kt)("inlineCode",{parentName:"p"},"wiredTiger")," should be used instead."),(0,r.kt)("h3",{id:"linux-fallback-binary-has-been-removed"},"Linux fallback binary has been removed"),(0,r.kt)("p",null,"Previously there was a code-path for a fallback linux binary, but this has been removed because mongodb has stopped shipping generic linux binaries since versions after 4.0."),(0,r.kt)("p",null,"If a fallback is still required, try to use the ubuntu binary via ",(0,r.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#distro"},"Config Options ",(0,r.kt)("inlineCode",{parentName:"a"},"DISTRO")),"."),(0,r.kt)("h3",{id:"ubuntu-fallback-year-has-been-updated"},"Ubuntu fallback year has been updated"),(0,r.kt)("p",null,"The ubuntu fallback year has been updated to ",(0,r.kt)("inlineCode",{parentName:"p"},"22"),", instead of the previous ",(0,r.kt)("inlineCode",{parentName:"p"},"14"),", because newer versions of mongodb dont ship for any EOL ubuntu version anymore."),(0,r.kt)("p",null,"This fallback is only used if the ubuntu year could not be parsed from the os-file.",(0,r.kt)("br",{parentName:"p"}),"\n","This can also be overwritten with ",(0,r.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#distro"},"Config Option ",(0,r.kt)("inlineCode",{parentName:"a"},"DISTRO")),"."),(0,r.kt)("h2",{id:"non-breaking-changes--additions"},"Non-Breaking changes / Additions"),(0,r.kt)("h3",{id:"compiler-target-is-now-es2019"},"Compiler target is now ",(0,r.kt)("inlineCode",{parentName:"h3"},"es2019")),(0,r.kt)("p",null,"The tsconfig ",(0,r.kt)("inlineCode",{parentName:"p"},"target")," option has been updated to ",(0,r.kt)("inlineCode",{parentName:"p"},"es2019"),", which will result in less polyfills.\nThis should be a non-breaking change"),(0,r.kt)("h2",{id:"crypto-function-have-been-changed-to-use-nodejs-internals"},"Crypto function have been changed to use nodejs internals"),(0,r.kt)("p",null,"Crypto functions like for the md5 check and uuidv4 generation have been moved to use the ",(0,r.kt)("inlineCode",{parentName:"p"},"node:crypto")," support, resulting in dropping 2 dependencies."),(0,r.kt)("p",null,"Dropped dependencies are ",(0,r.kt)("inlineCode",{parentName:"p"},"md5-file")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"uuid"),"."),(0,r.kt)("h2",{id:"binary-childprocess-is-now-also-unref"},"Binary childprocess is now also ",(0,r.kt)("inlineCode",{parentName:"h2"},".unref()")),(0,r.kt)("p",null,"The Mongodb Binary childprocess is now also ",(0,r.kt)("inlineCode",{parentName:"p"},".unref()"),", like the killer process has been for some time."),(0,r.kt)("p",null,"This ",(0,r.kt)("em",{parentName:"p"},"should")," help with non-closed instances not exiting the nodejs process."),(0,r.kt)("h2",{id:"the-port-testing-package-has-been-replaced"},"The port testing package has been replaced"),(0,r.kt)("p",null,"Previously MMS used ",(0,r.kt)("inlineCode",{parentName:"p"},"get-port"),", but it caused some big memory-leakage across big projects, so it has been replaced with one that uses less maps."),(0,r.kt)("p",null,"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)"),(0,r.kt)("h2",{id:"mongodb-version-700-is-now-supported"},"Mongodb version 7.0.0 is now supported"),(0,r.kt)("p",null,"Mongob version ",(0,r.kt)("inlineCode",{parentName:"p"},"7.0.0")," removed storage engine ",(0,r.kt)("inlineCode",{parentName:"p"},"ephemeralForTest"),", with mongodb-memory-server 9.0.0 storage engine ",(0,r.kt)("inlineCode",{parentName:"p"},"wiredTiger")," is the default for binary versions ",(0,r.kt)("inlineCode",{parentName:"p"},"7.0.0")," and higher.\nOlder versions (before ",(0,r.kt)("inlineCode",{parentName:"p"},"7.0.0"),") will still continue to use ",(0,r.kt)("inlineCode",{parentName:"p"},"ephemeralForTest")," by default."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"The version used for the decision is the version provided via the resolved ",(0,r.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#version"},(0,r.kt)("inlineCode",{parentName:"a"},"VERSION"))," config option.",(0,r.kt)("br",{parentName:"p"}),"\n","This mean it needs to match the version the system binary is (a warning is printed if they are not the same)."),(0,r.kt)("p",{parentName:"admonition"},"If the option is unset, the default version will be used, which is likely not correct for the system binary."),(0,r.kt)("p",{parentName:"admonition"},"If the decision should not be automatic, the storage engine can be explicitly defined as a instance option.")),(0,r.kt)("p",null,"It is recommended to run those instances with a db path which is equivalent to ",(0,r.kt)("a",{parentName:"p",href:"https://wiki.archlinux.org/title/tmpfs"},(0,r.kt)("inlineCode",{parentName:"a"},"tmpfs")),"."))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/12f3979d.7ea1d274.js b/assets/js/12f3979d.7ea1d274.js new file mode 100644 index 000000000..941083a53 --- /dev/null +++ b/assets/js/12f3979d.7ea1d274.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[244],{5680:function(e,n,o){o.d(n,{xA:function(){return p},yg:function(){return y}});var a=o(6540);function r(e,n,o){return n in e?Object.defineProperty(e,n,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[n]=o,e}function i(e,n){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),o.push.apply(o,a)}return o}function t(e){for(var n=1;n=0||(r[o]=e[o]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}var s=a.createContext({}),d=function(e){var n=a.useContext(s),o=n;return e&&(o="function"==typeof e?e(n):t(t({},n),e)),o},p=function(e){var n=d(e.components);return a.createElement(s.Provider,{value:n},e.children)},g="mdxType",m={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var o=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),g=d(o),u=r,y=g["".concat(s,".").concat(u)]||g[u]||m[u]||i;return o?a.createElement(y,t(t({ref:n},p),{},{components:o})):a.createElement(y,t({ref:n},p))}));function y(e,n){var o=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=o.length,t=new Array(i);t[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[g]="string"==typeof e?e:r,t[1]=l;for(var d=2;d14",id:"minimal-nodejs-version-is-now-14",level:3},{value:"Mongodb Driver Version upgraded to 5.x",id:"mongodb-driver-version-upgraded-to-5x",level:3},{value:"Default binary version is now 6.x",id:"default-binary-version-is-now-6x",level:3},{value:"Removed platform translations",id:"removed-platform-translations",level:3},{value:"Removed architectures",id:"removed-architectures",level:3},{value:"MongoMemoryServer instance.auth option is now ignored",id:"mongomemoryserver-instanceauth-option-is-now-ignored",level:3},{value:"AutomaticAuth changes",id:"automaticauth-changes",level:3},{value:"MongoMemoryServer and MongoReplSet .cleanup(boolean) and .stop(boolean) have been removed",id:"mongomemoryserver-and-mongoreplset-cleanupboolean-and-stopboolean-have-been-removed",level:3},{value:"MD5_CHECK is now enabled by default",id:"md5_check-is-now-enabled-by-default",level:3},{value:"Merged Error types",id:"merged-error-types",level:3},{value:"Removed Storage engine devnull and mmapv1",id:"removed-storage-engine-devnull-and-mmapv1",level:3},{value:"Linux fallback binary has been removed",id:"linux-fallback-binary-has-been-removed",level:3},{value:"Ubuntu fallback year has been updated",id:"ubuntu-fallback-year-has-been-updated",level:3},{value:"Non-Breaking changes / Additions",id:"non-breaking-changes--additions",level:2},{value:"Compiler target is now es2019",id:"compiler-target-is-now-es2019",level:3},{value:"Crypto function have been changed to use nodejs internals",id:"crypto-function-have-been-changed-to-use-nodejs-internals",level:2},{value:"Binary childprocess is now also .unref()",id:"binary-childprocess-is-now-also-unref",level:2},{value:"The port testing package has been replaced",id:"the-port-testing-package-has-been-replaced",level:2},{value:"Mongodb version 7.0.0 is now supported",id:"mongodb-version-700-is-now-supported",level:2}],m={toc:g},u="wrapper";function y(e){var n=e.components,o=(0,r.A)(e,t);return(0,i.yg)(u,(0,a.A)({},m,o,{components:n,mdxType:"MDXLayout"}),(0,i.yg)("p",null,"Here are the Important changes made for 9.0.0"),(0,i.yg)("admonition",{title:"Important, Read this first",type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"This Guide is written for migration from version ",(0,i.yg)("inlineCode",{parentName:"p"},"8.16.0")," to ",(0,i.yg)("inlineCode",{parentName:"p"},"9.0.0"),", for versions ",(0,i.yg)("inlineCode",{parentName:"p"},">9.0.0 <10.0.0"),", please consult the ",(0,i.yg)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md"},"CHANGELOG"))),(0,i.yg)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,i.yg)("h3",{id:"minimal-nodejs-version-is-now-14"},"Minimal NodeJS version is now ",(0,i.yg)("inlineCode",{parentName:"h3"},"14")),(0,i.yg)("p",null,"With 9.0.0 the minimal nodejs required is ",(0,i.yg)("inlineCode",{parentName:"p"},"14.20.1"),"."),(0,i.yg)("h3",{id:"mongodb-driver-version-upgraded-to-5x"},"Mongodb Driver Version upgraded to 5.x"),(0,i.yg)("p",null,"The used MongoDB Driver version is now ",(0,i.yg)("inlineCode",{parentName:"p"},"5.9.0"),"."),(0,i.yg)("h3",{id:"default-binary-version-is-now-6x"},"Default binary version is now 6.x"),(0,i.yg)("p",null,"The default binary version has been upgraded from ",(0,i.yg)("inlineCode",{parentName:"p"},"5.0.x")," to ",(0,i.yg)("inlineCode",{parentName:"p"},"6.0.x"),". For more specifics see ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/guides/mongodb-server-versions"},"mongodb-server-versions"),"."),(0,i.yg)("h3",{id:"removed-platform-translations"},"Removed platform translations"),(0,i.yg)("p",null,"Some platform translations have been removed, because they are either not needed anymore or werent properly supported in the first place:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"sunos")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"linux")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"elementary OS")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"linux"))),(0,i.yg)("h3",{id:"removed-architectures"},"Removed architectures"),(0,i.yg)("p",null,"Some architectures were removed because they were not being build by mongodb anymore and support in mongodb-memory-server has been largely untested:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"ia32")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"i686")," / ",(0,i.yg)("inlineCode",{parentName:"li"},"i386"))),(0,i.yg)("h3",{id:"mongomemoryserver-instanceauth-option-is-now-ignored"},"MongoMemoryServer ",(0,i.yg)("inlineCode",{parentName:"h3"},"instance.auth")," option is now ignored"),(0,i.yg)("p",null,"With 9.0.0 the option ",(0,i.yg)("inlineCode",{parentName:"p"},"instance.auth")," option is going to be ignored, because its set via the (top-level) ",(0,i.yg)("inlineCode",{parentName:"p"},"auth")," option directly."),(0,i.yg)("p",null,"Example:"),(0,i.yg)("p",null,(0,i.yg)("inlineCode",{parentName:"p"},"new MongoMemoryServer({ instance: { auth: true } })")," is going to be ignored, use ",(0,i.yg)("inlineCode",{parentName:"p"},"new MongoMemoryServer({ auth: { enable: true } })")),(0,i.yg)("h3",{id:"automaticauth-changes"},(0,i.yg)("inlineCode",{parentName:"h3"},"AutomaticAuth")," changes"),(0,i.yg)("p",null,(0,i.yg)("inlineCode",{parentName:"p"},"AutomaticAuth")," has been changed to ",(0,i.yg)("strong",{parentName:"p"},"not")," be enabled anymore by just having a empty object. Also property ",(0,i.yg)("inlineCode",{parentName:"p"},"disable")," has been removed and ",(0,i.yg)("inlineCode",{parentName:"p"},"enable")," has been added."),(0,i.yg)("p",null,"Replace ",(0,i.yg)("inlineCode",{parentName:"p"},"auth: {}")," with ",(0,i.yg)("inlineCode",{parentName:"p"},"auth: { enable: true }"),".",(0,i.yg)("br",{parentName:"p"}),"\n","Replace ",(0,i.yg)("inlineCode",{parentName:"p"},"auth: { disable: true }")," with ",(0,i.yg)("inlineCode",{parentName:"p"},"auth: { enable: false }"),".",(0,i.yg)("br",{parentName:"p"}),"\n","Replace ",(0,i.yg)("inlineCode",{parentName:"p"},"auth: { disable: false }")," with ",(0,i.yg)("inlineCode",{parentName:"p"},"auth: { enable: true }"),". "),(0,i.yg)("h3",{id:"mongomemoryserver-and-mongoreplset-cleanupboolean-and-stopboolean-have-been-removed"},"MongoMemoryServer and MongoReplSet ",(0,i.yg)("inlineCode",{parentName:"h3"},".cleanup(boolean)")," and ",(0,i.yg)("inlineCode",{parentName:"h3"},".stop(boolean)")," have been removed"),(0,i.yg)("p",null,"Previously ",(0,i.yg)("inlineCode",{parentName:"p"},"boolean")," was the only option for the ",(0,i.yg)("inlineCode",{parentName:"p"},".cleanup")," and ",(0,i.yg)("inlineCode",{parentName:"p"},".stop")," function, but they behaved differently between those 2 function and were replaced with ",(0,i.yg)("inlineCode",{parentName:"p"},"Cleanup")," object-options and now have been completely removed."),(0,i.yg)("p",null,"Replace ",(0,i.yg)("inlineCode",{parentName:"p"},".stop(true)")," with ",(0,i.yg)("inlineCode",{parentName:"p"},".stop({ doCleanup: true })"),".",(0,i.yg)("br",{parentName:"p"}),"\n","Replace ",(0,i.yg)("inlineCode",{parentName:"p"},".cleanup(true)")," with ",(0,i.yg)("inlineCode",{parentName:"p"},".stop({ doCleanup: true, force: true })"),". "),(0,i.yg)("p",null,"Default is still for both ",(0,i.yg)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }"),"."),(0,i.yg)("h3",{id:"md5_check-is-now-enabled-by-default"},(0,i.yg)("inlineCode",{parentName:"h3"},"MD5_CHECK")," is now enabled by default"),(0,i.yg)("p",null,"The config option ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#md5_check"},(0,i.yg)("inlineCode",{parentName:"a"},"MD5_CHECK"))," has been enabled by default now, resulting in always comparing the downloaded archive with a md5 after a download."),(0,i.yg)("h3",{id:"merged-error-types"},"Merged Error types"),(0,i.yg)("p",null,"Some error classes have been merged:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"EnsureInstanceError")," & ",(0,i.yg)("inlineCode",{parentName:"li"},"InstanceInfoError")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"InstanceInfoError")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"NoSystemBinaryFoundError")," & ",(0,i.yg)("inlineCode",{parentName:"li"},"BinaryNotFoundError")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"BinaryNotFoundError"))),(0,i.yg)("h3",{id:"removed-storage-engine-devnull-and-mmapv1"},"Removed Storage engine ",(0,i.yg)("inlineCode",{parentName:"h3"},"devnull")," and ",(0,i.yg)("inlineCode",{parentName:"h3"},"mmapv1")),(0,i.yg)("p",null,"Storage Engines ",(0,i.yg)("inlineCode",{parentName:"p"},"devnull")," and ",(0,i.yg)("inlineCode",{parentName:"p"},"mmapv1")," have been removed because they are not supported in newer versions of mongodb anymore, ",(0,i.yg)("inlineCode",{parentName:"p"},"wiredTiger")," should be used instead."),(0,i.yg)("h3",{id:"linux-fallback-binary-has-been-removed"},"Linux fallback binary has been removed"),(0,i.yg)("p",null,"Previously there was a code-path for a fallback linux binary, but this has been removed because mongodb has stopped shipping generic linux binaries since versions after 4.0."),(0,i.yg)("p",null,"If a fallback is still required, try to use the ubuntu binary via ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#distro"},"Config Options ",(0,i.yg)("inlineCode",{parentName:"a"},"DISTRO")),"."),(0,i.yg)("h3",{id:"ubuntu-fallback-year-has-been-updated"},"Ubuntu fallback year has been updated"),(0,i.yg)("p",null,"The ubuntu fallback year has been updated to ",(0,i.yg)("inlineCode",{parentName:"p"},"22"),", instead of the previous ",(0,i.yg)("inlineCode",{parentName:"p"},"14"),", because newer versions of mongodb dont ship for any EOL ubuntu version anymore."),(0,i.yg)("p",null,"This fallback is only used if the ubuntu year could not be parsed from the os-file.",(0,i.yg)("br",{parentName:"p"}),"\n","This can also be overwritten with ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#distro"},"Config Option ",(0,i.yg)("inlineCode",{parentName:"a"},"DISTRO")),"."),(0,i.yg)("h2",{id:"non-breaking-changes--additions"},"Non-Breaking changes / Additions"),(0,i.yg)("h3",{id:"compiler-target-is-now-es2019"},"Compiler target is now ",(0,i.yg)("inlineCode",{parentName:"h3"},"es2019")),(0,i.yg)("p",null,"The tsconfig ",(0,i.yg)("inlineCode",{parentName:"p"},"target")," option has been updated to ",(0,i.yg)("inlineCode",{parentName:"p"},"es2019"),", which will result in less polyfills.\nThis should be a non-breaking change"),(0,i.yg)("h2",{id:"crypto-function-have-been-changed-to-use-nodejs-internals"},"Crypto function have been changed to use nodejs internals"),(0,i.yg)("p",null,"Crypto functions like for the md5 check and uuidv4 generation have been moved to use the ",(0,i.yg)("inlineCode",{parentName:"p"},"node:crypto")," support, resulting in dropping 2 dependencies."),(0,i.yg)("p",null,"Dropped dependencies are ",(0,i.yg)("inlineCode",{parentName:"p"},"md5-file")," and ",(0,i.yg)("inlineCode",{parentName:"p"},"uuid"),"."),(0,i.yg)("h2",{id:"binary-childprocess-is-now-also-unref"},"Binary childprocess is now also ",(0,i.yg)("inlineCode",{parentName:"h2"},".unref()")),(0,i.yg)("p",null,"The Mongodb Binary childprocess is now also ",(0,i.yg)("inlineCode",{parentName:"p"},".unref()"),", like the killer process has been for some time."),(0,i.yg)("p",null,"This ",(0,i.yg)("em",{parentName:"p"},"should")," help with non-closed instances not exiting the nodejs process."),(0,i.yg)("h2",{id:"the-port-testing-package-has-been-replaced"},"The port testing package has been replaced"),(0,i.yg)("p",null,"Previously MMS used ",(0,i.yg)("inlineCode",{parentName:"p"},"get-port"),", but it caused some big memory-leakage across big projects, so it has been replaced with one that uses less maps."),(0,i.yg)("p",null,"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)"),(0,i.yg)("h2",{id:"mongodb-version-700-is-now-supported"},"Mongodb version 7.0.0 is now supported"),(0,i.yg)("p",null,"Mongob version ",(0,i.yg)("inlineCode",{parentName:"p"},"7.0.0")," removed storage engine ",(0,i.yg)("inlineCode",{parentName:"p"},"ephemeralForTest"),", with mongodb-memory-server 9.0.0 storage engine ",(0,i.yg)("inlineCode",{parentName:"p"},"wiredTiger")," is the default for binary versions ",(0,i.yg)("inlineCode",{parentName:"p"},"7.0.0")," and higher.\nOlder versions (before ",(0,i.yg)("inlineCode",{parentName:"p"},"7.0.0"),") will still continue to use ",(0,i.yg)("inlineCode",{parentName:"p"},"ephemeralForTest")," by default."),(0,i.yg)("admonition",{type:"info"},(0,i.yg)("p",{parentName:"admonition"},"The version used for the decision is the version provided via the resolved ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#version"},(0,i.yg)("inlineCode",{parentName:"a"},"VERSION"))," config option.",(0,i.yg)("br",{parentName:"p"}),"\n","This mean it needs to match the version the system binary is (a warning is printed if they are not the same)."),(0,i.yg)("p",{parentName:"admonition"},"If the option is unset, the default version will be used, which is likely not correct for the system binary."),(0,i.yg)("p",{parentName:"admonition"},"If the decision should not be automatic, the storage engine can be explicitly defined as a instance option.")),(0,i.yg)("p",null,"It is recommended to run those instances with a db path which is equivalent to ",(0,i.yg)("a",{parentName:"p",href:"https://wiki.archlinux.org/title/tmpfs"},(0,i.yg)("inlineCode",{parentName:"a"},"tmpfs")),"."))}y.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/17896441.869ac5de.js b/assets/js/17896441.869ac5de.js new file mode 100644 index 000000000..b26ed0d35 --- /dev/null +++ b/assets/js/17896441.869ac5de.js @@ -0,0 +1 @@ +(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[401],{5680:function(e,t,n){"use strict";n.d(t,{xA:function(){return u},yg:function(){return v}});var a=n(6540);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),s=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},p=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=s(n),p=r,v=d["".concat(c,".").concat(p)]||d[p]||m[p]||o;return n?a.createElement(v,l(l({ref:t},u),{},{components:n})):a.createElement(v,l({ref:t},u))}));function v(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,l=new Array(o);l[0]=p;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:r,l[1]=i;for(var s=2;s0,s=!!(t||n||o);return i||s?a.createElement("footer",{className:(0,u.A)(y.G.docs.docFooter,"docusaurus-mt-lg")},i&&a.createElement(R,{tags:l}),s&&a.createElement(W,{editUrl:t,lastUpdatedAt:n,lastUpdatedBy:o,formattedLastUpdatedAt:r})):null}var F=n(1422),q=n(6342),Y=["parentIndex"];function Z(e){var t=e.map((function(e){return Object.assign({},e,{parentIndex:-1,children:[]})})),n=Array(7).fill(-1);t.forEach((function(e,t){var a=n.slice(2,e.level);e.parentIndex=Math.max.apply(Math,a),n[e.level]=t}));var a=[];return t.forEach((function(e){var n=e.parentIndex,r=(0,H.A)(e,Y);n>=0?t[n].children.push(r):a.push(r)})),a}function $(e){var t=e.toc,n=e.minHeadingLevel,a=e.maxHeadingLevel;return t.flatMap((function(e){var t=$({toc:e.children,minHeadingLevel:n,maxHeadingLevel:a});return function(e){return e.level>=n&&e.level<=a}(e)?[Object.assign({},e,{children:t})]:t}))}function Q(e){var t=e.getBoundingClientRect();return t.top===t.bottom?Q(e.parentNode):t}function X(e,t){var n,a,r=t.anchorTopOffset,o=e.find((function(e){return Q(e).top>=r}));return o?function(e){return e.top>0&&e.bottom0})).map((function(e){return[e-1,[i]]}));return{lineClassNames:Object.fromEntries(c),code:n}}if(void 0===a)return{lineClassNames:{},code:n};for(var s=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return He(["js","jsBlock"],t);case"jsx":case"tsx":return He(["js","jsBlock","jsx"],t);case"html":return He(["js","jsBlock","html"],t);case"python":case"py":case"bash":return He(["bash"],t);case"markdown":case"md":return He(["html","jsx","bash"],t);default:return He(Object.keys(Oe),t)}}(a,r),u=n.split("\n"),d=Object.fromEntries(r.map((function(e){return[e.className,{start:0,range:""}]}))),m=Object.fromEntries(r.filter((function(e){return e.line})).map((function(e){var t=e.className;return[e.line,t]}))),p=Object.fromEntries(r.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.start,t]}))),v=Object.fromEntries(r.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.end,t]}))),f=0;f0&&e[n-1]===t?e:e.concat(t)};function Ze(e,t){var n={};for(var a in e)Object.prototype.hasOwnProperty.call(e,a)&&-1===t.indexOf(a)&&(n[a]=e[a]);return n}var $e=function(e){function t(){for(var t=this,n=[],a=arguments.length;a--;)n[a]=arguments[a];e.apply(this,n),We(this,"getThemeDict",(function(e){if(void 0!==t.themeDict&&e.theme===t.prevTheme&&e.language===t.prevLanguage)return t.themeDict;t.prevTheme=e.theme,t.prevLanguage=e.language;var n=e.theme?function(e,t){var n=e.plain,a=Object.create(null),r=e.styles.reduce((function(e,n){var a=n.languages,r=n.style;return a&&!a.includes(t)||n.types.forEach((function(t){var n=Ge({},e[t],r);e[t]=n})),e}),a);return r.root=n,r.plain=Ge({},n,{backgroundColor:null}),r}(e.theme,e.language):void 0;return t.themeDict=n})),We(this,"getLineProps",(function(e){var n=e.key,a=e.className,r=e.style,o=Ge({},Ze(e,["key","className","style","line"]),{className:"token-line",style:void 0,key:void 0}),l=t.getThemeDict(t.props);return void 0!==l&&(o.style=l.plain),void 0!==r&&(o.style=void 0!==o.style?Ge({},o.style,r):r),void 0!==n&&(o.key=n),a&&(o.className+=" "+a),o})),We(this,"getStyleForToken",(function(e){var n=e.types,a=e.empty,r=n.length,o=t.getThemeDict(t.props);if(void 0!==o){if(1===r&&"plain"===n[0])return a?{display:"inline-block"}:void 0;if(1===r&&!a)return o[n[0]];var l=a?{display:"inline-block"}:{},i=n.map((function(e){return o[e]}));return Object.assign.apply(Object,[l].concat(i))}})),We(this,"getTokenProps",(function(e){var n=e.key,a=e.className,r=e.style,o=e.token,l=Ge({},Ze(e,["key","className","style","token"]),{className:"token "+o.types.join(" "),children:o.content,style:t.getStyleForToken(o),key:void 0});return void 0!==r&&(l.style=void 0!==l.style?Ge({},l.style,r):r),void 0!==n&&(l.key=n),a&&(l.className+=" "+a),l})),We(this,"tokenize",(function(e,t,n,a){var r={code:t,grammar:n,language:a,tokens:[]};e.hooks.run("before-tokenize",r);var o=r.tokens=e.tokenize(r.code,r.grammar,r.language);return e.hooks.run("after-tokenize",r),o}))}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.render=function(){var e=this.props,t=e.Prism,n=e.language,a=e.code,r=e.children,o=this.getThemeDict(this.props),l=t.languages[n];return r({tokens:function(e){for(var t=[[]],n=[e],a=[0],r=[e.length],o=0,l=0,i=[],c=[i];l>-1;){for(;(o=a[l]++)0?u:["plain"],s=d):(u=Ye(u,d.type),d.alias&&(u=Ye(u,d.alias)),s=d.content),"string"==typeof s){var m=s.split(Fe),p=m.length;i.push({types:u,content:m[0]});for(var v=1;v0&&l.getRangeAt(0);a.append(r),r.select(),r.selectionStart=0,r.selectionEnd=e.length;var c=!1;try{c=document.execCommand("copy")}catch(s){}r.remove(),i&&(l.removeAllRanges(),l.addRange(i)),o&&o.focus()}(t),l(!0),i.current=window.setTimeout((function(){l(!1)}),1e3)}),[t]);return(0,a.useEffect)((function(){return function(){return window.clearTimeout(i.current)}}),[]),a.createElement("button",{type:"button","aria-label":o?(0,p.T)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,p.T)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,p.T)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,u.A)("clean-btn",n,tt.copyButton,o&&tt.copyButtonCopied),onClick:c},a.createElement("span",{className:tt.copyButtonIcons,"aria-hidden":"true"},a.createElement(Ke,{className:tt.copyButtonIcon}),a.createElement(et,{className:tt.copyButtonSuccessIcon})))}function at(e){return a.createElement("svg",(0,m.A)({viewBox:"0 0 24 24"},e),a.createElement("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"}))}var rt={wordWrapButtonIcon:"wordWrapButtonIcon_Bwma",wordWrapButtonEnabled:"wordWrapButtonEnabled_EoeP"};function ot(e){var t=e.className,n=e.onClick,r=e.isEnabled,o=(0,p.T)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return a.createElement("button",{type:"button",onClick:n,className:(0,u.A)("clean-btn",t,r&&rt.wordWrapButtonEnabled),"aria-label":o,title:o},a.createElement(at,{className:rt.wordWrapButtonIcon,"aria-hidden":"true"}))}function lt(e){var t,n,r,o,l,i,c,s,d,p,v,f=e.children,h=e.className,g=void 0===h?"":h,b=e.metastring,E=e.title,y=e.showLineNumbers,N=e.language,k=(0,q.p)().prism,A=k.defaultLanguage,C=k.magicComments,L=null!=(t=null!=N?N:null==(n=g.split(" ").find((function(e){return e.startsWith("language-")})))?void 0:n.replace(/language-/,""))?t:A,T=Le(),_=(r=(0,a.useState)(!1),o=r[0],l=r[1],i=(0,a.useState)(!1),c=i[0],s=i[1],d=(0,a.useRef)(null),p=(0,a.useCallback)((function(){var e=d.current.querySelector("code");o?e.removeAttribute("style"):(e.style.whiteSpace="pre-wrap",e.style.overflowWrap="anywhere"),l((function(e){return!e}))}),[d,o]),v=(0,a.useCallback)((function(){var e=d.current,t=e.scrollWidth>e.clientWidth||d.current.querySelector("code").hasAttribute("style");s(t)}),[d]),ze(d,v),(0,a.useEffect)((function(){v()}),[o,v]),(0,a.useEffect)((function(){return window.addEventListener("resize",v,{passive:!0}),function(){window.removeEventListener("resize",v)}}),[v]),{codeBlockRef:d,isEnabled:o,isCodeScrollable:c,toggle:p}),w=function(e){var t,n;return null!=(t=null==e||null==(n=e.match(xe))?void 0:n.groups.title)?t:""}(b)||E,x=je(f,{metastring:b,language:L,magicComments:C}),B=x.lineClassNames,O=x.code,H=null!=y?y:function(e){return Boolean(null==e?void 0:e.includes("showLineNumbers"))}(b);return a.createElement(Ie,{as:"div",className:(0,u.A)(g,L&&!g.includes("language-"+L)&&"language-"+L)},w&&a.createElement("div",{className:Pe.codeBlockTitle},w),a.createElement("div",{className:Pe.codeBlockContent},a.createElement(Qe,(0,m.A)({},Re,{theme:T,code:O,language:null!=L?L:"text"}),(function(e){var t=e.className,n=e.tokens,r=e.getLineProps,o=e.getTokenProps;return a.createElement("pre",{tabIndex:0,ref:_.codeBlockRef,className:(0,u.A)(t,Pe.codeBlock,"thin-scrollbar")},a.createElement("code",{className:(0,u.A)(Pe.codeBlockLines,H&&Pe.codeBlockLinesWithNumbering)},n.map((function(e,t){return a.createElement(Je,{key:t,line:e,getLineProps:r,getTokenProps:o,classNames:B[t],showLineNumbers:H})}))))})),a.createElement("div",{className:Pe.buttonGroup},(_.isEnabled||_.isCodeScrollable)&&a.createElement(ot,{className:Pe.codeButton,onClick:function(){return _.toggle()},isEnabled:_.isEnabled}),a.createElement(nt,{className:Pe.codeButton,code:O}))))}var it=["children"];function ct(e){var t=e.children,n=(0,H.A)(e,it),r=(0,Ae.A)(),o=function(e){return a.Children.toArray(e).some((function(e){return(0,a.isValidElement)(e)}))?e:Array.isArray(e)?e.join(""):e}(t),l="string"==typeof o?lt:Ue;return a.createElement(l,(0,m.A)({key:String(r)},n),o)}var st={details:"details_lb9f",isBrowser:"isBrowser_bmU9",collapsibleContent:"collapsibleContent_i85q"},ut=["summary","children"];function dt(e){return!!e&&("SUMMARY"===e.tagName||dt(e.parentElement))}function mt(e,t){return!!e&&(e===t||mt(e.parentElement,t))}function pt(e){var t=e.summary,n=e.children,r=(0,H.A)(e,ut),o=(0,Ae.A)(),l=(0,a.useRef)(null),i=(0,F.u)({initialState:!r.open}),c=i.collapsed,s=i.setCollapsed,d=(0,a.useState)(r.open),p=d[0],v=d[1],f=a.isValidElement(t)?t:a.createElement("summary",null,null!=t?t:"Details");return a.createElement("details",(0,m.A)({},r,{ref:l,open:p,"data-collapsed":c,className:(0,u.A)(st.details,o&&st.isBrowser,r.className),onMouseDown:function(e){dt(e.target)&&e.detail>1&&e.preventDefault()},onClick:function(e){e.stopPropagation();var t=e.target;dt(t)&&mt(t,l.current)&&(e.preventDefault(),c?(s(!1),v(!0)):s(!0))}}),f,a.createElement(F.N,{lazy:!1,collapsed:c,disableSSRStyle:!0,onCollapseTransitionEnd:function(e){s(e),v(!e)}},a.createElement("div",{className:st.collapsibleContent},n)))}var vt={details:"details_b_Ee"},ft="alert alert--info";function ht(e){var t=Object.assign({},(function(e){if(null==e)throw new TypeError("Cannot destructure "+e)}(e),e));return a.createElement(pt,(0,m.A)({},t,{className:(0,u.A)(ft,vt.details,t.className)}))}function gt(e){return a.createElement(Ee,e)}var bt={containsTaskList:"containsTaskList_mC6p"};function Et(e){if(void 0!==e)return(0,u.A)(e,(null==e?void 0:e.includes("contains-task-list"))&&bt.containsTaskList)}var yt={img:"img_ev3q"};var Nt="admonition_LlT9",kt="admonitionHeading_tbUL",At="admonitionIcon_kALy",Ct="admonitionContent_S0QG";var Lt={note:{infimaClassName:"secondary",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 14 16"},a.createElement("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"}))},label:a.createElement(p.A,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)"},"note")},tip:{infimaClassName:"success",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 12 16"},a.createElement("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"}))},label:a.createElement(p.A,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)"},"tip")},danger:{infimaClassName:"danger",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 12 16"},a.createElement("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"}))},label:a.createElement(p.A,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)"},"danger")},info:{infimaClassName:"info",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 14 16"},a.createElement("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))},label:a.createElement(p.A,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)"},"info")},caution:{infimaClassName:"warning",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 16 16"},a.createElement("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"}))},label:a.createElement(p.A,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)"},"caution")}},Tt={secondary:"note",important:"info",success:"tip",warning:"danger"};function _t(e){var t,n=function(e){var t=a.Children.toArray(e),n=t.find((function(e){var t;return a.isValidElement(e)&&"mdxAdmonitionTitle"===(null==(t=e.props)?void 0:t.mdxType)})),r=a.createElement(a.Fragment,null,t.filter((function(e){return e!==n})));return{mdxAdmonitionTitle:n,rest:r}}(e.children),r=n.mdxAdmonitionTitle,o=n.rest;return Object.assign({},e,{title:null!=(t=e.title)?t:r,children:o})}var wt={head:function(e){var t=a.Children.map(e.children,(function(e){return a.isValidElement(e)?function(e){var t;if(null!=(t=e.props)&&t.mdxType&&e.props.originalType){var n=e.props,r=(n.mdxType,n.originalType,(0,H.A)(n,ke));return a.createElement(e.props.originalType,r)}return e}(e):e}));return a.createElement(Ne.A,e,t)},code:function(e){var t=["a","abbr","b","br","button","cite","code","del","dfn","em","i","img","input","ins","kbd","label","object","output","q","ruby","s","small","span","strong","sub","sup","time","u","var","wbr"];return a.Children.toArray(e.children).every((function(e){var n;return"string"==typeof e&&!e.includes("\n")||(0,a.isValidElement)(e)&&t.includes(null==(n=e.props)?void 0:n.mdxType)}))?a.createElement("code",e):a.createElement(ct,e)},a:function(e){return a.createElement(v.A,e)},pre:function(e){var t;return a.createElement(ct,(0,a.isValidElement)(e.children)&&"code"===(null==(t=e.children.props)?void 0:t.originalType)?e.children.props:Object.assign({},e))},details:function(e){var t=a.Children.toArray(e.children),n=t.find((function(e){var t;return a.isValidElement(e)&&"summary"===(null==(t=e.props)?void 0:t.mdxType)})),r=a.createElement(a.Fragment,null,t.filter((function(e){return e!==n})));return a.createElement(ht,(0,m.A)({},e,{summary:n}),r)},ul:function(e){return a.createElement("ul",(0,m.A)({},e,{className:Et(e.className)}))},img:function(e){return a.createElement("img",(0,m.A)({loading:"lazy"},e,{className:(t=e.className,(0,u.A)(t,yt.img))}));var t},h1:function(e){return a.createElement(gt,(0,m.A)({as:"h1"},e))},h2:function(e){return a.createElement(gt,(0,m.A)({as:"h2"},e))},h3:function(e){return a.createElement(gt,(0,m.A)({as:"h3"},e))},h4:function(e){return a.createElement(gt,(0,m.A)({as:"h4"},e))},h5:function(e){return a.createElement(gt,(0,m.A)({as:"h5"},e))},h6:function(e){return a.createElement(gt,(0,m.A)({as:"h6"},e))},admonition:function(e){var t=_t(e),n=t.children,r=t.type,o=t.title,l=t.icon,i=function(e){var t,n=null!=(t=Tt[e])?t:e,a=Lt[n];return a||(console.warn('No admonition config found for admonition type "'+n+'". Using Info as fallback.'),Lt.info)}(r),c=null!=o?o:i.label,s=i.iconComponent,d=null!=l?l:a.createElement(s,null);return a.createElement("div",{className:(0,u.A)(y.G.common.admonition,y.G.common.admonitionType(e.type),"alert","alert--"+i.infimaClassName,Nt)},a.createElement("div",{className:kt},a.createElement("span",{className:At},d),c),a.createElement("div",{className:Ct},n))},mermaid:n(418).A};function xt(e){var t=e.children;return a.createElement(ye.xA,{components:wt},t)}function Bt(e){var t,n,r,o,l=e.children,i=(t=c(),n=t.metadata,r=t.frontMatter,o=t.contentTitle,r.hide_title||void 0!==o?null:n.title);return a.createElement("div",{className:(0,u.A)(y.G.docs.docMarkdown,"markdown")},i&&a.createElement("header",null,a.createElement(Ee,{as:"h1"},i)),a.createElement(xt,null,l))}var Ot=n(6153),Ht=n(9169),jt=n(6025);function St(e){return a.createElement("svg",(0,m.A)({viewBox:"0 0 24 24"},e),a.createElement("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"}))}var Mt={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function It(){var e=(0,jt.A)("/");return a.createElement("li",{className:"breadcrumbs__item"},a.createElement(v.A,{"aria-label":(0,p.T)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e},a.createElement(St,{className:Mt.breadcrumbHomeIcon})))}var Pt={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function Ut(e){var t=e.children,n=e.href,r="breadcrumbs__link";return e.isLast?a.createElement("span",{className:r,itemProp:"name"},t):n?a.createElement(v.A,{className:r,href:n,itemProp:"item"},a.createElement("span",{itemProp:"name"},t)):a.createElement("span",{className:r},t)}function Vt(e){var t=e.children,n=e.active,r=e.index,o=e.addMicrodata;return a.createElement("li",(0,m.A)({},o&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,u.A)("breadcrumbs__item",{"breadcrumbs__item--active":n})}),t,a.createElement("meta",{itemProp:"position",content:String(r+1)}))}function zt(){var e=(0,Ot.OF)(),t=(0,Ht.Dt)();return e?a.createElement("nav",{className:(0,u.A)(y.G.docs.docBreadcrumbs,Pt.breadcrumbsContainer),"aria-label":(0,p.T)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"})},a.createElement("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList"},t&&a.createElement(It,null),e.map((function(t,n){var r=n===e.length-1;return a.createElement(Vt,{key:n,active:r,index:n,addMicrodata:!!t.href},a.createElement(Ut,{href:t.href,isLast:r},t.label))})))):null}var Dt={docItemContainer:"docItemContainer_Djhp",docItemCol:"docItemCol_VOVn"};function Rt(e){var t,n,r,o,l,i,s=e.children,m=(t=c(),n=t.frontMatter,r=t.toc,o=(0,d.l)(),l=n.hide_table_of_contents,i=!l&&r.length>0,{hidden:l,mobile:i?a.createElement(ue,null):void 0,desktop:!i||"desktop"!==o&&"ssr"!==o?void 0:a.createElement(he,null)});return a.createElement("div",{className:"row"},a.createElement("div",{className:(0,u.A)("col",!m.hidden&&Dt.docItemCol)},a.createElement(_,null),a.createElement("div",{className:Dt.docItemContainer},a.createElement("article",null,a.createElement(zt,null),a.createElement(w,null),m.mobile,a.createElement(Bt,null,s),a.createElement(G,null)),a.createElement(g,null))),m.desktop&&a.createElement("div",{className:"col col--3"},m.desktop))}function Wt(e){var t="docs-doc-id-"+e.content.metadata.unversionedId,n=e.content;return a.createElement(i,{content:e.content},a.createElement(r.e3,{className:t},a.createElement(s,null),a.createElement(Rt,null,a.createElement(n,null))))}},2252:function(e,t,n){"use strict";n.d(t,{n:function(){return l},r:function(){return i}});var a=n(6540),r=n(3807),o=a.createContext(null);function l(e){var t=e.children,n=e.version;return a.createElement(o.Provider,{value:n},t)}function i(){var e=(0,a.useContext)(o);if(null===e)throw new r.dV("DocsVersionProvider");return e}},8426:function(e,t){function n(e){let t,n=[];for(let a of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(a))n.push(parseInt(a,10));else if(t=a.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,a,r,o]=t;if(a&&o){a=parseInt(a),o=parseInt(o);const e=a=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),s=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},p=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=s(n),p=r,v=d["".concat(c,".").concat(p)]||d[p]||m[p]||o;return n?a.createElement(v,l(l({ref:t},u),{},{components:n})):a.createElement(v,l({ref:t},u))}));function v(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,l=new Array(o);l[0]=p;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:r,l[1]=i;for(var s=2;s0,s=!!(t||n||o);return i||s?a.createElement("footer",{className:(0,u.Z)(y.k.docs.docFooter,"docusaurus-mt-lg")},i&&a.createElement(D,{tags:l}),s&&a.createElement(R,{editUrl:t,lastUpdatedAt:n,lastUpdatedBy:o,formattedLastUpdatedAt:r})):null}var F=n(6043),q=n(6668),G=["parentIndex"];function Y(e){var t=e.map((function(e){return Object.assign({},e,{parentIndex:-1,children:[]})})),n=Array(7).fill(-1);t.forEach((function(e,t){var a=n.slice(2,e.level);e.parentIndex=Math.max.apply(Math,a),n[e.level]=t}));var a=[];return t.forEach((function(e){var n=e.parentIndex,r=(0,H.Z)(e,G);n>=0?t[n].children.push(r):a.push(r)})),a}function $(e){var t=e.toc,n=e.minHeadingLevel,a=e.maxHeadingLevel;return t.flatMap((function(e){var t=$({toc:e.children,minHeadingLevel:n,maxHeadingLevel:a});return function(e){return e.level>=n&&e.level<=a}(e)?[Object.assign({},e,{children:t})]:t}))}function J(e){var t=e.getBoundingClientRect();return t.top===t.bottom?J(e.parentNode):t}function Q(e,t){var n,a,r=t.anchorTopOffset,o=e.find((function(e){return J(e).top>=r}));return o?function(e){return e.top>0&&e.bottom0})).map((function(e){return[e-1,[i]]}));return{lineClassNames:Object.fromEntries(c),code:n}}if(void 0===a)return{lineClassNames:{},code:n};for(var s=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return He(["js","jsBlock"],t);case"jsx":case"tsx":return He(["js","jsBlock","jsx"],t);case"html":return He(["js","jsBlock","html"],t);case"python":case"py":case"bash":return He(["bash"],t);case"markdown":case"md":return He(["html","jsx","bash"],t);default:return He(Object.keys(Oe),t)}}(a,r),u=n.split("\n"),d=Object.fromEntries(r.map((function(e){return[e.className,{start:0,range:""}]}))),m=Object.fromEntries(r.filter((function(e){return e.line})).map((function(e){var t=e.className;return[e.line,t]}))),p=Object.fromEntries(r.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.start,t]}))),v=Object.fromEntries(r.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.end,t]}))),f=0;f0&&e[n-1]===t?e:e.concat(t)};function Ye(e,t){var n={};for(var a in e)Object.prototype.hasOwnProperty.call(e,a)&&-1===t.indexOf(a)&&(n[a]=e[a]);return n}var $e=function(e){function t(){for(var t=this,n=[],a=arguments.length;a--;)n[a]=arguments[a];e.apply(this,n),Re(this,"getThemeDict",(function(e){if(void 0!==t.themeDict&&e.theme===t.prevTheme&&e.language===t.prevLanguage)return t.themeDict;t.prevTheme=e.theme,t.prevLanguage=e.language;var n=e.theme?function(e,t){var n=e.plain,a=Object.create(null),r=e.styles.reduce((function(e,n){var a=n.languages,r=n.style;return a&&!a.includes(t)||n.types.forEach((function(t){var n=We({},e[t],r);e[t]=n})),e}),a);return r.root=n,r.plain=We({},n,{backgroundColor:null}),r}(e.theme,e.language):void 0;return t.themeDict=n})),Re(this,"getLineProps",(function(e){var n=e.key,a=e.className,r=e.style,o=We({},Ye(e,["key","className","style","line"]),{className:"token-line",style:void 0,key:void 0}),l=t.getThemeDict(t.props);return void 0!==l&&(o.style=l.plain),void 0!==r&&(o.style=void 0!==o.style?We({},o.style,r):r),void 0!==n&&(o.key=n),a&&(o.className+=" "+a),o})),Re(this,"getStyleForToken",(function(e){var n=e.types,a=e.empty,r=n.length,o=t.getThemeDict(t.props);if(void 0!==o){if(1===r&&"plain"===n[0])return a?{display:"inline-block"}:void 0;if(1===r&&!a)return o[n[0]];var l=a?{display:"inline-block"}:{},i=n.map((function(e){return o[e]}));return Object.assign.apply(Object,[l].concat(i))}})),Re(this,"getTokenProps",(function(e){var n=e.key,a=e.className,r=e.style,o=e.token,l=We({},Ye(e,["key","className","style","token"]),{className:"token "+o.types.join(" "),children:o.content,style:t.getStyleForToken(o),key:void 0});return void 0!==r&&(l.style=void 0!==l.style?We({},l.style,r):r),void 0!==n&&(l.key=n),a&&(l.className+=" "+a),l})),Re(this,"tokenize",(function(e,t,n,a){var r={code:t,grammar:n,language:a,tokens:[]};e.hooks.run("before-tokenize",r);var o=r.tokens=e.tokenize(r.code,r.grammar,r.language);return e.hooks.run("after-tokenize",r),o}))}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.render=function(){var e=this.props,t=e.Prism,n=e.language,a=e.code,r=e.children,o=this.getThemeDict(this.props),l=t.languages[n];return r({tokens:function(e){for(var t=[[]],n=[e],a=[0],r=[e.length],o=0,l=0,i=[],c=[i];l>-1;){for(;(o=a[l]++)0?u:["plain"],s=d):(u=Ge(u,d.type),d.alias&&(u=Ge(u,d.alias)),s=d.content),"string"==typeof s){var m=s.split(Fe),p=m.length;i.push({types:u,content:m[0]});for(var v=1;v0&&l.getRangeAt(0);a.append(r),r.select(),r.selectionStart=0,r.selectionEnd=e.length;var c=!1;try{c=document.execCommand("copy")}catch(s){}r.remove(),i&&(l.removeAllRanges(),l.addRange(i)),o&&o.focus()}(t),l(!0),i.current=window.setTimeout((function(){l(!1)}),1e3)}),[t]);return(0,a.useEffect)((function(){return function(){return window.clearTimeout(i.current)}}),[]),a.createElement("button",{type:"button","aria-label":o?(0,p.I)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,p.I)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,p.I)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,u.Z)("clean-btn",n,tt.copyButton,o&&tt.copyButtonCopied),onClick:c},a.createElement("span",{className:tt.copyButtonIcons,"aria-hidden":"true"},a.createElement(Ke,{className:tt.copyButtonIcon}),a.createElement(et,{className:tt.copyButtonSuccessIcon})))}function at(e){return a.createElement("svg",(0,m.Z)({viewBox:"0 0 24 24"},e),a.createElement("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"}))}var rt={wordWrapButtonIcon:"wordWrapButtonIcon_Bwma",wordWrapButtonEnabled:"wordWrapButtonEnabled_EoeP"};function ot(e){var t=e.className,n=e.onClick,r=e.isEnabled,o=(0,p.I)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return a.createElement("button",{type:"button",onClick:n,className:(0,u.Z)("clean-btn",t,r&&rt.wordWrapButtonEnabled),"aria-label":o,title:o},a.createElement(at,{className:rt.wordWrapButtonIcon,"aria-hidden":"true"}))}function lt(e){var t,n,r,o,l,i,c,s,d,p,v,f=e.children,h=e.className,g=void 0===h?"":h,b=e.metastring,E=e.title,y=e.showLineNumbers,k=e.language,N=(0,q.L)().prism,C=N.defaultLanguage,L=N.magicComments,Z=null!=(t=null!=k?k:null==(n=g.split(" ").find((function(e){return e.startsWith("language-")})))?void 0:n.replace(/language-/,""))?t:C,T=Ze(),_=(r=(0,a.useState)(!1),o=r[0],l=r[1],i=(0,a.useState)(!1),c=i[0],s=i[1],d=(0,a.useRef)(null),p=(0,a.useCallback)((function(){var e=d.current.querySelector("code");o?e.removeAttribute("style"):(e.style.whiteSpace="pre-wrap",e.style.overflowWrap="anywhere"),l((function(e){return!e}))}),[d,o]),v=(0,a.useCallback)((function(){var e=d.current,t=e.scrollWidth>e.clientWidth||d.current.querySelector("code").hasAttribute("style");s(t)}),[d]),ze(d,v),(0,a.useEffect)((function(){v()}),[o,v]),(0,a.useEffect)((function(){return window.addEventListener("resize",v,{passive:!0}),function(){window.removeEventListener("resize",v)}}),[v]),{codeBlockRef:d,isEnabled:o,isCodeScrollable:c,toggle:p}),w=function(e){var t,n;return null!=(t=null==e||null==(n=e.match(xe))?void 0:n.groups.title)?t:""}(b)||E,x=je(f,{metastring:b,language:Z,magicComments:L}),B=x.lineClassNames,O=x.code,H=null!=y?y:function(e){return Boolean(null==e?void 0:e.includes("showLineNumbers"))}(b);return a.createElement(Se,{as:"div",className:(0,u.Z)(g,Z&&!g.includes("language-"+Z)&&"language-"+Z)},w&&a.createElement("div",{className:Me.codeBlockTitle},w),a.createElement("div",{className:Me.codeBlockContent},a.createElement(Je,(0,m.Z)({},De,{theme:T,code:O,language:null!=Z?Z:"text"}),(function(e){var t=e.className,n=e.tokens,r=e.getLineProps,o=e.getTokenProps;return a.createElement("pre",{tabIndex:0,ref:_.codeBlockRef,className:(0,u.Z)(t,Me.codeBlock,"thin-scrollbar")},a.createElement("code",{className:(0,u.Z)(Me.codeBlockLines,H&&Me.codeBlockLinesWithNumbering)},n.map((function(e,t){return a.createElement(Xe,{key:t,line:e,getLineProps:r,getTokenProps:o,classNames:B[t],showLineNumbers:H})}))))})),a.createElement("div",{className:Me.buttonGroup},(_.isEnabled||_.isCodeScrollable)&&a.createElement(ot,{className:Me.codeButton,onClick:function(){return _.toggle()},isEnabled:_.isEnabled}),a.createElement(nt,{className:Me.codeButton,code:O}))))}var it=["children"];function ct(e){var t=e.children,n=(0,H.Z)(e,it),r=(0,Ce.Z)(),o=function(e){return a.Children.toArray(e).some((function(e){return(0,a.isValidElement)(e)}))?e:Array.isArray(e)?e.join(""):e}(t),l="string"==typeof o?lt:Pe;return a.createElement(l,(0,m.Z)({key:String(r)},n),o)}var st={details:"details_lb9f",isBrowser:"isBrowser_bmU9",collapsibleContent:"collapsibleContent_i85q"},ut=["summary","children"];function dt(e){return!!e&&("SUMMARY"===e.tagName||dt(e.parentElement))}function mt(e,t){return!!e&&(e===t||mt(e.parentElement,t))}function pt(e){var t=e.summary,n=e.children,r=(0,H.Z)(e,ut),o=(0,Ce.Z)(),l=(0,a.useRef)(null),i=(0,F.u)({initialState:!r.open}),c=i.collapsed,s=i.setCollapsed,d=(0,a.useState)(r.open),p=d[0],v=d[1],f=a.isValidElement(t)?t:a.createElement("summary",null,null!=t?t:"Details");return a.createElement("details",(0,m.Z)({},r,{ref:l,open:p,"data-collapsed":c,className:(0,u.Z)(st.details,o&&st.isBrowser,r.className),onMouseDown:function(e){dt(e.target)&&e.detail>1&&e.preventDefault()},onClick:function(e){e.stopPropagation();var t=e.target;dt(t)&&mt(t,l.current)&&(e.preventDefault(),c?(s(!1),v(!0)):s(!0))}}),f,a.createElement(F.z,{lazy:!1,collapsed:c,disableSSRStyle:!0,onCollapseTransitionEnd:function(e){s(e),v(!e)}},a.createElement("div",{className:st.collapsibleContent},n)))}var vt={details:"details_b_Ee"},ft="alert alert--info";function ht(e){var t=Object.assign({},(function(e){if(null==e)throw new TypeError("Cannot destructure "+e)}(e),e));return a.createElement(pt,(0,m.Z)({},t,{className:(0,u.Z)(ft,vt.details,t.className)}))}function gt(e){return a.createElement(Ee,e)}var bt={containsTaskList:"containsTaskList_mC6p"};function Et(e){if(void 0!==e)return(0,u.Z)(e,(null==e?void 0:e.includes("contains-task-list"))&&bt.containsTaskList)}var yt={img:"img_ev3q"};var kt="admonition_LlT9",Nt="admonitionHeading_tbUL",Ct="admonitionIcon_kALy",Lt="admonitionContent_S0QG";var Zt={note:{infimaClassName:"secondary",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 14 16"},a.createElement("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"}))},label:a.createElement(p.Z,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)"},"note")},tip:{infimaClassName:"success",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 12 16"},a.createElement("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"}))},label:a.createElement(p.Z,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)"},"tip")},danger:{infimaClassName:"danger",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 12 16"},a.createElement("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"}))},label:a.createElement(p.Z,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)"},"danger")},info:{infimaClassName:"info",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 14 16"},a.createElement("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))},label:a.createElement(p.Z,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)"},"info")},caution:{infimaClassName:"warning",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 16 16"},a.createElement("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"}))},label:a.createElement(p.Z,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)"},"caution")}},Tt={secondary:"note",important:"info",success:"tip",warning:"danger"};function _t(e){var t,n=function(e){var t=a.Children.toArray(e),n=t.find((function(e){var t;return a.isValidElement(e)&&"mdxAdmonitionTitle"===(null==(t=e.props)?void 0:t.mdxType)})),r=a.createElement(a.Fragment,null,t.filter((function(e){return e!==n})));return{mdxAdmonitionTitle:n,rest:r}}(e.children),r=n.mdxAdmonitionTitle,o=n.rest;return Object.assign({},e,{title:null!=(t=e.title)?t:r,children:o})}var wt={head:function(e){var t=a.Children.map(e.children,(function(e){return a.isValidElement(e)?function(e){var t;if(null!=(t=e.props)&&t.mdxType&&e.props.originalType){var n=e.props,r=(n.mdxType,n.originalType,(0,H.Z)(n,Ne));return a.createElement(e.props.originalType,r)}return e}(e):e}));return a.createElement(ke.Z,e,t)},code:function(e){var t=["a","abbr","b","br","button","cite","code","del","dfn","em","i","img","input","ins","kbd","label","object","output","q","ruby","s","small","span","strong","sub","sup","time","u","var","wbr"];return a.Children.toArray(e.children).every((function(e){var n;return"string"==typeof e&&!e.includes("\n")||(0,a.isValidElement)(e)&&t.includes(null==(n=e.props)?void 0:n.mdxType)}))?a.createElement("code",e):a.createElement(ct,e)},a:function(e){return a.createElement(v.Z,e)},pre:function(e){var t;return a.createElement(ct,(0,a.isValidElement)(e.children)&&"code"===(null==(t=e.children.props)?void 0:t.originalType)?e.children.props:Object.assign({},e))},details:function(e){var t=a.Children.toArray(e.children),n=t.find((function(e){var t;return a.isValidElement(e)&&"summary"===(null==(t=e.props)?void 0:t.mdxType)})),r=a.createElement(a.Fragment,null,t.filter((function(e){return e!==n})));return a.createElement(ht,(0,m.Z)({},e,{summary:n}),r)},ul:function(e){return a.createElement("ul",(0,m.Z)({},e,{className:Et(e.className)}))},img:function(e){return a.createElement("img",(0,m.Z)({loading:"lazy"},e,{className:(t=e.className,(0,u.Z)(t,yt.img))}));var t},h1:function(e){return a.createElement(gt,(0,m.Z)({as:"h1"},e))},h2:function(e){return a.createElement(gt,(0,m.Z)({as:"h2"},e))},h3:function(e){return a.createElement(gt,(0,m.Z)({as:"h3"},e))},h4:function(e){return a.createElement(gt,(0,m.Z)({as:"h4"},e))},h5:function(e){return a.createElement(gt,(0,m.Z)({as:"h5"},e))},h6:function(e){return a.createElement(gt,(0,m.Z)({as:"h6"},e))},admonition:function(e){var t=_t(e),n=t.children,r=t.type,o=t.title,l=t.icon,i=function(e){var t,n=null!=(t=Tt[e])?t:e,a=Zt[n];return a||(console.warn('No admonition config found for admonition type "'+n+'". Using Info as fallback.'),Zt.info)}(r),c=null!=o?o:i.label,s=i.iconComponent,d=null!=l?l:a.createElement(s,null);return a.createElement("div",{className:(0,u.Z)(y.k.common.admonition,y.k.common.admonitionType(e.type),"alert","alert--"+i.infimaClassName,kt)},a.createElement("div",{className:Nt},a.createElement("span",{className:Ct},d),c),a.createElement("div",{className:Lt},n))},mermaid:n(1875).Z};function xt(e){var t=e.children;return a.createElement(ye.Zo,{components:wt},t)}function Bt(e){var t,n,r,o,l=e.children,i=(t=c(),n=t.metadata,r=t.frontMatter,o=t.contentTitle,r.hide_title||void 0!==o?null:n.title);return a.createElement("div",{className:(0,u.Z)(y.k.docs.docMarkdown,"markdown")},i&&a.createElement("header",null,a.createElement(Ee,{as:"h1"},i)),a.createElement(xt,null,l))}var Ot=n(3791),Ht=n(8596),jt=n(4996);function At(e){return a.createElement("svg",(0,m.Z)({viewBox:"0 0 24 24"},e),a.createElement("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"}))}var It={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function St(){var e=(0,jt.Z)("/");return a.createElement("li",{className:"breadcrumbs__item"},a.createElement(v.Z,{"aria-label":(0,p.I)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e},a.createElement(At,{className:It.breadcrumbHomeIcon})))}var Mt={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function Pt(e){var t=e.children,n=e.href,r="breadcrumbs__link";return e.isLast?a.createElement("span",{className:r,itemProp:"name"},t):n?a.createElement(v.Z,{className:r,href:n,itemProp:"item"},a.createElement("span",{itemProp:"name"},t)):a.createElement("span",{className:r},t)}function Ut(e){var t=e.children,n=e.active,r=e.index,o=e.addMicrodata;return a.createElement("li",(0,m.Z)({},o&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,u.Z)("breadcrumbs__item",{"breadcrumbs__item--active":n})}),t,a.createElement("meta",{itemProp:"position",content:String(r+1)}))}function zt(){var e=(0,Ot.s1)(),t=(0,Ht.Ns)();return e?a.createElement("nav",{className:(0,u.Z)(y.k.docs.docBreadcrumbs,Mt.breadcrumbsContainer),"aria-label":(0,p.I)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"})},a.createElement("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList"},t&&a.createElement(St,null),e.map((function(t,n){var r=n===e.length-1;return a.createElement(Ut,{key:n,active:r,index:n,addMicrodata:!!t.href},a.createElement(Pt,{href:t.href,isLast:r},t.label))})))):null}var Vt={docItemContainer:"docItemContainer_Djhp",docItemCol:"docItemCol_VOVn"};function Dt(e){var t,n,r,o,l,i,s=e.children,m=(t=c(),n=t.frontMatter,r=t.toc,o=(0,d.i)(),l=n.hide_table_of_contents,i=!l&&r.length>0,{hidden:l,mobile:i?a.createElement(ue,null):void 0,desktop:!i||"desktop"!==o&&"ssr"!==o?void 0:a.createElement(he,null)});return a.createElement("div",{className:"row"},a.createElement("div",{className:(0,u.Z)("col",!m.hidden&&Vt.docItemCol)},a.createElement(_,null),a.createElement("div",{className:Vt.docItemContainer},a.createElement("article",null,a.createElement(zt,null),a.createElement(w,null),m.mobile,a.createElement(Bt,null,s),a.createElement(W,null)),a.createElement(g,null))),m.desktop&&a.createElement("div",{className:"col col--3"},m.desktop))}function Rt(e){var t="docs-doc-id-"+e.content.metadata.unversionedId,n=e.content;return a.createElement(i,{content:e.content},a.createElement(r.FG,{className:t},a.createElement(s,null),a.createElement(Dt,null,a.createElement(n,null))))}},4477:function(e,t,n){"use strict";n.d(t,{E:function(){return i},q:function(){return l}});var a=n(7294),r=n(9688),o=a.createContext(null);function l(e){var t=e.children,n=e.version;return a.createElement(o.Provider,{value:n},t)}function i(){var e=(0,a.useContext)(o);if(null===e)throw new r.i6("DocsVersionProvider");return e}},7594:function(e,t){function n(e){let t,n=[];for(let a of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(a))n.push(parseInt(a,10));else if(t=a.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,a,r,o]=t;if(a&&o){a=parseInt(a),o=parseInt(o);const e=a=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},d=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},m=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=p(t),m=a,g=c["".concat(l,".").concat(m)]||c[m]||u[m]||o;return t?r.createElement(g,i(i({ref:n},d),{},{components:t})):r.createElement(g,i({ref:n},d))}));function g(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,i=new Array(o);i[0]=m;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[c]="string"==typeof e?e:a,i[1]=s;for(var p=2;p)")),(0,o.kt)("p",null,"Create an new Instance without starting it"),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"When directly starting the instance, ",(0,o.kt)("a",{parentName:"p",href:"#static-run"},(0,o.kt)("inlineCode",{parentName:"a"},"run"))," should be used")),(0,o.kt)("h3",{id:"debug"},"debug"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"private debug(msg: string): void")),(0,o.kt)("p",null,"Format input with debug-message template"),(0,o.kt)("h3",{id:"create"},"create"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"static async create(opts: Partial): Promise")),(0,o.kt)("p",null,"Create an new Instance and start it (while being an Promise)"),(0,o.kt)("h3",{id:"preparecommandargs"},"prepareCommandArgs"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"prepareCommandArgs(): string[]")),(0,o.kt)("p",null,"Constructs the Command Arguments"),(0,o.kt)("h3",{id:"start"},"start"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"async start(): Promise")),(0,o.kt)("p",null,"Start the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," and the watcher processes"),(0,o.kt)("admonition",{type:"caution"},(0,o.kt)("p",{parentName:"admonition"},"Currently does not check if the instance is in a correct state and just resets all values, see ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/issues/662"},"#662"),".")),(0,o.kt)("h3",{id:"stop"},"stop"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"async stop(): Promise")),(0,o.kt)("p",null,"Stop the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," and the watcher processes"),(0,o.kt)("admonition",{type:"caution"},(0,o.kt)("p",{parentName:"admonition"},"Will not Error if instance is not running")),(0,o.kt)("h3",{id:"_launchmongod"},"_launchMongod"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"_launchMongod(mongoBin: string): ChildProcess")),(0,o.kt)("p",null,"Actually spawn the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," process with ",(0,o.kt)("inlineCode",{parentName:"p"},"ChildProcess"),", used by ",(0,o.kt)("a",{parentName:"p",href:"#run"},(0,o.kt)("inlineCode",{parentName:"a"},"run"))),(0,o.kt)("h3",{id:"_launchkiller"},"_launchKiller"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"_launchKiller(parentPid: number, childPid: number): ChildProcess")),(0,o.kt)("p",null,"Spawn an killer process that keeps watch over the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.kt)("h3",{id:"errorhandler"},"errorHandler"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"errorHandler(err: string): void")),(0,o.kt)("p",null,"Error handler for the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.kt)("h3",{id:"closehandler"},"closeHandler"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"closeHandler(code: number, signal: string): void")),(0,o.kt)("p",null,"Close handler for the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.kt)("h3",{id:"stderrhandler"},"stderrHandler"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"stderrHandler(message: string | Buffer): void")),(0,o.kt)("p",null,"STDERR handler for the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.kt)("h3",{id:"stdouthandler"},"stdoutHandler"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"stdoutHandler(message: string | Buffer): void")),(0,o.kt)("p",null,"STDOUT handler for the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," process",(0,o.kt)("br",{parentName:"p"}),"\n","Matches process output against known formats and raise events"),(0,o.kt)("h2",{id:"values"},"Values"),(0,o.kt)("h3",{id:"instanceopts"},"instanceOpts"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"instanceOpts: MongoInstanceOpts")),(0,o.kt)("p",null,"Stores the Instance Options"),(0,o.kt)("h3",{id:"binaryopts"},"binaryOpts"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"readonly binaryOpts: Readonly")),(0,o.kt)("p",null,"Stores the Binary Options"),(0,o.kt)("h3",{id:"spawnopts"},"spawnOpts"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"readonly spawnOpts: Readonly")),(0,o.kt)("p",null,"Stores the Spawn Options"),(0,o.kt)("h3",{id:"extraconnectionoptions"},"extraConnectionOptions"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"extraConnectionOptions?: MongoClientOptions")),(0,o.kt)("p",null,"Contains extra Connection options used for ",(0,o.kt)("inlineCode",{parentName:"p"},"mongoClient.connect"),", this is mainly used for authentication"),(0,o.kt)("h3",{id:"mongodprocess"},"mongodProcess"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"mongodProcess?: ChildProcess")),(0,o.kt)("p",null,"Stores the active process reference for the ",(0,o.kt)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.kt)("h3",{id:"killerprocess"},"killerProcess"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"killerProcess?: ChildProcess")),(0,o.kt)("p",null,"Stores the active process reference for the killer process"),(0,o.kt)("h3",{id:"isinstanceprimary"},"isInstancePrimary"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"isInstancePrimary: boolean")),(0,o.kt)("p",null,"Stores that the process is an Primary (ReplSet) (event emitted when found in STDOUT)"),(0,o.kt)("h3",{id:"isinstanceready"},"isInstanceReady"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"isInstanceReady: boolean")," (event emitted when found in STDOUT)"),(0,o.kt)("p",null,"Stores that the process is fully started"),(0,o.kt)("h3",{id:"isreplset"},"isReplSet"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"isReplSet: boolean")),(0,o.kt)("p",null,"Stores that the process is in an ReplSet, is ",(0,o.kt)("inlineCode",{parentName:"p"},"true")," when ",(0,o.kt)("a",{parentName:"p",href:"#instanceopts"},(0,o.kt)("inlineCode",{parentName:"a"},"instanceOpts.replSet"))," is defined and truthy"))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1bdfe715.ce84fdc7.js b/assets/js/1bdfe715.ce84fdc7.js new file mode 100644 index 000000000..ee80376b7 --- /dev/null +++ b/assets/js/1bdfe715.ce84fdc7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[890],{5680:function(e,n,t){t.d(n,{xA:function(){return g},yg:function(){return u}});var r=t(6540);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},g=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},y=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,g=s(e,["components","mdxType","originalType","parentName"]),d=p(t),y=a,u=d["".concat(l,".").concat(y)]||d[y]||c[y]||o;return t?r.createElement(u,i(i({ref:n},g),{},{components:t})):r.createElement(u,i({ref:n},g))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,i=new Array(o);i[0]=y;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var p=2;p)")),(0,o.yg)("p",null,"Create an new Instance without starting it"),(0,o.yg)("admonition",{type:"tip"},(0,o.yg)("p",{parentName:"admonition"},"When directly starting the instance, ",(0,o.yg)("a",{parentName:"p",href:"#static-run"},(0,o.yg)("inlineCode",{parentName:"a"},"run"))," should be used")),(0,o.yg)("h3",{id:"debug"},"debug"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"private debug(msg: string): void")),(0,o.yg)("p",null,"Format input with debug-message template"),(0,o.yg)("h3",{id:"create"},"create"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"static async create(opts: Partial): Promise")),(0,o.yg)("p",null,"Create an new Instance and start it (while being an Promise)"),(0,o.yg)("h3",{id:"preparecommandargs"},"prepareCommandArgs"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"prepareCommandArgs(): string[]")),(0,o.yg)("p",null,"Constructs the Command Arguments"),(0,o.yg)("h3",{id:"start"},"start"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"async start(): Promise")),(0,o.yg)("p",null,"Start the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," and the watcher processes"),(0,o.yg)("admonition",{type:"caution"},(0,o.yg)("p",{parentName:"admonition"},"Currently does not check if the instance is in a correct state and just resets all values, see ",(0,o.yg)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/issues/662"},"#662"),".")),(0,o.yg)("h3",{id:"stop"},"stop"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"async stop(): Promise")),(0,o.yg)("p",null,"Stop the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," and the watcher processes"),(0,o.yg)("admonition",{type:"caution"},(0,o.yg)("p",{parentName:"admonition"},"Will not Error if instance is not running")),(0,o.yg)("h3",{id:"_launchmongod"},"_launchMongod"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"_launchMongod(mongoBin: string): ChildProcess")),(0,o.yg)("p",null,"Actually spawn the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," process with ",(0,o.yg)("inlineCode",{parentName:"p"},"ChildProcess"),", used by ",(0,o.yg)("a",{parentName:"p",href:"#run"},(0,o.yg)("inlineCode",{parentName:"a"},"run"))),(0,o.yg)("h3",{id:"_launchkiller"},"_launchKiller"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"_launchKiller(parentPid: number, childPid: number): ChildProcess")),(0,o.yg)("p",null,"Spawn an killer process that keeps watch over the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.yg)("h3",{id:"errorhandler"},"errorHandler"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"errorHandler(err: string): void")),(0,o.yg)("p",null,"Error handler for the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.yg)("h3",{id:"closehandler"},"closeHandler"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"closeHandler(code: number, signal: string): void")),(0,o.yg)("p",null,"Close handler for the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.yg)("h3",{id:"stderrhandler"},"stderrHandler"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"stderrHandler(message: string | Buffer): void")),(0,o.yg)("p",null,"STDERR handler for the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.yg)("h3",{id:"stdouthandler"},"stdoutHandler"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"stdoutHandler(message: string | Buffer): void")),(0,o.yg)("p",null,"STDOUT handler for the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," process",(0,o.yg)("br",{parentName:"p"}),"\n","Matches process output against known formats and raise events"),(0,o.yg)("h2",{id:"values"},"Values"),(0,o.yg)("h3",{id:"instanceopts"},"instanceOpts"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"instanceOpts: MongoInstanceOpts")),(0,o.yg)("p",null,"Stores the Instance Options"),(0,o.yg)("h3",{id:"binaryopts"},"binaryOpts"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"readonly binaryOpts: Readonly")),(0,o.yg)("p",null,"Stores the Binary Options"),(0,o.yg)("h3",{id:"spawnopts"},"spawnOpts"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"readonly spawnOpts: Readonly")),(0,o.yg)("p",null,"Stores the Spawn Options"),(0,o.yg)("h3",{id:"extraconnectionoptions"},"extraConnectionOptions"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"extraConnectionOptions?: MongoClientOptions")),(0,o.yg)("p",null,"Contains extra Connection options used for ",(0,o.yg)("inlineCode",{parentName:"p"},"mongoClient.connect"),", this is mainly used for authentication"),(0,o.yg)("h3",{id:"mongodprocess"},"mongodProcess"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"mongodProcess?: ChildProcess")),(0,o.yg)("p",null,"Stores the active process reference for the ",(0,o.yg)("inlineCode",{parentName:"p"},"mongod")," process"),(0,o.yg)("h3",{id:"killerprocess"},"killerProcess"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"killerProcess?: ChildProcess")),(0,o.yg)("p",null,"Stores the active process reference for the killer process"),(0,o.yg)("h3",{id:"isinstanceprimary"},"isInstancePrimary"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"isInstancePrimary: boolean")),(0,o.yg)("p",null,"Stores that the process is an Primary (ReplSet) (event emitted when found in STDOUT)"),(0,o.yg)("h3",{id:"isinstanceready"},"isInstanceReady"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"isInstanceReady: boolean")," (event emitted when found in STDOUT)"),(0,o.yg)("p",null,"Stores that the process is fully started"),(0,o.yg)("h3",{id:"isreplset"},"isReplSet"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"isReplSet: boolean")),(0,o.yg)("p",null,"Stores that the process is in an ReplSet, is ",(0,o.yg)("inlineCode",{parentName:"p"},"true")," when ",(0,o.yg)("a",{parentName:"p",href:"#instanceopts"},(0,o.yg)("inlineCode",{parentName:"a"},"instanceOpts.replSet"))," is defined and truthy"))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1be78505.540812ce.js b/assets/js/1be78505.540812ce.js deleted file mode 100644 index 8e951c1bd..000000000 --- a/assets/js/1be78505.540812ce.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[514,972],{9963:function(e,t,n){n.r(t),n.d(t,{default:function(){return Ie}});var a=n(7294),r=n(6010),o=n(1944),l=n(5281),i=n(3320),c=n(3791),d=n(4477),s=n(1116),m=n(5163),u=n(5999),b=n(2466),p=n(5936);var v={backToTopButton:"backToTopButton_sjWU",backToTopButtonShow:"backToTopButtonShow_xfvO"};function h(){var e=function(e){var t=e.threshold,n=(0,a.useState)(!1),r=n[0],o=n[1],l=(0,a.useRef)(!1),i=(0,b.Ct)(),c=i.startScroll,d=i.cancelScroll;return(0,b.RF)((function(e,n){var a=e.scrollY,r=null==n?void 0:n.scrollY;r&&(l.current?l.current=!1:a>=r?(d(),o(!1)):a=r?(d(),o(!1)):a=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[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},k="mdxType",s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},N=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),k=d(n),N=r,c=k["".concat(p,".").concat(N)]||k[N]||s[N]||i;return n?a.createElement(c,o(o({ref:t},m),{},{components:n})):a.createElement(c,o({ref:t},m))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=N;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[k]="string"==typeof e?e:r,o[1]=l;for(var d=2;d=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var p=a.createContext({}),l=function(e){var n=a.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},g=function(e){var n=l(e.components);return a.createElement(p.Provider,{value:n},e.children)},y="mdxType",m={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,g=s(e,["components","mdxType","originalType","parentName"]),y=l(t),u=r,c=y["".concat(p,".").concat(u)]||y[u]||m[u]||o;return t?a.createElement(c,i(i({ref:n},g),{},{components:t})):a.createElement(c,i({ref:n},g))}));function c(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var o=t.length,i=new Array(o);i[0]=u;var s={};for(var p in n)hasOwnProperty.call(n,p)&&(s[p]=n[p]);s.originalType=e,s[y]="string"==typeof e?e:r,i[1]=s;for(var l=2;l")),(0,o.yg)("p",null,"Create an new Instance and start it (while being an Promise), uses ",(0,o.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-opts"},(0,o.yg)("inlineCode",{parentName:"a"},"MongoMemoryServerOpts")),"."),(0,o.yg)("h3",{id:"statechange"},"stateChange"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"protected stateChange(newState: MongoMemoryServerStates): void")),(0,o.yg)("p",null,"Used to change the state of the class, uses ",(0,o.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/enums/mongo-memory-server-states"},(0,o.yg)("inlineCode",{parentName:"a"},"MongoMemoryServerStates")," enum"),", it is ",(0,o.yg)("inlineCode",{parentName:"p"},"protected")," to not accidentally use it."),(0,o.yg)("h3",{id:"start"},"start"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"async start(forceSamePort: boolean = false): Promise")),(0,o.yg)("p",null,"Used to start an new Instance or to Re-Start an stopped instance"),(0,o.yg)("p",null,"with ",(0,o.yg)("inlineCode",{parentName:"p"},"forceSamePort")," set to ",(0,o.yg)("inlineCode",{parentName:"p"},"true")," and having ",(0,o.yg)("inlineCode",{parentName:"p"},"instance.port")," set, it will use that port and not generate a new port.",(0,o.yg)("br",{parentName:"p"}),"\n","with ",(0,o.yg)("inlineCode",{parentName:"p"},"forceSamePort")," set to ",(0,o.yg)("inlineCode",{parentName:"p"},"true")," and not having ",(0,o.yg)("inlineCode",{parentName:"p"},"instance.port")," set, it will generate a new free port. "),(0,o.yg)("admonition",{type:"caution"},(0,o.yg)("p",{parentName:"admonition"},"Will Error if instance is already running")),(0,o.yg)("h3",{id:"getnewport"},"getNewPort"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"protected async getNewPort(port?: number): Promise")),(0,o.yg)("p",null,"Finds an new non-locked port, uses ",(0,o.yg)("inlineCode",{parentName:"p"},"port")," if available or as a starting point."),(0,o.yg)("h3",{id:"getstartoptions"},"getStartOptions"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"protected async getStartOptions(forceSamePort: boolean = false): Promise")),(0,o.yg)("p",null,"with ",(0,o.yg)("inlineCode",{parentName:"p"},"forceSamePort")," set to ",(0,o.yg)("inlineCode",{parentName:"p"},"true")," and having ",(0,o.yg)("inlineCode",{parentName:"p"},"instance.port")," set, it will use that port and not generate a new port.",(0,o.yg)("br",{parentName:"p"}),"\n","with ",(0,o.yg)("inlineCode",{parentName:"p"},"forceSamePort")," set to ",(0,o.yg)("inlineCode",{parentName:"p"},"true")," and not having ",(0,o.yg)("inlineCode",{parentName:"p"},"instance.port")," set, it will generate a new free port. "),(0,o.yg)("p",null,"Constructs the Starting Options"),(0,o.yg)("h3",{id:"_startupinstance"},"_startUpInstance"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"async _startUpInstance(forceSamePort: boolean = false): Promise")),(0,o.yg)("p",null,"Internal Functions used by ",(0,o.yg)("a",{parentName:"p",href:"#start"},(0,o.yg)("inlineCode",{parentName:"a"},"start"))),(0,o.yg)("h3",{id:"stop"},"stop"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"async stop(cleanupOptions?: Cleanup): Promise")),(0,o.yg)("p",null,"Stop an running instance, this function will by default call ",(0,o.yg)("a",{parentName:"p",href:"#cleanup"},(0,o.yg)("inlineCode",{parentName:"a"},".cleanup"))," with ",(0,o.yg)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }"),"."),(0,o.yg)("p",null,"With ",(0,o.yg)("inlineCode",{parentName:"p"},"cleanupOptions")," options for cleanup can be manually set."),(0,o.yg)("admonition",{type:"caution"},(0,o.yg)("p",{parentName:"admonition"},"Will not Error if instance is not running")),(0,o.yg)("h3",{id:"cleanup"},"cleanup"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"async cleanup(options?: Cleanup): Promise")),(0,o.yg)("p",null,"Cleanup all files used by this instance, by default ",(0,o.yg)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }")," is used."),(0,o.yg)("p",null,"With ",(0,o.yg)("inlineCode",{parentName:"p"},"options")," can be set how to run a cleanup."),(0,o.yg)("h3",{id:"ensureinstance"},"ensureInstance"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"async ensureInstance(): Promise")),(0,o.yg)("p",null,"Ensure that the instance is running, will run ",(0,o.yg)("a",{parentName:"p",href:"#start"},(0,o.yg)("inlineCode",{parentName:"a"},"start"))," if stopped, will wait if state is ",(0,o.yg)("inlineCode",{parentName:"p"},"starting"),"."),(0,o.yg)("p",null,"It is recommended to ",(0,o.yg)("inlineCode",{parentName:"p"},"await")," the promise returned from ",(0,o.yg)("inlineCode",{parentName:"p"},"start")," when available."),(0,o.yg)("admonition",{type:"caution"},(0,o.yg)("p",{parentName:"admonition"},"Will Error if instance cannot be started")),(0,o.yg)("h3",{id:"geturi"},"getUri"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"getUri(otherDbName?: string, otherIp?: string): string")),(0,o.yg)("p",null,"Get an mongodb-usable uri (can also be used in mongoose)"),(0,o.yg)("p",null,"When no arguments are set, the URI will always use ip ",(0,o.yg)("inlineCode",{parentName:"p"},"127.0.0.1")," and end with ",(0,o.yg)("inlineCode",{parentName:"p"},"/")," (not setting a database).",(0,o.yg)("br",{parentName:"p"}),"\n","When setting ",(0,o.yg)("inlineCode",{parentName:"p"},"otherDbName"),", the value of ",(0,o.yg)("inlineCode",{parentName:"p"},"otherDbName")," will be appended after ",(0,o.yg)("inlineCode",{parentName:"p"},"/")," and before any query arguments.",(0,o.yg)("br",{parentName:"p"}),"\n","When setting ",(0,o.yg)("inlineCode",{parentName:"p"},"otherIp"),", the ip will be the value of ",(0,o.yg)("inlineCode",{parentName:"p"},"otherIp")," instead of ",(0,o.yg)("inlineCode",{parentName:"p"},"127.0.0.1"),"."),(0,o.yg)("h3",{id:"createauth"},"createAuth"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"async createAuth(data: StartupInstanceData): Promise")),(0,o.yg)("p",null,"Logs in into the currently running instance and restarts it with auth enabled"),(0,o.yg)("admonition",{type:"info"},(0,o.yg)("p",{parentName:"admonition"},"The Instance will not be restarted if the storage engine is ",(0,o.yg)("inlineCode",{parentName:"p"},"ephemeralForTest")," because data will not persist across restarts",(0,o.yg)("br",null),"\nIt 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")),(0,o.yg)("h2",{id:"values"},"Values"),(0,o.yg)("h3",{id:"instanceinfo"},"instanceInfo"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"get instanceInfo(): MongoInstanceData | undefined")),(0,o.yg)("p",null,"Getter for ",(0,o.yg)("a",{parentName:"p",href:"#_instanceInfo"},(0,o.yg)("inlineCode",{parentName:"a"},"_instanceInfo"))),(0,o.yg)("h3",{id:"_instanceinfo"},"_instanceInfo"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"protected _instanceInfo?: MongoInstanceData")),(0,o.yg)("p",null,"Stores the instance information"),(0,o.yg)("h3",{id:"opts"},"opts"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"opts: MongoMemoryServerOpts")),(0,o.yg)("p",null,"Store the instance options, uses ",(0,o.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-opts"},(0,o.yg)("inlineCode",{parentName:"a"},"MongoMemoryServerOpts")),"."),(0,o.yg)("h3",{id:"state"},"state"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"get state(): MongoMemoryServerStates")),(0,o.yg)("p",null,"Getter for ",(0,o.yg)("a",{parentName:"p",href:"#_state"},(0,o.yg)("inlineCode",{parentName:"a"},"_state_"))),(0,o.yg)("h3",{id:"_state"},"_state"),(0,o.yg)("span",{class:"badge badge--warning"},"Internal"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"protected _state: MongoMemoryServerStates")),(0,o.yg)("p",null,"Stores the current State, uses ",(0,o.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/enums/mongo-memory-server-states"},(0,o.yg)("inlineCode",{parentName:"a"},"MongoMemoryServerStates")," enum"),"."),(0,o.yg)("h3",{id:"auth"},"auth"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"readonly auth?: Required")),(0,o.yg)("p",null,"Stores automatic auth creation options, uses ",(0,o.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-automaticauth"},(0,o.yg)("inlineCode",{parentName:"a"},"AutomaticAuth"))," with all values defined."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/28ece197.e68f1224.js b/assets/js/28ece197.e68f1224.js deleted file mode 100644 index f52ad0738..000000000 --- a/assets/js/28ece197.e68f1224.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[898],{3905:function(e,t,n){n.d(t,{Zo:function(){return m},kt:function(){return g}});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),u=l(n),d=r,g=u["".concat(p,".").concat(d)]||u[d]||c[d]||o;return n?a.createElement(g,i(i({ref:t},m),{},{components:n})):a.createElement(g,i({ref:t},m))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var l=2;l")),(0,o.kt)("p",null,"Create an new Instance and start it (while being an Promise), uses ",(0,o.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-opts"},(0,o.kt)("inlineCode",{parentName:"a"},"MongoMemoryServerOpts")),"."),(0,o.kt)("h3",{id:"statechange"},"stateChange"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"protected stateChange(newState: MongoMemoryServerStates): void")),(0,o.kt)("p",null,"Used to change the state of the class, uses ",(0,o.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/enums/mongo-memory-server-states"},(0,o.kt)("inlineCode",{parentName:"a"},"MongoMemoryServerStates")," enum"),", it is ",(0,o.kt)("inlineCode",{parentName:"p"},"protected")," to not accidentally use it."),(0,o.kt)("h3",{id:"start"},"start"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"async start(forceSamePort: boolean = false): Promise")),(0,o.kt)("p",null,"Used to start an new Instance or to Re-Start an stopped instance"),(0,o.kt)("p",null,"with ",(0,o.kt)("inlineCode",{parentName:"p"},"forceSamePort")," set to ",(0,o.kt)("inlineCode",{parentName:"p"},"true")," and having ",(0,o.kt)("inlineCode",{parentName:"p"},"instance.port")," set, it will use that port and not generate a new port.",(0,o.kt)("br",{parentName:"p"}),"\n","with ",(0,o.kt)("inlineCode",{parentName:"p"},"forceSamePort")," set to ",(0,o.kt)("inlineCode",{parentName:"p"},"true")," and not having ",(0,o.kt)("inlineCode",{parentName:"p"},"instance.port")," set, it will generate a new free port. "),(0,o.kt)("admonition",{type:"caution"},(0,o.kt)("p",{parentName:"admonition"},"Will Error if instance is already running")),(0,o.kt)("h3",{id:"getnewport"},"getNewPort"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"protected async getNewPort(port?: number): Promise")),(0,o.kt)("p",null,"Finds an new non-locked port, uses ",(0,o.kt)("inlineCode",{parentName:"p"},"port")," if available or as a starting point."),(0,o.kt)("h3",{id:"getstartoptions"},"getStartOptions"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"protected async getStartOptions(forceSamePort: boolean = false): Promise")),(0,o.kt)("p",null,"with ",(0,o.kt)("inlineCode",{parentName:"p"},"forceSamePort")," set to ",(0,o.kt)("inlineCode",{parentName:"p"},"true")," and having ",(0,o.kt)("inlineCode",{parentName:"p"},"instance.port")," set, it will use that port and not generate a new port.",(0,o.kt)("br",{parentName:"p"}),"\n","with ",(0,o.kt)("inlineCode",{parentName:"p"},"forceSamePort")," set to ",(0,o.kt)("inlineCode",{parentName:"p"},"true")," and not having ",(0,o.kt)("inlineCode",{parentName:"p"},"instance.port")," set, it will generate a new free port. "),(0,o.kt)("p",null,"Constructs the Starting Options"),(0,o.kt)("h3",{id:"_startupinstance"},"_startUpInstance"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"async _startUpInstance(forceSamePort: boolean = false): Promise")),(0,o.kt)("p",null,"Internal Functions used by ",(0,o.kt)("a",{parentName:"p",href:"#start"},(0,o.kt)("inlineCode",{parentName:"a"},"start"))),(0,o.kt)("h3",{id:"stop"},"stop"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"async stop(cleanupOptions?: Cleanup): Promise")),(0,o.kt)("p",null,"Stop an running instance, this function will by default call ",(0,o.kt)("a",{parentName:"p",href:"#cleanup"},(0,o.kt)("inlineCode",{parentName:"a"},".cleanup"))," with ",(0,o.kt)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }"),"."),(0,o.kt)("p",null,"With ",(0,o.kt)("inlineCode",{parentName:"p"},"cleanupOptions")," options for cleanup can be manually set."),(0,o.kt)("admonition",{type:"caution"},(0,o.kt)("p",{parentName:"admonition"},"Will not Error if instance is not running")),(0,o.kt)("h3",{id:"cleanup"},"cleanup"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"async cleanup(options?: Cleanup): Promise")),(0,o.kt)("p",null,"Cleanup all files used by this instance, by default ",(0,o.kt)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }")," is used."),(0,o.kt)("p",null,"With ",(0,o.kt)("inlineCode",{parentName:"p"},"options")," can be set how to run a cleanup."),(0,o.kt)("h3",{id:"ensureinstance"},"ensureInstance"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"async ensureInstance(): Promise")),(0,o.kt)("p",null,"Ensure that the instance is running, will run ",(0,o.kt)("a",{parentName:"p",href:"#start"},(0,o.kt)("inlineCode",{parentName:"a"},"start"))," if stopped, will wait if state is ",(0,o.kt)("inlineCode",{parentName:"p"},"starting"),"."),(0,o.kt)("p",null,"It is recommended to ",(0,o.kt)("inlineCode",{parentName:"p"},"await")," the promise returned from ",(0,o.kt)("inlineCode",{parentName:"p"},"start")," when available."),(0,o.kt)("admonition",{type:"caution"},(0,o.kt)("p",{parentName:"admonition"},"Will Error if instance cannot be started")),(0,o.kt)("h3",{id:"geturi"},"getUri"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"getUri(otherDbName?: string, otherIp?: string): string")),(0,o.kt)("p",null,"Get an mongodb-usable uri (can also be used in mongoose)"),(0,o.kt)("p",null,"When no arguments are set, the URI will always use ip ",(0,o.kt)("inlineCode",{parentName:"p"},"127.0.0.1")," and end with ",(0,o.kt)("inlineCode",{parentName:"p"},"/")," (not setting a database).",(0,o.kt)("br",{parentName:"p"}),"\n","When setting ",(0,o.kt)("inlineCode",{parentName:"p"},"otherDbName"),", the value of ",(0,o.kt)("inlineCode",{parentName:"p"},"otherDbName")," will be appended after ",(0,o.kt)("inlineCode",{parentName:"p"},"/")," and before any query arguments.",(0,o.kt)("br",{parentName:"p"}),"\n","When setting ",(0,o.kt)("inlineCode",{parentName:"p"},"otherIp"),", the ip will be the value of ",(0,o.kt)("inlineCode",{parentName:"p"},"otherIp")," instead of ",(0,o.kt)("inlineCode",{parentName:"p"},"127.0.0.1"),"."),(0,o.kt)("h3",{id:"createauth"},"createAuth"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"async createAuth(data: StartupInstanceData): Promise")),(0,o.kt)("p",null,"Logs in into the currently running instance and restarts it with auth enabled"),(0,o.kt)("admonition",{type:"info"},(0,o.kt)("p",{parentName:"admonition"},"The Instance will not be restarted if the storage engine is ",(0,o.kt)("inlineCode",{parentName:"p"},"ephemeralForTest")," because data will not persist across restarts",(0,o.kt)("br",null),"\nIt 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")),(0,o.kt)("h2",{id:"values"},"Values"),(0,o.kt)("h3",{id:"instanceinfo"},"instanceInfo"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"get instanceInfo(): MongoInstanceData | undefined")),(0,o.kt)("p",null,"Getter for ",(0,o.kt)("a",{parentName:"p",href:"#_instanceInfo"},(0,o.kt)("inlineCode",{parentName:"a"},"_instanceInfo"))),(0,o.kt)("h3",{id:"_instanceinfo"},"_instanceInfo"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"protected _instanceInfo?: MongoInstanceData")),(0,o.kt)("p",null,"Stores the instance information"),(0,o.kt)("h3",{id:"opts"},"opts"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"opts: MongoMemoryServerOpts")),(0,o.kt)("p",null,"Store the instance options, uses ",(0,o.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-opts"},(0,o.kt)("inlineCode",{parentName:"a"},"MongoMemoryServerOpts")),"."),(0,o.kt)("h3",{id:"state"},"state"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"get state(): MongoMemoryServerStates")),(0,o.kt)("p",null,"Getter for ",(0,o.kt)("a",{parentName:"p",href:"#_state"},(0,o.kt)("inlineCode",{parentName:"a"},"_state_"))),(0,o.kt)("h3",{id:"_state"},"_state"),(0,o.kt)("span",{class:"badge badge--warning"},"Internal"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"protected _state: MongoMemoryServerStates")),(0,o.kt)("p",null,"Stores the current State, uses ",(0,o.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/enums/mongo-memory-server-states"},(0,o.kt)("inlineCode",{parentName:"a"},"MongoMemoryServerStates")," enum"),"."),(0,o.kt)("h3",{id:"auth"},"auth"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"readonly auth?: Required")),(0,o.kt)("p",null,"Stores automatic auth creation options, uses ",(0,o.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-automaticauth"},(0,o.kt)("inlineCode",{parentName:"a"},"AutomaticAuth"))," with all values defined."))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/32c6e8e6.ee12d14c.js b/assets/js/32c6e8e6.ee12d14c.js deleted file mode 100644 index eae0436b2..000000000 --- a/assets/js/32c6e8e6.ee12d14c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[182],{3905:function(e,n,t){t.d(n,{Zo:function(){return m},kt:function(){return c}});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var l=r.createContext({}),d=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},m=function(e){var n=d(e.components);return r.createElement(l.Provider,{value:n},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},g=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,i=e.originalType,l=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),p=d(t),g=o,c=p["".concat(l,".").concat(g)]||p[g]||u[g]||i;return t?r.createElement(c,a(a({ref:n},m),{},{components:t})):r.createElement(c,a({ref:n},m))}));function c(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var i=t.length,a=new Array(i);a[0]=g;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[p]="string"==typeof e?e:o,a[1]=s;for(var d=2;d16",id:"minimal-nodejs-version-is-now-16",level:3},{value:"Mongodb Driver Version upgraded to 6.x",id:"mongodb-driver-version-upgraded-to-6x",level:3},{value:"Default binary version is now 7.x",id:"default-binary-version-is-now-7x",level:3},{value:"Non-Breaking changes / Additions",id:"non-breaking-changes--additions",level:2},{value:"Compiler target is now es2021",id:"compiler-target-is-now-es2021",level:3},{value:"Getport now uses net0listen by default",id:"getport-now-uses-net0listen-by-default",level:3},{value:"Allow setting port generation in MongoMemoryServer",id:"allow-setting-port-generation-in-mongomemoryserver",level:3}],u={toc:p},g="wrapper";function c(e){var n=e.components,t=(0,o.Z)(e,a);return(0,i.kt)(g,(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"Here are the Important changes made for 10.0.0"),(0,i.kt)("admonition",{title:"Important, Read this first",type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"This Guide is written for migration from version ",(0,i.kt)("inlineCode",{parentName:"p"},"9.4.1")," to ",(0,i.kt)("inlineCode",{parentName:"p"},"10.0.0"),", for versions ",(0,i.kt)("inlineCode",{parentName:"p"},">10.0.0 <11.0.0"),", please consult the ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md"},"CHANGELOG"))),(0,i.kt)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,i.kt)("h3",{id:"minimal-nodejs-version-is-now-16"},"Minimal NodeJS version is now ",(0,i.kt)("inlineCode",{parentName:"h3"},"16")),(0,i.kt)("p",null,"With 10.0.0 the minimal nodejs required is ",(0,i.kt)("inlineCode",{parentName:"p"},"16.20.1"),"."),(0,i.kt)("h3",{id:"mongodb-driver-version-upgraded-to-6x"},"Mongodb Driver Version upgraded to 6.x"),(0,i.kt)("p",null,"The used MongoDB Driver version is now ",(0,i.kt)("inlineCode",{parentName:"p"},"6.7.0"),"."),(0,i.kt)("h3",{id:"default-binary-version-is-now-7x"},"Default binary version is now 7.x"),(0,i.kt)("p",null,"The default binary version has been upgraded from ",(0,i.kt)("inlineCode",{parentName:"p"},"6.0.x")," to ",(0,i.kt)("inlineCode",{parentName:"p"},"7.0.x"),". For more specifics see ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/guides/mongodb-server-versions"},"mongodb-server-versions"),"."),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"In mongodb ",(0,i.kt)("inlineCode",{parentName:"p"},"7.0.0")," storage engine ",(0,i.kt)("inlineCode",{parentName:"p"},"ephemeralForTest")," has been removed, mongodb-memory-server will automatically translate any occurrence to ",(0,i.kt)("inlineCode",{parentName:"p"},"wiredTiger")," with a warning."),(0,i.kt)("p",{parentName:"admonition"},"It is recommended to run the tests against a tmpfs or equivalent (default ",(0,i.kt)("inlineCode",{parentName:"p"},"/tmp")," on linux / macos).")),(0,i.kt)("h2",{id:"non-breaking-changes--additions"},"Non-Breaking changes / Additions"),(0,i.kt)("h3",{id:"compiler-target-is-now-es2021"},"Compiler target is now ",(0,i.kt)("inlineCode",{parentName:"h3"},"es2021")),(0,i.kt)("p",null,"The tsconfig ",(0,i.kt)("inlineCode",{parentName:"p"},"target")," option has been updated to ",(0,i.kt)("inlineCode",{parentName:"p"},"es2021"),", which will result in less polyfills.\nThis should be a non-breaking change."),(0,i.kt)("h3",{id:"getport-now-uses-net0listen-by-default"},"Getport now uses ",(0,i.kt)("inlineCode",{parentName:"h3"},"net0listen")," by default"),(0,i.kt)("p",null,"This means a port is now generated by the engine (like nodejs) itself, previously known as ",(0,i.kt)("inlineCode",{parentName:"p"},"EXP_NET0LISTEN"),".\nThis should reduce amount of ",(0,i.kt)("inlineCode",{parentName:"p"},"Max port tries exceeded")," errors."),(0,i.kt)("h3",{id:"allow-setting-port-generation-in-mongomemoryserver"},"Allow setting port generation in MongoMemoryServer"),(0,i.kt)("p",null,"Starting with 10.0 there is a new option to set whether port generation is enabled or not on ",(0,i.kt)("inlineCode",{parentName:"p"},"MongoMemoryServer")," called ",(0,i.kt)("inlineCode",{parentName:"p"},"portGeneration"),". (default: ",(0,i.kt)("inlineCode",{parentName:"p"},"true"),")"),(0,i.kt)("p",null,"(Note that the ",(0,i.kt)("inlineCode",{parentName:"p"},"forceSamePort")," parameter in ",(0,i.kt)("inlineCode",{parentName:"p"},".start")," will overwrite this option)"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/32c6e8e6.ee77b853.js b/assets/js/32c6e8e6.ee77b853.js new file mode 100644 index 000000000..6f37459f3 --- /dev/null +++ b/assets/js/32c6e8e6.ee77b853.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[353],{5680:function(e,n,r){r.d(n,{xA:function(){return d},yg:function(){return c}});var t=r(6540);function o(e,n,r){return n in e?Object.defineProperty(e,n,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[n]=r,e}function i(e,n){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),r.push.apply(r,t)}return r}function a(e){for(var n=1;n=0||(o[r]=e[r]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=t.createContext({}),g=function(e){var n=t.useContext(l),r=n;return e&&(r="function"==typeof e?e(n):a(a({},n),e)),r},d=function(e){var n=g(e.components);return t.createElement(l.Provider,{value:n},e.children)},m="mdxType",p={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},u=t.forwardRef((function(e,n){var r=e.components,o=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),m=g(r),u=o,c=m["".concat(l,".").concat(u)]||m[u]||p[u]||i;return r?t.createElement(c,a(a({ref:n},d),{},{components:r})):t.createElement(c,a({ref:n},d))}));function c(e,n){var r=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=u;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[m]="string"==typeof e?e:o,a[1]=s;for(var g=2;g16",id:"minimal-nodejs-version-is-now-16",level:3},{value:"Mongodb Driver Version upgraded to 6.x",id:"mongodb-driver-version-upgraded-to-6x",level:3},{value:"Default binary version is now 7.x",id:"default-binary-version-is-now-7x",level:3},{value:"Non-Breaking changes / Additions",id:"non-breaking-changes--additions",level:2},{value:"Compiler target is now es2021",id:"compiler-target-is-now-es2021",level:3},{value:"Getport now uses net0listen by default",id:"getport-now-uses-net0listen-by-default",level:3},{value:"Allow setting port generation in MongoMemoryServer",id:"allow-setting-port-generation-in-mongomemoryserver",level:3}],p={toc:m},u="wrapper";function c(e){var n=e.components,r=(0,o.A)(e,a);return(0,i.yg)(u,(0,t.A)({},p,r,{components:n,mdxType:"MDXLayout"}),(0,i.yg)("p",null,"Here are the Important changes made for 10.0.0"),(0,i.yg)("admonition",{title:"Important, Read this first",type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"This Guide is written for migration from version ",(0,i.yg)("inlineCode",{parentName:"p"},"9.4.1")," to ",(0,i.yg)("inlineCode",{parentName:"p"},"10.0.0"),", for versions ",(0,i.yg)("inlineCode",{parentName:"p"},">10.0.0 <11.0.0"),", please consult the ",(0,i.yg)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md"},"CHANGELOG"))),(0,i.yg)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,i.yg)("h3",{id:"minimal-nodejs-version-is-now-16"},"Minimal NodeJS version is now ",(0,i.yg)("inlineCode",{parentName:"h3"},"16")),(0,i.yg)("p",null,"With 10.0.0 the minimal nodejs required is ",(0,i.yg)("inlineCode",{parentName:"p"},"16.20.1"),"."),(0,i.yg)("h3",{id:"mongodb-driver-version-upgraded-to-6x"},"Mongodb Driver Version upgraded to 6.x"),(0,i.yg)("p",null,"The used MongoDB Driver version is now ",(0,i.yg)("inlineCode",{parentName:"p"},"6.7.0"),"."),(0,i.yg)("h3",{id:"default-binary-version-is-now-7x"},"Default binary version is now 7.x"),(0,i.yg)("p",null,"The default binary version has been upgraded from ",(0,i.yg)("inlineCode",{parentName:"p"},"6.0.x")," to ",(0,i.yg)("inlineCode",{parentName:"p"},"7.0.x"),". For more specifics see ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/guides/mongodb-server-versions"},"mongodb-server-versions"),"."),(0,i.yg)("admonition",{type:"note"},(0,i.yg)("p",{parentName:"admonition"},"In mongodb ",(0,i.yg)("inlineCode",{parentName:"p"},"7.0.0")," storage engine ",(0,i.yg)("inlineCode",{parentName:"p"},"ephemeralForTest")," has been removed, mongodb-memory-server will automatically translate any occurrence to ",(0,i.yg)("inlineCode",{parentName:"p"},"wiredTiger")," with a warning."),(0,i.yg)("p",{parentName:"admonition"},"It is recommended to run the tests against a tmpfs or equivalent (default ",(0,i.yg)("inlineCode",{parentName:"p"},"/tmp")," on linux / macos).")),(0,i.yg)("h2",{id:"non-breaking-changes--additions"},"Non-Breaking changes / Additions"),(0,i.yg)("h3",{id:"compiler-target-is-now-es2021"},"Compiler target is now ",(0,i.yg)("inlineCode",{parentName:"h3"},"es2021")),(0,i.yg)("p",null,"The tsconfig ",(0,i.yg)("inlineCode",{parentName:"p"},"target")," option has been updated to ",(0,i.yg)("inlineCode",{parentName:"p"},"es2021"),", which will result in less polyfills.\nThis should be a non-breaking change."),(0,i.yg)("h3",{id:"getport-now-uses-net0listen-by-default"},"Getport now uses ",(0,i.yg)("inlineCode",{parentName:"h3"},"net0listen")," by default"),(0,i.yg)("p",null,"This means a port is now generated by the engine (like nodejs) itself, previously known as ",(0,i.yg)("inlineCode",{parentName:"p"},"EXP_NET0LISTEN"),".\nThis should reduce amount of ",(0,i.yg)("inlineCode",{parentName:"p"},"Max port tries exceeded")," errors."),(0,i.yg)("h3",{id:"allow-setting-port-generation-in-mongomemoryserver"},"Allow setting port generation in MongoMemoryServer"),(0,i.yg)("p",null,"Starting with 10.0 there is a new option to set whether port generation is enabled or not on ",(0,i.yg)("inlineCode",{parentName:"p"},"MongoMemoryServer")," called ",(0,i.yg)("inlineCode",{parentName:"p"},"portGeneration"),". (default: ",(0,i.yg)("inlineCode",{parentName:"p"},"true"),")"),(0,i.yg)("p",null,"(Note that the ",(0,i.yg)("inlineCode",{parentName:"p"},"forceSamePort")," parameter in ",(0,i.yg)("inlineCode",{parentName:"p"},".start")," will overwrite this option)"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/44df2d52.3df3f8af.js b/assets/js/44df2d52.3df3f8af.js deleted file mode 100644 index 2148d63b8..000000000 --- a/assets/js/44df2d52.3df3f8af.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[118],{3905:function(e,t,n){n.d(t,{Zo:function(){return m},kt:function(){return g}});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),l=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=l(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),c=l(n),d=o,g=c["".concat(s,".").concat(d)]||c[d]||u[d]||a;return n?r.createElement(g,i(i({ref:t},m),{},{components:n})):r.createElement(g,i({ref:t},m))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=d;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:o,i[1]=p;for(var l=2;l=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=r.createContext({}),l=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},m=function(e){var n=l(e.components);return r.createElement(s.Provider,{value:n},e.children)},g="mdxType",y={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},c=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),g=l(t),c=o,u=g["".concat(s,".").concat(c)]||g[c]||y[c]||a;return t?r.createElement(u,i(i({ref:n},m),{},{components:t})):r.createElement(u,i({ref:n},m))}));function u(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=c;var p={};for(var s in n)hasOwnProperty.call(n,s)&&(p[s]=n[s]);p.originalType=e,p[g]="string"==typeof e?e:o,i[1]=p;for(var l=2;l=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var i=a.createContext({}),s=function(e){var t=a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=s(e.components);return a.createElement(i.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,i=e.parentName,c=u(e,["components","mdxType","originalType","parentName"]),p=s(n),m=r,f=p["".concat(i,".").concat(m)]||p[m]||d[m]||o;return n?a.createElement(f,l(l({ref:t},c),{},{components:n})):a.createElement(f,l({ref:t},c))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,l=new Array(o);l[0]=m;var u={};for(var i in t)hasOwnProperty.call(t,i)&&(u[i]=t[i]);u.originalType=e,u[p]="string"==typeof e?e:r,l[1]=u;for(var s=2;s child <"+("string"==typeof e.type?e.type:e.type.name)+'>: all children of the component should be , and every should have a unique "value" prop.')})))?void 0:n.filter(Boolean))?t:[]}(e).map((function(e){var t=e.props;return{value:t.value,label:t.label,attributes:t.attributes,default:t.default}}))}function f(e){var t=e.values,n=e.children;return(0,o.useMemo)((function(){var e=null!=t?t:m(n);return function(e){var t=(0,p.l)(e,(function(e,t){return e.value===t.value}));if(t.length>0)throw new Error('Docusaurus error: Duplicate values "'+t.map((function(e){return e.value})).join(", ")+'" found in . Every value needs to be unique.')}(e),e}),[t,n])}function b(e){var t=e.value;return e.tabValues.some((function(e){return e.value===t}))}function g(e){var t=e.queryString,n=void 0!==t&&t,a=e.groupId,r=(0,s.k6)(),l=function(e){var t=e.queryString,n=void 0!==t&&t,a=e.groupId;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!a)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return null!=a?a:null}({queryString:n,groupId:a});return[(0,c._X)(l),(0,o.useCallback)((function(e){if(l){var t=new URLSearchParams(r.location.search);t.set(l,e),r.replace(Object.assign({},r.location,{search:t.toString()}))}}),[l,r])]}function v(e){var t,n,a,r,l=e.defaultValue,u=e.queryString,i=void 0!==u&&u,s=e.groupId,c=f(e),p=(0,o.useState)((function(){return function(e){var t,n=e.defaultValue,a=e.tabValues;if(0===a.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!b({value:n,tabValues:a}))throw new Error('Docusaurus error: The has a defaultValue "'+n+'" but none of its children has the corresponding value. Available values are: '+a.map((function(e){return e.value})).join(", ")+". If you intend to show no default tab, use defaultValue={null} instead.");return n}var r=null!=(t=a.find((function(e){return e.default})))?t:a[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:l,tabValues:c})})),m=p[0],v=p[1],h=g({queryString:i,groupId:s}),y=h[0],k=h[1],w=(t=function(e){return e?"docusaurus.tab."+e:null}({groupId:s}.groupId),n=(0,d.Nk)(t),a=n[0],r=n[1],[a,(0,o.useCallback)((function(e){t&&r.set(e)}),[t,r])]),N=w[0],T=w[1],E=function(){var e=null!=y?y:N;return b({value:e,tabValues:c})?e:null}();return(0,o.useLayoutEffect)((function(){E&&v(E)}),[E]),{selectedValue:m,selectValue:(0,o.useCallback)((function(e){if(!b({value:e,tabValues:c}))throw new Error("Can't select invalid tab value="+e);v(e),k(e),T(e)}),[k,T,c]),tabValues:c}}var h=n(2389),y={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function k(e){var t=e.className,n=e.block,r=e.selectedValue,l=e.selectValue,s=e.tabValues,c=[],p=(0,i.o5)().blockElementScrollPositionUntilNextRender,d=function(e){var t=e.currentTarget,n=c.indexOf(t),a=s[n].value;a!==r&&(p(t),l(a))},m=function(e){var t,n=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":var a,r=c.indexOf(e.currentTarget)+1;n=null!=(a=c[r])?a:c[0];break;case"ArrowLeft":var o,l=c.indexOf(e.currentTarget)-1;n=null!=(o=c[l])?o:c[c.length-1]}null==(t=n)||t.focus()};return o.createElement("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,u.Z)("tabs",{"tabs--block":n},t)},s.map((function(e){var t=e.value,n=e.label,l=e.attributes;return o.createElement("li",(0,a.Z)({role:"tab",tabIndex:r===t?0:-1,"aria-selected":r===t,key:t,ref:function(e){return c.push(e)},onKeyDown:m,onClick:d},l,{className:(0,u.Z)("tabs__item",y.tabItem,null==l?void 0:l.className,{"tabs__item--active":r===t})}),null!=n?n:t)})))}function w(e){var t=e.lazy,n=e.children,a=e.selectedValue,r=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){var l=r.find((function(e){return e.props.value===a}));return l?(0,o.cloneElement)(l,{className:"margin-top--md"}):null}return o.createElement("div",{className:"margin-top--md"},r.map((function(e,t){return(0,o.cloneElement)(e,{key:t,hidden:e.props.value!==a})})))}function N(e){var t=v(e);return o.createElement("div",{className:(0,u.Z)("tabs-container",y.tabList)},o.createElement(k,(0,a.Z)({},e,t)),o.createElement(w,(0,a.Z)({},e,t)))}function T(e){var t=(0,h.Z)();return o.createElement(N,(0,a.Z)({key:String(t)},e))}var E={tabItem:"tabItem_Ymn6"};function x(e){var t=e.children,n=e.hidden,a=e.className;return o.createElement("div",{role:"tabpanel",className:(0,u.Z)(E.tabItem,a),hidden:n},t)}var O=["components"],S={id:"test",title:"Docusaurus Testing"},C=void 0,D={unversionedId:"test",id:"test",title:"Docusaurus Testing",description:"This file is meant to show what Docusaurus is capable of and how it looks in this projects styles",source:"@site/../docs/test.mdx",sourceDirName:".",slug:"/test",permalink:"/mongodb-memory-server/docs/test",draft:!1,editUrl:"https://github.com/typegoose/mongodb-memory-server/edit/master/docs/../docs/test.mdx",tags:[],version:"current",frontMatter:{id:"test",title:"Docusaurus Testing"}},I={},j=[{value:"Callouts / Admonitions",id:"callouts--admonitions",level:2},{value:"Specify type and title",id:"specify-type-and-title",level:3},{value:"Badges",id:"badges",level:2},{value:"Tabs",id:"tabs",level:2},{value:"Extra Code Block Styling",id:"extra-code-block-styling",level:2}],V={toc:j},P="wrapper";function _(e){var t=e.components,n=(0,r.Z)(e,O);return(0,l.kt)(P,(0,a.Z)({},V,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,"This file is meant to show what Docusaurus is capable of and how it looks in this projects styles"),(0,l.kt)("p",null,"Sources:"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"https://docusaurus.io/docs/"},"Docusaurus Documentation")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"https://infima.dev/docs/getting-started/introduction"},"infima Documentation"))),(0,l.kt)("h2",{id:"callouts--admonitions"},"Callouts / Admonitions"),(0,l.kt)("admonition",{type:"note"},(0,l.kt)("p",{parentName:"admonition"},"The content and title ",(0,l.kt)("em",{parentName:"p"},"can")," include markdown.")),(0,l.kt)("admonition",{title:"You can specify an optional title",type:"tip"},(0,l.kt)("p",{parentName:"admonition"},"Heads up! Here's a pro-tip.")),(0,l.kt)("admonition",{type:"info"},(0,l.kt)("p",{parentName:"admonition"},"Useful information.")),(0,l.kt)("admonition",{type:"caution"},(0,l.kt)("p",{parentName:"admonition"},"Warning! You better pay attention!")),(0,l.kt)("admonition",{type:"danger"},(0,l.kt)("p",{parentName:"admonition"},"Danger danger, mayday!")),(0,l.kt)("h3",{id:"specify-type-and-title"},"Specify type and title"),(0,l.kt)("admonition",{title:"Your Title",type:"note"},(0,l.kt)("p",{parentName:"admonition"},"The content and title ",(0,l.kt)("em",{parentName:"p"},"can")," include markdown.")),(0,l.kt)("h2",{id:"badges"},"Badges"),(0,l.kt)("span",{class:"badge badge--primary"},"Primary"),(0,l.kt)("span",{class:"badge badge--secondary"},"Secondary"),(0,l.kt)("span",{class:"badge badge--success"},"Success"),(0,l.kt)("span",{class:"badge badge--info"},"Info"),(0,l.kt)("span",{class:"badge badge--warning"},"Warning"),(0,l.kt)("span",{class:"badge badge--danger"},"Danger"),(0,l.kt)("h2",{id:"tabs"},"Tabs"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/tabs"},"Tabs")),(0,l.kt)(T,{groupId:"test-tabs",mdxType:"Tabs"},(0,l.kt)(x,{value:"tab1",label:"Tab 1",default:!0,mdxType:"TabItem"},(0,l.kt)("p",null,"Hello Tab 1, text first"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-txt"},"Code in Tab 1\n"))),(0,l.kt)(x,{value:"tab2",label:"Tab 2",mdxType:"TabItem"},(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-txt"},"Code in Tab 2\n")),(0,l.kt)("p",null,"Hello Tab 2, text last"))),(0,l.kt)("h2",{id:"extra-code-block-styling"},"Extra Code Block Styling"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/code-blocks"},"Extra Code Block Styling")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/code-blocks#line-highlighting"},"Highlighting lines"),":"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ts"},'import something from "some";\n\n// highlight-start\nclass SomeClass {\n public hello?: string\n}\n// highlight-end\n\nexport SomeClass;\n')),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/code-blocks#line-numbering"},"Line Numbering"),":"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ts",metastring:"showLineNumbers",showLineNumbers:!0},'import something from "some";\n\nclass SomeClass {\n public hello?: string\n}\n\nexport SomeClass;\n')),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/code-blocks#npm2yarn-remark-plugin"},"Yarn & NPM"),":"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash",metastring:"npm2yarn",npm2yarn:!0},"npm install somepackage\n")))}_.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[292],{5680:function(e,t,n){n.d(t,{xA:function(){return c},yg:function(){return g}});var a=n(6540);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var i=a.createContext({}),s=function(e){var t=a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=s(e.components);return a.createElement(i.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,i=e.parentName,c=u(e,["components","mdxType","originalType","parentName"]),p=s(n),m=r,g=p["".concat(i,".").concat(m)]||p[m]||d[m]||o;return n?a.createElement(g,l(l({ref:t},c),{},{components:n})):a.createElement(g,l({ref:t},c))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,l=new Array(o);l[0]=m;var u={};for(var i in t)hasOwnProperty.call(t,i)&&(u[i]=t[i]);u.originalType=e,u[p]="string"==typeof e?e:r,l[1]=u;for(var s=2;s child <"+("string"==typeof e.type?e.type:e.type.name)+'>: all children of the component should be , and every should have a unique "value" prop.')})))?void 0:n.filter(Boolean))?t:[]}(e).map((function(e){var t=e.props;return{value:t.value,label:t.label,attributes:t.attributes,default:t.default}}))}function g(e){var t=e.values,n=e.children;return(0,o.useMemo)((function(){var e=null!=t?t:m(n);return function(e){var t=(0,p.X)(e,(function(e,t){return e.value===t.value}));if(t.length>0)throw new Error('Docusaurus error: Duplicate values "'+t.map((function(e){return e.value})).join(", ")+'" found in . Every value needs to be unique.')}(e),e}),[t,n])}function f(e){var t=e.value;return e.tabValues.some((function(e){return e.value===t}))}function y(e){var t=e.queryString,n=void 0!==t&&t,a=e.groupId,r=(0,s.W6)(),l=function(e){var t=e.queryString,n=void 0!==t&&t,a=e.groupId;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!a)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return null!=a?a:null}({queryString:n,groupId:a});return[(0,c.aZ)(l),(0,o.useCallback)((function(e){if(l){var t=new URLSearchParams(r.location.search);t.set(l,e),r.replace(Object.assign({},r.location,{search:t.toString()}))}}),[l,r])]}function b(e){var t,n,a,r,l=e.defaultValue,u=e.queryString,i=void 0!==u&&u,s=e.groupId,c=g(e),p=(0,o.useState)((function(){return function(e){var t,n=e.defaultValue,a=e.tabValues;if(0===a.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!f({value:n,tabValues:a}))throw new Error('Docusaurus error: The has a defaultValue "'+n+'" but none of its children has the corresponding value. Available values are: '+a.map((function(e){return e.value})).join(", ")+". If you intend to show no default tab, use defaultValue={null} instead.");return n}var r=null!=(t=a.find((function(e){return e.default})))?t:a[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:l,tabValues:c})})),m=p[0],b=p[1],v=y({queryString:i,groupId:s}),h=v[0],w=v[1],N=(t=function(e){return e?"docusaurus.tab."+e:null}({groupId:s}.groupId),n=(0,d.Dv)(t),a=n[0],r=n[1],[a,(0,o.useCallback)((function(e){t&&r.set(e)}),[t,r])]),T=N[0],k=N[1],E=function(){var e=null!=h?h:T;return f({value:e,tabValues:c})?e:null}();return(0,o.useLayoutEffect)((function(){E&&b(E)}),[E]),{selectedValue:m,selectValue:(0,o.useCallback)((function(e){if(!f({value:e,tabValues:c}))throw new Error("Can't select invalid tab value="+e);b(e),w(e),k(e)}),[w,k,c]),tabValues:c}}var v=n(2303),h={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function w(e){var t=e.className,n=e.block,r=e.selectedValue,l=e.selectValue,s=e.tabValues,c=[],p=(0,i.a_)().blockElementScrollPositionUntilNextRender,d=function(e){var t=e.currentTarget,n=c.indexOf(t),a=s[n].value;a!==r&&(p(t),l(a))},m=function(e){var t,n=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":var a,r=c.indexOf(e.currentTarget)+1;n=null!=(a=c[r])?a:c[0];break;case"ArrowLeft":var o,l=c.indexOf(e.currentTarget)-1;n=null!=(o=c[l])?o:c[c.length-1]}null==(t=n)||t.focus()};return o.createElement("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,u.A)("tabs",{"tabs--block":n},t)},s.map((function(e){var t=e.value,n=e.label,l=e.attributes;return o.createElement("li",(0,a.A)({role:"tab",tabIndex:r===t?0:-1,"aria-selected":r===t,key:t,ref:function(e){return c.push(e)},onKeyDown:m,onClick:d},l,{className:(0,u.A)("tabs__item",h.tabItem,null==l?void 0:l.className,{"tabs__item--active":r===t})}),null!=n?n:t)})))}function N(e){var t=e.lazy,n=e.children,a=e.selectedValue,r=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){var l=r.find((function(e){return e.props.value===a}));return l?(0,o.cloneElement)(l,{className:"margin-top--md"}):null}return o.createElement("div",{className:"margin-top--md"},r.map((function(e,t){return(0,o.cloneElement)(e,{key:t,hidden:e.props.value!==a})})))}function T(e){var t=b(e);return o.createElement("div",{className:(0,u.A)("tabs-container",h.tabList)},o.createElement(w,(0,a.A)({},e,t)),o.createElement(N,(0,a.A)({},e,t)))}function k(e){var t=(0,v.A)();return o.createElement(T,(0,a.A)({key:String(t)},e))}var E={tabItem:"tabItem_Ymn6"};function x(e){var t=e.children,n=e.hidden,a=e.className;return o.createElement("div",{role:"tabpanel",className:(0,u.A)(E.tabItem,a),hidden:n},t)}var O=["components"],S={id:"test",title:"Docusaurus Testing"},D=void 0,C={unversionedId:"test",id:"test",title:"Docusaurus Testing",description:"This file is meant to show what Docusaurus is capable of and how it looks in this projects styles",source:"@site/../docs/test.mdx",sourceDirName:".",slug:"/test",permalink:"/mongodb-memory-server/docs/test",draft:!1,editUrl:"https://github.com/typegoose/mongodb-memory-server/edit/master/docs/../docs/test.mdx",tags:[],version:"current",frontMatter:{id:"test",title:"Docusaurus Testing"}},I={},j=[{value:"Callouts / Admonitions",id:"callouts--admonitions",level:2},{value:"Specify type and title",id:"specify-type-and-title",level:3},{value:"Badges",id:"badges",level:2},{value:"Tabs",id:"tabs",level:2},{value:"Extra Code Block Styling",id:"extra-code-block-styling",level:2}],A={toc:j},V="wrapper";function P(e){var t=e.components,n=(0,r.A)(e,O);return(0,l.yg)(V,(0,a.A)({},A,n,{components:t,mdxType:"MDXLayout"}),(0,l.yg)("p",null,"This file is meant to show what Docusaurus is capable of and how it looks in this projects styles"),(0,l.yg)("p",null,"Sources:"),(0,l.yg)("ul",null,(0,l.yg)("li",{parentName:"ul"},(0,l.yg)("a",{parentName:"li",href:"https://docusaurus.io/docs/"},"Docusaurus Documentation")),(0,l.yg)("li",{parentName:"ul"},(0,l.yg)("a",{parentName:"li",href:"https://infima.dev/docs/getting-started/introduction"},"infima Documentation"))),(0,l.yg)("h2",{id:"callouts--admonitions"},"Callouts / Admonitions"),(0,l.yg)("admonition",{type:"note"},(0,l.yg)("p",{parentName:"admonition"},"The content and title ",(0,l.yg)("em",{parentName:"p"},"can")," include markdown.")),(0,l.yg)("admonition",{title:"You can specify an optional title",type:"tip"},(0,l.yg)("p",{parentName:"admonition"},"Heads up! Here's a pro-tip.")),(0,l.yg)("admonition",{type:"info"},(0,l.yg)("p",{parentName:"admonition"},"Useful information.")),(0,l.yg)("admonition",{type:"caution"},(0,l.yg)("p",{parentName:"admonition"},"Warning! You better pay attention!")),(0,l.yg)("admonition",{type:"danger"},(0,l.yg)("p",{parentName:"admonition"},"Danger danger, mayday!")),(0,l.yg)("h3",{id:"specify-type-and-title"},"Specify type and title"),(0,l.yg)("admonition",{title:"Your Title",type:"note"},(0,l.yg)("p",{parentName:"admonition"},"The content and title ",(0,l.yg)("em",{parentName:"p"},"can")," include markdown.")),(0,l.yg)("h2",{id:"badges"},"Badges"),(0,l.yg)("span",{class:"badge badge--primary"},"Primary"),(0,l.yg)("span",{class:"badge badge--secondary"},"Secondary"),(0,l.yg)("span",{class:"badge badge--success"},"Success"),(0,l.yg)("span",{class:"badge badge--info"},"Info"),(0,l.yg)("span",{class:"badge badge--warning"},"Warning"),(0,l.yg)("span",{class:"badge badge--danger"},"Danger"),(0,l.yg)("h2",{id:"tabs"},"Tabs"),(0,l.yg)("p",null,(0,l.yg)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/tabs"},"Tabs")),(0,l.yg)(k,{groupId:"test-tabs",mdxType:"Tabs"},(0,l.yg)(x,{value:"tab1",label:"Tab 1",default:!0,mdxType:"TabItem"},(0,l.yg)("p",null,"Hello Tab 1, text first"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-txt"},"Code in Tab 1\n"))),(0,l.yg)(x,{value:"tab2",label:"Tab 2",mdxType:"TabItem"},(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-txt"},"Code in Tab 2\n")),(0,l.yg)("p",null,"Hello Tab 2, text last"))),(0,l.yg)("h2",{id:"extra-code-block-styling"},"Extra Code Block Styling"),(0,l.yg)("p",null,(0,l.yg)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/code-blocks"},"Extra Code Block Styling")),(0,l.yg)("p",null,(0,l.yg)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/code-blocks#line-highlighting"},"Highlighting lines"),":"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-ts"},'import something from "some";\n\n// highlight-start\nclass SomeClass {\n public hello?: string\n}\n// highlight-end\n\nexport SomeClass;\n')),(0,l.yg)("p",null,(0,l.yg)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/code-blocks#line-numbering"},"Line Numbering"),":"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-ts",metastring:"showLineNumbers",showLineNumbers:!0},'import something from "some";\n\nclass SomeClass {\n public hello?: string\n}\n\nexport SomeClass;\n')),(0,l.yg)("p",null,(0,l.yg)("a",{parentName:"p",href:"https://docusaurus.io/docs/markdown-features/code-blocks#npm2yarn-remark-plugin"},"Yarn & NPM"),":"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-bash",metastring:"npm2yarn",npm2yarn:!0},"npm install somepackage\n")))}P.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6d7d5585.c78ba8c4.js b/assets/js/6d7d5585.c78ba8c4.js new file mode 100644 index 000000000..18b748842 --- /dev/null +++ b/assets/js/6d7d5585.c78ba8c4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[11],{5680:function(e,n,t){t.d(n,{xA:function(){return c},yg:function(){return m}});var r=t(6540);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var l=r.createContext({}),u=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},c=function(e){var n=u(e.components);return r.createElement(l.Provider,{value:n},e.children)},p="mdxType",g={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),p=u(t),d=o,m=p["".concat(l,".").concat(d)]||p[d]||g[d]||a;return t?r.createElement(m,i(i({ref:n},c),{},{components:t})):r.createElement(m,i({ref:n},c))}));function m(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=d;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;upackage.json config",id:"via-packagejson-config",level:3},{value:"Extra Notes",id:"extra-notes",level:2},{value:"npm quirks",id:"npm-quirks",level:3}],g={toc:p},d="wrapper";function m(e){var n=e.components,t=(0,o.A)(e,i);return(0,a.yg)(d,(0,r.A)({},g,t,{components:n,mdxType:"MDXLayout"}),(0,a.yg)("p",null,"The Debug Mode can be enabled by setting the ",(0,a.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#debug"},(0,a.yg)("inlineCode",{parentName:"a"},"DEBUG"))," config options, which can be done by either setting it as a ",(0,a.yg)("a",{parentName:"p",href:"../api/config-options#how-to-use-them-as-environment-variables"},"Environment Variable")," or ",(0,a.yg)("a",{parentName:"p",href:"../api/config-options#how-to-use-them-in-the-packagejson"},(0,a.yg)("inlineCode",{parentName:"a"},"package.json")," option"),"."),(0,a.yg)("h2",{id:"examples"},"Examples"),(0,a.yg)("h3",{id:"via-environment-variable"},"Via Environment Variable"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-sh"},'# also available case-insensitive values: "on" "yes" "true"\nMONGOMS_DEBUG=1 npm run test\n')),(0,a.yg)("h3",{id:"via-packagejson-config"},"Via ",(0,a.yg)("inlineCode",{parentName:"h3"},"package.json")," config"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-json"},'{\n "config": {\n "mongodbMemoryServer": {\n "debug": "1", // also available case-insensitive values: "on" "yes" "true"\n }\n }\n}\n')),(0,a.yg)("h2",{id:"extra-notes"},"Extra Notes"),(0,a.yg)("h3",{id:"npm-quirks"},"npm quirks"),(0,a.yg)("p",null,"Starting with NPM 7, scripts (like ",(0,a.yg)("inlineCode",{parentName:"p"},"postinstall"),") will run in parallel and will not output any logging, but sometimes in ",(0,a.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server")," it is required to provide the Debug Log from a ",(0,a.yg)("inlineCode",{parentName:"p"},"postinstall")," script."),(0,a.yg)("p",null,"Logging can be temporarly enabled with:"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-sh"},"# Change scripts to be executed on the NPM main proccess instead of workers AND log script output\nMONGOMS_DEBUG=1 npm install --foreground-scripts\n")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6d7d5585.f5050671.js b/assets/js/6d7d5585.f5050671.js deleted file mode 100644 index e62824efe..000000000 --- a/assets/js/6d7d5585.f5050671.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[181],{3905:function(e,n,t){t.d(n,{Zo:function(){return c},kt:function(){return g}});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var l=r.createContext({}),u=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},c=function(e){var n=u(e.components);return r.createElement(l.Provider,{value:n},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},m=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),p=u(t),m=o,g=p["".concat(l,".").concat(m)]||p[m]||d[m]||a;return t?r.createElement(g,i(i({ref:n},c),{},{components:t})):r.createElement(g,i({ref:n},c))}));function g(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=m;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;upackage.json config",id:"via-packagejson-config",level:3},{value:"Extra Notes",id:"extra-notes",level:2},{value:"npm quirks",id:"npm-quirks",level:3}],d={toc:p},m="wrapper";function g(e){var n=e.components,t=(0,o.Z)(e,i);return(0,a.kt)(m,(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"The Debug Mode can be enabled by setting the ",(0,a.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#debug"},(0,a.kt)("inlineCode",{parentName:"a"},"DEBUG"))," config options, which can be done by either setting it as a ",(0,a.kt)("a",{parentName:"p",href:"../api/config-options#how-to-use-them-as-environment-variables"},"Environment Variable")," or ",(0,a.kt)("a",{parentName:"p",href:"../api/config-options#how-to-use-them-in-the-packagejson"},(0,a.kt)("inlineCode",{parentName:"a"},"package.json")," option"),"."),(0,a.kt)("h2",{id:"examples"},"Examples"),(0,a.kt)("h3",{id:"via-environment-variable"},"Via Environment Variable"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},'# also available case-insensitive values: "on" "yes" "true"\nMONGOMS_DEBUG=1 npm run test\n')),(0,a.kt)("h3",{id:"via-packagejson-config"},"Via ",(0,a.kt)("inlineCode",{parentName:"h3"},"package.json")," config"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-json"},'{\n "config": {\n "mongodbMemoryServer": {\n "debug": "1", // also available case-insensitive values: "on" "yes" "true"\n }\n }\n}\n')),(0,a.kt)("h2",{id:"extra-notes"},"Extra Notes"),(0,a.kt)("h3",{id:"npm-quirks"},"npm quirks"),(0,a.kt)("p",null,"Starting with NPM 7, scripts (like ",(0,a.kt)("inlineCode",{parentName:"p"},"postinstall"),") will run in parallel and will not output any logging, but sometimes in ",(0,a.kt)("inlineCode",{parentName:"p"},"mongodb-memory-server")," it is required to provide the Debug Log from a ",(0,a.kt)("inlineCode",{parentName:"p"},"postinstall")," script."),(0,a.kt)("p",null,"Logging can be temporarly enabled with:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"# Change scripts to be executed on the NPM main proccess instead of workers AND log script output\nMONGOMS_DEBUG=1 npm install --foreground-scripts\n")))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6fc6bd8d.7fc7d735.js b/assets/js/6fc6bd8d.7fc7d735.js deleted file mode 100644 index 86529f098..000000000 --- a/assets/js/6fc6bd8d.7fc7d735.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[84],{3905:function(e,t,n){n.d(t,{Zo:function(){return l},kt:function(){return y}});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var m=r.createContext({}),p=function(e){var t=r.useContext(m),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(m.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,m=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=p(n),d=o,y=u["".concat(m,".").concat(d)]||u[d]||c[d]||i;return n?r.createElement(y,a(a({ref:t},l),{},{components:n})):r.createElement(y,a({ref:t},l))}));function y(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=d;var s={};for(var m in t)hasOwnProperty.call(t,m)&&(s[m]=t[m]);s.originalType=e,s[u]="string"==typeof e?e:o,a[1]=s;for(var p=2;p=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var m=r.createContext({}),p=function(e){var t=r.useContext(m),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(m.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},y=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,m=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=p(n),y=o,g=u["".concat(m,".").concat(y)]||u[y]||c[y]||i;return n?r.createElement(g,a(a({ref:t},l),{},{components:n})):r.createElement(g,a({ref:t},l))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=y;var s={};for(var m in t)hasOwnProperty.call(t,m)&&(s[m]=t[m]);s.originalType=e,s[u]="string"==typeof e?e:o,a[1]=s;for(var p=2;p=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},u=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},l="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),l=s(n),m=o,f=l["".concat(p,".").concat(m)]||l[m]||d[m]||i;return n?r.createElement(f,a(a({ref:t},u),{},{components:n})):r.createElement(f,a({ref:t},u))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=m;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[l]="string"==typeof e?e:o,a[1]=c;for(var s=2;s=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},u=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},l="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),l=s(n),m=o,f=l["".concat(p,".").concat(m)]||l[m]||d[m]||i;return n?r.createElement(f,a(a({ref:t},u),{},{components:n})):r.createElement(f,a({ref:t},u))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=m;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[l]="string"==typeof e?e:o,a[1]=c;for(var s=2;s=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},c=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},m="mdxType",y={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),m=p(t),u=a,d=m["".concat(l,".").concat(u)]||m[u]||y[u]||i;return t?r.createElement(d,o(o({ref:n},c),{},{components:t})):r.createElement(d,o({ref:n},c))}));function d(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=u;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[m]="string"==typeof e?e:a,o[1]=s;for(var p=2;p")),(0,i.kt)("p",null,"Try to locate a existing binary without downloading or touching the filesystem much."),(0,i.kt)("h3",{id:"generateoptions"},"generateOptions"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static async generateOptions(opts?: DryMongoBinaryOptions): Promise>")),(0,i.kt)("p",null,"Generate a full ",(0,i.kt)("inlineCode",{parentName:"p"},"DryMongoBinaryOptions")," from partial input."),(0,i.kt)("h3",{id:"parsearchivenameregex"},"parseArchiveNameRegex"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static parseArchiveNameRegex(input: string, opts: Required): Required")),(0,i.kt)("p",null,"Parse a archive name into useable options."),(0,i.kt)("h3",{id:"getbinaryname"},"getBinaryName"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static async getBinaryName(opts: DryMongoBinaryNameOptions): Promise")),(0,i.kt)("p",null,"Get what the binary name should be formatted like.",(0,i.kt)("br",{parentName:"p"}),"\n","If ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#use_archive_name_for_binary_name"},(0,i.kt)("inlineCode",{parentName:"a"},"USE_ARCHIVE_NAME_FOR_BINARY_NAME"))," is ",(0,i.kt)("inlineCode",{parentName:"p"},"true"),", then the archive name will be used instead of what MMS uses by default."),(0,i.kt)("h3",{id:"combinebinaryname"},"combineBinaryName"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static combineBinaryName(basePath: string, binaryName: string): string")),(0,i.kt)("p",null,"Helper function to consistently combine a ",(0,i.kt)("inlineCode",{parentName:"p"},"basePath")," with the ",(0,i.kt)("inlineCode",{parentName:"p"},"binaryName")," (eg. ",(0,i.kt)("inlineCode",{parentName:"p"},"/path/to/binary"),")"),(0,i.kt)("h3",{id:"getsytempath"},"getSytemPath"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static async getSystemPath(systemBinary: string): Promise")),(0,i.kt)("p",null,"Check if the given path has all the permissions required to be executed."),(0,i.kt)("h3",{id:"generatepaths"},"generatePaths"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static async generatePaths(opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions): Promise")),(0,i.kt)("p",null,"Get the Paths where binaries may be located in."),(0,i.kt)("h3",{id:"generatedownloadpath"},"generateDownloadPath"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static async generateDownloadPath(opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions): Promise<[boolean, string]>")),(0,i.kt)("p",null,"Get the path where the binary will be downloaded to."),(0,i.kt)("h3",{id:"homedir"},"homedir"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"private static homedir(): string")),(0,i.kt)("p",null,"Used to get the Home-Dir of the current user, it is a function on the class for easy-mocking, because ",(0,i.kt)("inlineCode",{parentName:"p"},"os.homedir")," cannot be easily be mocked in jest."),(0,i.kt)("h2",{id:"values"},"Values"),(0,i.kt)("h3",{id:"binarycache"},"binaryCache"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static binaryCache: Map = new Map()")),(0,i.kt)("p",null,"Cache for already found binaries to not hit the filesystem too much."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7f2a500a.6574e89c.js b/assets/js/7f2a500a.6574e89c.js new file mode 100644 index 000000000..e4fc7d65b --- /dev/null +++ b/assets/js/7f2a500a.6574e89c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[73],{5680:function(e,n,t){t.d(n,{xA:function(){return p},yg:function(){return u}});var r=t(6540);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var y=r.createContext({}),l=function(e){var n=r.useContext(y),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(y.Provider,{value:n},e.children)},g="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},m=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,y=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),g=l(t),m=a,u=g["".concat(y,".").concat(m)]||g[m]||c[m]||i;return t?r.createElement(u,o(o({ref:n},p),{},{components:t})):r.createElement(u,o({ref:n},p))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=m;var s={};for(var y in n)hasOwnProperty.call(n,y)&&(s[y]=n[y]);s.originalType=e,s[g]="string"==typeof e?e:a,o[1]=s;for(var l=2;l")),(0,i.yg)("p",null,"Try to locate a existing binary without downloading or touching the filesystem much."),(0,i.yg)("h3",{id:"generateoptions"},"generateOptions"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static async generateOptions(opts?: DryMongoBinaryOptions): Promise>")),(0,i.yg)("p",null,"Generate a full ",(0,i.yg)("inlineCode",{parentName:"p"},"DryMongoBinaryOptions")," from partial input."),(0,i.yg)("h3",{id:"parsearchivenameregex"},"parseArchiveNameRegex"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static parseArchiveNameRegex(input: string, opts: Required): Required")),(0,i.yg)("p",null,"Parse a archive name into useable options."),(0,i.yg)("h3",{id:"getbinaryname"},"getBinaryName"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static async getBinaryName(opts: DryMongoBinaryNameOptions): Promise")),(0,i.yg)("p",null,"Get what the binary name should be formatted like.",(0,i.yg)("br",{parentName:"p"}),"\n","If ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#use_archive_name_for_binary_name"},(0,i.yg)("inlineCode",{parentName:"a"},"USE_ARCHIVE_NAME_FOR_BINARY_NAME"))," is ",(0,i.yg)("inlineCode",{parentName:"p"},"true"),", then the archive name will be used instead of what MMS uses by default."),(0,i.yg)("h3",{id:"combinebinaryname"},"combineBinaryName"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static combineBinaryName(basePath: string, binaryName: string): string")),(0,i.yg)("p",null,"Helper function to consistently combine a ",(0,i.yg)("inlineCode",{parentName:"p"},"basePath")," with the ",(0,i.yg)("inlineCode",{parentName:"p"},"binaryName")," (eg. ",(0,i.yg)("inlineCode",{parentName:"p"},"/path/to/binary"),")"),(0,i.yg)("h3",{id:"getsytempath"},"getSytemPath"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static async getSystemPath(systemBinary: string): Promise")),(0,i.yg)("p",null,"Check if the given path has all the permissions required to be executed."),(0,i.yg)("h3",{id:"generatepaths"},"generatePaths"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static async generatePaths(opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions): Promise")),(0,i.yg)("p",null,"Get the Paths where binaries may be located in."),(0,i.yg)("h3",{id:"generatedownloadpath"},"generateDownloadPath"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static async generateDownloadPath(opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions): Promise<[boolean, string]>")),(0,i.yg)("p",null,"Get the path where the binary will be downloaded to."),(0,i.yg)("h3",{id:"homedir"},"homedir"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"private static homedir(): string")),(0,i.yg)("p",null,"Used to get the Home-Dir of the current user, it is a function on the class for easy-mocking, because ",(0,i.yg)("inlineCode",{parentName:"p"},"os.homedir")," cannot be easily be mocked in jest."),(0,i.yg)("h2",{id:"values"},"Values"),(0,i.yg)("h3",{id:"binarycache"},"binaryCache"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static binaryCache: Map = new Map()")),(0,i.yg)("p",null,"Cache for already found binaries to not hit the filesystem too much."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/812a5cd9.82e78240.js b/assets/js/812a5cd9.82e78240.js deleted file mode 100644 index b9a262a13..000000000 --- a/assets/js/812a5cd9.82e78240.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[120],{3905:function(e,n,t){t.d(n,{Zo:function(){return d},kt:function(){return c}});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},d=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},k=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(t),k=a,c=u["".concat(s,".").concat(k)]||u[k]||m[k]||i;return t?r.createElement(c,o(o({ref:n},d),{},{components:t})):r.createElement(c,o({ref:n},d))}));function c(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=k;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var p=2;p=0||(a[r]=e[r]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=t.createContext({}),p=function(e){var n=t.useContext(s),r=n;return e&&(r="function"==typeof e?e(n):o(o({},n),e)),r},d=function(e){var n=p(e.components);return t.createElement(s.Provider,{value:n},e.children)},u="mdxType",g={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},y=t.forwardRef((function(e,n){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(r),y=a,m=u["".concat(s,".").concat(y)]||u[y]||g[y]||i;return r?t.createElement(m,o(o({ref:n},d),{},{components:r})):t.createElement(m,o({ref:n},d))}));function m(e,n){var r=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=y;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var p=2;p=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),m=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=m(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),c=m(r),f=o,d=c["".concat(l,".").concat(f)]||c[f]||p[f]||a;return r?n.createElement(d,i(i({ref:t},u),{},{components:r})):n.createElement(d,i({ref:t},u))}));function d(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=f;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:o,i[1]=s;for(var m=2;m=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),m=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=m(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),c=m(r),y=o,g=c["".concat(l,".").concat(y)]||c[y]||p[y]||a;return r?n.createElement(g,i(i({ref:t},u),{},{components:r})):n.createElement(g,i({ref:t},u))}));function g(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=y;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:o,i[1]=s;for(var m=2;m=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=r.createContext({}),u=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=u(e.components);return r.createElement(s.Provider,{value:n},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},m=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),p=u(t),m=o,k=p["".concat(s,".").concat(m)]||p[m]||d[m]||i;return t?r.createElement(k,a(a({ref:n},c),{},{components:t})):r.createElement(k,a({ref:n},c))}));function k(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var i=t.length,a=new Array(i);a[0]=m;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[p]="string"==typeof e?e:o,a[1]=l;for(var u=2;u=0||(t[r]=e[r]);return t}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(t[r]=e[r])}return t}var s=o.createContext({}),u=function(e){var n=o.useContext(s),r=n;return e&&(r="function"==typeof e?e(n):a(a({},n),e)),r},c=function(e){var n=u(e.components);return o.createElement(s.Provider,{value:n},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},m=o.forwardRef((function(e,n){var r=e.components,t=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),p=u(r),m=t,y=p["".concat(s,".").concat(m)]||p[m]||d[m]||i;return r?o.createElement(y,a(a({ref:n},c),{},{components:r})):o.createElement(y,a({ref:n},c))}));function y(e,n){var r=arguments,t=n&&n.mdxType;if("string"==typeof e||t){var i=r.length,a=new Array(i);a[0]=m;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[p]="string"==typeof e?e:t,a[1]=l;for(var u=2;u=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=o.createContext({}),p=function(e){var n=o.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},d=function(e){var n=p(e.components);return o.createElement(s.Provider,{value:n},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},u=o.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=p(t),u=a,g=c["".concat(s,".").concat(u)]||c[u]||m[u]||i;return t?o.createElement(g,r(r({ref:n},d),{},{components:t})):o.createElement(g,r({ref:n},d))}));function g(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,r=new Array(i);r[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[c]="string"==typeof e?e:a,r[1]=l;for(var p=2;p7.0.0 <8.0.0"),", please consult the ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md"},"CHANGELOG"))),(0,i.kt)("h2",{id:"requirement-changes"},"Requirement Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Nodejs ",(0,i.kt)("inlineCode",{parentName:"li"},"10")," & ",(0,i.kt)("inlineCode",{parentName:"li"},"11")," are now unsupported, lowest supported version is now ",(0,i.kt)("inlineCode",{parentName:"li"},"14.0"))),(0,i.kt)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,i.kt)("h3",{id:"no-function-other-than-start-create-ensureinstance-will-be-starting-anything"},"no function other than start, create, ensureInstance will be starting anything"),(0,i.kt)("p",null,"For 7.0.0, the only functions that start / wait for an starting instance will be ",(0,i.kt)("inlineCode",{parentName:"p"},"create"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"start")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"ensureInstance")),(0,i.kt)("p",null,"Example:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// this no longer works\nconst mongo = new MongoMemoryServer();\nconst uri = await mongo.getUri(); // ERROR: instance not started\n\n// it is now\nconst mongo = await MongoMemoryServer.create();\nconst uri = mongo.getUri();\n")),(0,i.kt)("h3",{id:"geturi-is-no-longer-async"},"getUri is no longer async"),(0,i.kt)("p",null,"For 7.0.0, all ",(0,i.kt)("inlineCode",{parentName:"p"},".getUri")," are now sync, see ",(0,i.kt)("a",{parentName:"p",href:"#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"},"this change")),(0,i.kt)("h3",{id:"new-no-longer-automatically-starts"},"new no longer automatically starts"),(0,i.kt)("p",null,"Until 7.0.0, ",(0,i.kt)("inlineCode",{parentName:"p"},"new")," (",(0,i.kt)("inlineCode",{parentName:"p"},"constructor"),") automatically started the instance, which is no longer the case, for this behaviour use ",(0,i.kt)("inlineCode",{parentName:"p"},".create"),", see ",(0,i.kt)("a",{parentName:"p",href:"#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"},"this change")),(0,i.kt)("h3",{id:"mongod-binaries-storage-path-changed"},"mongod binaries storage path changed"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"mongod")," binary path changed from ",(0,i.kt)("inlineCode",{parentName:"p"},"basePath/version/mongod")," to ",(0,i.kt)("inlineCode",{parentName:"p"},"basePath/mongod-arch-dist-version"),(0,i.kt)("br",{parentName:"p"}),"\n","This will make it easier to work with sharing the project folder (like host to docker)"),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"This package will ",(0,i.kt)("strong",{parentName:"p"},"not")," delete the old binaries, these need to be manually deleted, see ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#download_dir"},"storage paths")," for where binaries are stored")),(0,i.kt)("h3",{id:"getconnectionstring-got-removed"},"getConnectionString got removed"),(0,i.kt)("p",null,"Function ",(0,i.kt)("inlineCode",{parentName:"p"},"getConnectionString")," got removed in favor of just ",(0,i.kt)("inlineCode",{parentName:"p"},"getUri")),(0,i.kt)("h3",{id:"mongoinstancewaitprimaryready-got-removed"},"MongoInstance.waitPrimaryReady got removed"),(0,i.kt)("p",null,"Function ",(0,i.kt)("inlineCode",{parentName:"p"},"MongoInstance.prototype.waitPrimaryReady")," got removed, in favor of listening to event ",(0,i.kt)("inlineCode",{parentName:"p"},"instancePrimary")),(0,i.kt)("h3",{id:"functions-that-returned-public-values-on-classes-got-removed"},"Functions that returned public values on classes got removed"),(0,i.kt)("p",null,"Functions like ",(0,i.kt)("inlineCode",{parentName:"p"},"MongoMemoryServer.prototype.getInstanceInfo")," got removed in favor of ",(0,i.kt)("inlineCode",{parentName:"p"},"MongoMemoryServer.prototype.instanceInfo")," (readonly value)"),(0,i.kt)("p",null,"These include:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.getInstanceInfo")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.instanceInfo")," (readonly value)"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.getPort")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.instanceInfo.port")," (readonly value)"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.getDbPath")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.instanceInfo.dbPath")," (readonly value)"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.getDbName")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.instanceInfo.dbName")," (readonly value)"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryReplSet.prototype.getDbName")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoMemoryReplSet.prototype.opts.replSet.db")," (readonly value)"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"MongoInstance.prototype.getPid")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoInstance.prototype.mongodProcess.pid")," (readonly value)")),(0,i.kt)("h3",{id:"manager-class-functions-got-unified"},"Manager Class functions got unified"),(0,i.kt)("p",null,"Manager-Classes got unified, these include ",(0,i.kt)("inlineCode",{parentName:"p"},"MongoMemoryServer"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"MongoMemoryReplSet"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"MongoInstance"),(0,i.kt)("br",{parentName:"p"}),"\n","This means that all of them have unified typings for ",(0,i.kt)("inlineCode",{parentName:"p"},"start"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"stop"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"create"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"getUri"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"cleanup")),(0,i.kt)("p",null,"This also includes function renames:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"(static) ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoInstance.run")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoInstance.create")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"MongoInstance.prototype.run")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoInstance.prototype.start")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"MongoInstance.prototype.kill")," -> ",(0,i.kt)("inlineCode",{parentName:"li"},"MongoInstance.prototype.stop"))),(0,i.kt)("h3",{id:"geturi-by-default-does-not-include-any-dbname-anymore"},"getUri by default does not include any dbName anymore"),(0,i.kt)("p",null,"This was changed to allow mongodb and mongoose URI's to work at the same time (they slightly differ)."),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/3624253f509a54cff04997943894b9eb7e7e64fe/packages/mongodb-memory-server-core/src/util/utils.ts#L13-L17"},"See the code comment for more information")),(0,i.kt)("h2",{id:"non-breaking-changes--additions"},"Non-Breaking changes / Additions"),(0,i.kt)("h3",{id:"config-values-are-now-collected-in-an-enum"},"Config Values are now collected in an enum"),(0,i.kt)("p",null,"Config values like ",(0,i.kt)("inlineCode",{parentName:"p"},"DOWNLOAD_DIR")," are now collected in an enum called ",(0,i.kt)("inlineCode",{parentName:"p"},"ResolveConfigVariables"),", ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options"},"see more here")),(0,i.kt)("h3",{id:"config-helper-function-envname"},'Config helper function "envName"'),(0,i.kt)("p",null,"An helper function named ",(0,i.kt)("inlineCode",{parentName:"p"},"envName")," is introduced into 7.0.0, which does:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// previously\nprocess.env[ENV_CONFIG_PREFIX + ResolveConfigVariables.DOWNLOAD_DIR] = 'someValue';\n\n// now\nprocess.env(envName(ResolveConfigVariables.DOWNLOAD_DIR)) = 'someValue';\n")),(0,i.kt)("p",null,"this does not only save space, but also provide direct auto-completion-suggestions for ",(0,i.kt)("inlineCode",{parentName:"p"},"ResolveConfigVariables")),(0,i.kt)("h3",{id:"all-manager-classes-are-now-extending-eventemitter"},"All Manager Classes are now extending EventEmitter"),(0,i.kt)("p",null,"All Manager-Classes are now extending ",(0,i.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", which makes them easier to use and listen for changes"),(0,i.kt)("h3",{id:"automatic-authentication-creation"},"Automatic Authentication creation"),(0,i.kt)("p",null,"For 7.0.0 there is now Automatic Authentication created, which can be enabled by providing config option ",(0,i.kt)("inlineCode",{parentName:"p"},"auth")," in the code"),(0,i.kt)("p",null,"Example:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'// This will create an Auth-enabled instance with default auth-values\nconst mongoServer = await MongoMemoryServer.create({\n auth: {}, // anything else than "undefined / null" will enable auth, can be explicitly disabled with "auth: { disable: true }"\n instance: {\n auth: true,\n storageEngine: \'wiredTiger\',\n },\n});\n')),(0,i.kt)("admonition",{type:"info"},(0,i.kt)("p",{parentName:"admonition"},"The Instance will not be restarted if the storage engine is ",(0,i.kt)("inlineCode",{parentName:"p"},"ephemeralForTest")," because data will not persist across restarts",(0,i.kt)("br",null))),(0,i.kt)("p",null,"For available Values look into either the source code or let intellisense show values"),(0,i.kt)("h3",{id:"explicit--implicit-cleanup"},"Explicit & Implicit Cleanup"),(0,i.kt)("p",null,"Cleanup behaviour can now be controlled, default is an ",(0,i.kt)("inlineCode",{parentName:"p"},"tmpDir")," that will get automatically removed on instance-stop / process exit, if it is not an ",(0,i.kt)("inlineCode",{parentName:"p"},"tmpDir")," then ",(0,i.kt)("inlineCode",{parentName:"p"},".cleanup")," needs to be manually called with ",(0,i.kt)("inlineCode",{parentName:"p"},"true")," (force) "),(0,i.kt)("p",null,"If persistence between restarts is wanted (even if it is an ",(0,i.kt)("inlineCode",{parentName:"p"},"tmpDir"),"), then call ",(0,i.kt)("inlineCode",{parentName:"p"},".stop")," with ",(0,i.kt)("inlineCode",{parentName:"p"},"false")," (",(0,i.kt)("inlineCode",{parentName:"p"},"cleanup")," for ",(0,i.kt)("inlineCode",{parentName:"p"},"tmpDir")," will still be run on process exit)"),(0,i.kt)("h3",{id:"replsets-can-now-gracefully-exit"},"ReplSet's can now gracefully exit"),(0,i.kt)("p",null,"Since Mongod ~4.2 replset's dont exit anymore on ",(0,i.kt)("inlineCode",{parentName:"p"},"SIGTERM")," if they cannot step-down (no other instance to give primary to)",(0,i.kt)("br",{parentName:"p"}),"\n","In 7.0.0 this is now handled with mongodb command ",(0,i.kt)("inlineCode",{parentName:"p"},"replSetStepDown: 1, force: true")),(0,i.kt)("h3",{id:"linux-distribution-detection-enhanced"},"Linux Distribution Detection enhanced"),(0,i.kt)("p",null,"For 7.0.0, the Linux Distribution Detection got enhanced, now preferring to use ",(0,i.kt)("inlineCode",{parentName:"p"},"/etc/upstream-release/lsb-release")," instead of the ",(0,i.kt)("inlineCode",{parentName:"p"},"/etc/")," ones, which enables based-on distributions to be easier mapped (and fallback correctly)"),(0,i.kt)("p",null,"This mostly impacts Debian based distros and Ubuntu based distros"),(0,i.kt)("h3",{id:"archlinux-got-somewhat-supported"},"ArchLinux got somewhat supported"),(0,i.kt)("p",null,"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)"),(0,i.kt)("h3",{id:"runtime-downloads-can-now-be-disabled-or-explicitly-enabled"},"Runtime downloads can now be disabled or explicitly enabled"),(0,i.kt)("p",null,"Version 7.0.0 brings an new config value named ",(0,i.kt)("inlineCode",{parentName:"p"},"RUNTIME_DOWNLOAD"),", which is an boolean, to disable Runtime Downloads or explicitly enable them"),(0,i.kt)("h3",{id:"unified-common-errors"},"Unified Common Errors"),(0,i.kt)("p",null,"In pre-7.0.0, errors were all over the place, now the most common are unified into custom errors"))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8f715786.f986d602.js b/assets/js/8f715786.f986d602.js new file mode 100644 index 000000000..cb7654f60 --- /dev/null +++ b/assets/js/8f715786.f986d602.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[287],{5680:function(e,n,t){t.d(n,{xA:function(){return p},yg:function(){return u}});var o=t(6540);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,o)}return t}function r(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=o.createContext({}),g=function(e){var n=o.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},p=function(e){var n=g(e.components);return o.createElement(s.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},m=o.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=g(t),m=a,u=d["".concat(s,".").concat(m)]||d[m]||c[m]||i;return t?o.createElement(u,r(r({ref:n},p),{},{components:t})):o.createElement(u,r({ref:n},p))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,r=new Array(i);r[0]=m;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[d]="string"==typeof e?e:a,r[1]=l;for(var g=2;g7.0.0 <8.0.0"),", please consult the ",(0,i.yg)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md"},"CHANGELOG"))),(0,i.yg)("h2",{id:"requirement-changes"},"Requirement Changes"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"Nodejs ",(0,i.yg)("inlineCode",{parentName:"li"},"10")," & ",(0,i.yg)("inlineCode",{parentName:"li"},"11")," are now unsupported, lowest supported version is now ",(0,i.yg)("inlineCode",{parentName:"li"},"14.0"))),(0,i.yg)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,i.yg)("h3",{id:"no-function-other-than-start-create-ensureinstance-will-be-starting-anything"},"no function other than start, create, ensureInstance will be starting anything"),(0,i.yg)("p",null,"For 7.0.0, the only functions that start / wait for an starting instance will be ",(0,i.yg)("inlineCode",{parentName:"p"},"create"),", ",(0,i.yg)("inlineCode",{parentName:"p"},"start")," and ",(0,i.yg)("inlineCode",{parentName:"p"},"ensureInstance")),(0,i.yg)("p",null,"Example:"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-ts"},"// this no longer works\nconst mongo = new MongoMemoryServer();\nconst uri = await mongo.getUri(); // ERROR: instance not started\n\n// it is now\nconst mongo = await MongoMemoryServer.create();\nconst uri = mongo.getUri();\n")),(0,i.yg)("h3",{id:"geturi-is-no-longer-async"},"getUri is no longer async"),(0,i.yg)("p",null,"For 7.0.0, all ",(0,i.yg)("inlineCode",{parentName:"p"},".getUri")," are now sync, see ",(0,i.yg)("a",{parentName:"p",href:"#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"},"this change")),(0,i.yg)("h3",{id:"new-no-longer-automatically-starts"},"new no longer automatically starts"),(0,i.yg)("p",null,"Until 7.0.0, ",(0,i.yg)("inlineCode",{parentName:"p"},"new")," (",(0,i.yg)("inlineCode",{parentName:"p"},"constructor"),") automatically started the instance, which is no longer the case, for this behaviour use ",(0,i.yg)("inlineCode",{parentName:"p"},".create"),", see ",(0,i.yg)("a",{parentName:"p",href:"#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"},"this change")),(0,i.yg)("h3",{id:"mongod-binaries-storage-path-changed"},"mongod binaries storage path changed"),(0,i.yg)("p",null,(0,i.yg)("inlineCode",{parentName:"p"},"mongod")," binary path changed from ",(0,i.yg)("inlineCode",{parentName:"p"},"basePath/version/mongod")," to ",(0,i.yg)("inlineCode",{parentName:"p"},"basePath/mongod-arch-dist-version"),(0,i.yg)("br",{parentName:"p"}),"\n","This will make it easier to work with sharing the project folder (like host to docker)"),(0,i.yg)("admonition",{type:"note"},(0,i.yg)("p",{parentName:"admonition"},"This package will ",(0,i.yg)("strong",{parentName:"p"},"not")," delete the old binaries, these need to be manually deleted, see ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#download_dir"},"storage paths")," for where binaries are stored")),(0,i.yg)("h3",{id:"getconnectionstring-got-removed"},"getConnectionString got removed"),(0,i.yg)("p",null,"Function ",(0,i.yg)("inlineCode",{parentName:"p"},"getConnectionString")," got removed in favor of just ",(0,i.yg)("inlineCode",{parentName:"p"},"getUri")),(0,i.yg)("h3",{id:"mongoinstancewaitprimaryready-got-removed"},"MongoInstance.waitPrimaryReady got removed"),(0,i.yg)("p",null,"Function ",(0,i.yg)("inlineCode",{parentName:"p"},"MongoInstance.prototype.waitPrimaryReady")," got removed, in favor of listening to event ",(0,i.yg)("inlineCode",{parentName:"p"},"instancePrimary")),(0,i.yg)("h3",{id:"functions-that-returned-public-values-on-classes-got-removed"},"Functions that returned public values on classes got removed"),(0,i.yg)("p",null,"Functions like ",(0,i.yg)("inlineCode",{parentName:"p"},"MongoMemoryServer.prototype.getInstanceInfo")," got removed in favor of ",(0,i.yg)("inlineCode",{parentName:"p"},"MongoMemoryServer.prototype.instanceInfo")," (readonly value)"),(0,i.yg)("p",null,"These include:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.getInstanceInfo")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.instanceInfo")," (readonly value)"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.getPort")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.instanceInfo.port")," (readonly value)"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.getDbPath")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.instanceInfo.dbPath")," (readonly value)"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.getDbName")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryServer.prototype.instanceInfo.dbName")," (readonly value)"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryReplSet.prototype.getDbName")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoMemoryReplSet.prototype.opts.replSet.db")," (readonly value)"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"MongoInstance.prototype.getPid")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoInstance.prototype.mongodProcess.pid")," (readonly value)")),(0,i.yg)("h3",{id:"manager-class-functions-got-unified"},"Manager Class functions got unified"),(0,i.yg)("p",null,"Manager-Classes got unified, these include ",(0,i.yg)("inlineCode",{parentName:"p"},"MongoMemoryServer"),", ",(0,i.yg)("inlineCode",{parentName:"p"},"MongoMemoryReplSet"),", ",(0,i.yg)("inlineCode",{parentName:"p"},"MongoInstance"),(0,i.yg)("br",{parentName:"p"}),"\n","This means that all of them have unified typings for ",(0,i.yg)("inlineCode",{parentName:"p"},"start"),", ",(0,i.yg)("inlineCode",{parentName:"p"},"stop"),", ",(0,i.yg)("inlineCode",{parentName:"p"},"create"),", ",(0,i.yg)("inlineCode",{parentName:"p"},"getUri"),", ",(0,i.yg)("inlineCode",{parentName:"p"},"cleanup")),(0,i.yg)("p",null,"This also includes function renames:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"(static) ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoInstance.run")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoInstance.create")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"MongoInstance.prototype.run")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoInstance.prototype.start")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"MongoInstance.prototype.kill")," -> ",(0,i.yg)("inlineCode",{parentName:"li"},"MongoInstance.prototype.stop"))),(0,i.yg)("h3",{id:"geturi-by-default-does-not-include-any-dbname-anymore"},"getUri by default does not include any dbName anymore"),(0,i.yg)("p",null,"This was changed to allow mongodb and mongoose URI's to work at the same time (they slightly differ)."),(0,i.yg)("p",null,(0,i.yg)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/3624253f509a54cff04997943894b9eb7e7e64fe/packages/mongodb-memory-server-core/src/util/utils.ts#L13-L17"},"See the code comment for more information")),(0,i.yg)("h2",{id:"non-breaking-changes--additions"},"Non-Breaking changes / Additions"),(0,i.yg)("h3",{id:"config-values-are-now-collected-in-an-enum"},"Config Values are now collected in an enum"),(0,i.yg)("p",null,"Config values like ",(0,i.yg)("inlineCode",{parentName:"p"},"DOWNLOAD_DIR")," are now collected in an enum called ",(0,i.yg)("inlineCode",{parentName:"p"},"ResolveConfigVariables"),", ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options"},"see more here")),(0,i.yg)("h3",{id:"config-helper-function-envname"},'Config helper function "envName"'),(0,i.yg)("p",null,"An helper function named ",(0,i.yg)("inlineCode",{parentName:"p"},"envName")," is introduced into 7.0.0, which does:"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-ts"},"// previously\nprocess.env[ENV_CONFIG_PREFIX + ResolveConfigVariables.DOWNLOAD_DIR] = 'someValue';\n\n// now\nprocess.env(envName(ResolveConfigVariables.DOWNLOAD_DIR)) = 'someValue';\n")),(0,i.yg)("p",null,"this does not only save space, but also provide direct auto-completion-suggestions for ",(0,i.yg)("inlineCode",{parentName:"p"},"ResolveConfigVariables")),(0,i.yg)("h3",{id:"all-manager-classes-are-now-extending-eventemitter"},"All Manager Classes are now extending EventEmitter"),(0,i.yg)("p",null,"All Manager-Classes are now extending ",(0,i.yg)("inlineCode",{parentName:"p"},"EventEmitter"),", which makes them easier to use and listen for changes"),(0,i.yg)("h3",{id:"automatic-authentication-creation"},"Automatic Authentication creation"),(0,i.yg)("p",null,"For 7.0.0 there is now Automatic Authentication created, which can be enabled by providing config option ",(0,i.yg)("inlineCode",{parentName:"p"},"auth")," in the code"),(0,i.yg)("p",null,"Example:"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-ts"},'// This will create an Auth-enabled instance with default auth-values\nconst mongoServer = await MongoMemoryServer.create({\n auth: {}, // anything else than "undefined / null" will enable auth, can be explicitly disabled with "auth: { disable: true }"\n instance: {\n auth: true,\n storageEngine: \'wiredTiger\',\n },\n});\n')),(0,i.yg)("admonition",{type:"info"},(0,i.yg)("p",{parentName:"admonition"},"The Instance will not be restarted if the storage engine is ",(0,i.yg)("inlineCode",{parentName:"p"},"ephemeralForTest")," because data will not persist across restarts",(0,i.yg)("br",null))),(0,i.yg)("p",null,"For available Values look into either the source code or let intellisense show values"),(0,i.yg)("h3",{id:"explicit--implicit-cleanup"},"Explicit & Implicit Cleanup"),(0,i.yg)("p",null,"Cleanup behaviour can now be controlled, default is an ",(0,i.yg)("inlineCode",{parentName:"p"},"tmpDir")," that will get automatically removed on instance-stop / process exit, if it is not an ",(0,i.yg)("inlineCode",{parentName:"p"},"tmpDir")," then ",(0,i.yg)("inlineCode",{parentName:"p"},".cleanup")," needs to be manually called with ",(0,i.yg)("inlineCode",{parentName:"p"},"true")," (force) "),(0,i.yg)("p",null,"If persistence between restarts is wanted (even if it is an ",(0,i.yg)("inlineCode",{parentName:"p"},"tmpDir"),"), then call ",(0,i.yg)("inlineCode",{parentName:"p"},".stop")," with ",(0,i.yg)("inlineCode",{parentName:"p"},"false")," (",(0,i.yg)("inlineCode",{parentName:"p"},"cleanup")," for ",(0,i.yg)("inlineCode",{parentName:"p"},"tmpDir")," will still be run on process exit)"),(0,i.yg)("h3",{id:"replsets-can-now-gracefully-exit"},"ReplSet's can now gracefully exit"),(0,i.yg)("p",null,"Since Mongod ~4.2 replset's dont exit anymore on ",(0,i.yg)("inlineCode",{parentName:"p"},"SIGTERM")," if they cannot step-down (no other instance to give primary to)",(0,i.yg)("br",{parentName:"p"}),"\n","In 7.0.0 this is now handled with mongodb command ",(0,i.yg)("inlineCode",{parentName:"p"},"replSetStepDown: 1, force: true")),(0,i.yg)("h3",{id:"linux-distribution-detection-enhanced"},"Linux Distribution Detection enhanced"),(0,i.yg)("p",null,"For 7.0.0, the Linux Distribution Detection got enhanced, now preferring to use ",(0,i.yg)("inlineCode",{parentName:"p"},"/etc/upstream-release/lsb-release")," instead of the ",(0,i.yg)("inlineCode",{parentName:"p"},"/etc/")," ones, which enables based-on distributions to be easier mapped (and fallback correctly)"),(0,i.yg)("p",null,"This mostly impacts Debian based distros and Ubuntu based distros"),(0,i.yg)("h3",{id:"archlinux-got-somewhat-supported"},"ArchLinux got somewhat supported"),(0,i.yg)("p",null,"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)"),(0,i.yg)("h3",{id:"runtime-downloads-can-now-be-disabled-or-explicitly-enabled"},"Runtime downloads can now be disabled or explicitly enabled"),(0,i.yg)("p",null,"Version 7.0.0 brings an new config value named ",(0,i.yg)("inlineCode",{parentName:"p"},"RUNTIME_DOWNLOAD"),", which is an boolean, to disable Runtime Downloads or explicitly enable them"),(0,i.yg)("h3",{id:"unified-common-errors"},"Unified Common Errors"),(0,i.yg)("p",null,"In pre-7.0.0, errors were all over the place, now the most common are unified into custom errors"))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9082ebdf.77115fcc.js b/assets/js/9082ebdf.77115fcc.js deleted file mode 100644 index 73340412d..000000000 --- a/assets/js/9082ebdf.77115fcc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[895],{3905:function(e,t,r){r.d(t,{Zo:function(){return s},kt:function(){return b}});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),d=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},p="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},g=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,s=m(e,["components","mdxType","originalType","parentName"]),p=d(r),g=a,b=p["".concat(l,".").concat(g)]||p[g]||c[g]||o;return r?n.createElement(b,i(i({ref:t},s),{},{components:r})):n.createElement(b,i({ref:t},s))}));function b(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=g;var m={};for(var l in t)hasOwnProperty.call(t,l)&&(m[l]=t[l]);m.originalType=e,m[p]="string"==typeof e?e:a,i[1]=m;for(var d=2;dmongodb-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}],c={toc:p},g="wrapper";function b(e){var t=e.components,r=(0,a.Z)(e,i);return(0,o.kt)(g,(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,"This Guide will show what MongoDB Server versions are / were the default for versions of ",(0,o.kt)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," and the guidelines of when a version gets changed."),(0,o.kt)("p",null,(0,o.kt)("em",{parentName:"p"},(0,o.kt)("sub",null,"Some expressions will use ",(0,o.kt)("a",{parentName:"em",href:"https://www.npmjs.com/package/semver"},"npm's semver convention"),"."))),(0,o.kt)("h2",{id:"when-a-version-gets-upgraded"},"When a Version gets upgraded"),(0,o.kt)("p",null,"In a new major version of ",(0,o.kt)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.kt)("inlineCode",{parentName:"p"},"X.0.0"),"), the default mongodb binary version may be upgraded to any newer version (",(0,o.kt)("inlineCode",{parentName:"p"},"X.X.X"),").",(0,o.kt)("br",{parentName:"p"}),"\n","In a minor version of ",(0,o.kt)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.kt)("inlineCode",{parentName:"p"},"0.X.0"),"), the default mongodb binary version may be upgraded to the latest patch version ",(0,o.kt)("inlineCode",{parentName:"p"},"0.0.X"),".",(0,o.kt)("br",{parentName:"p"}),"\n","In a patch version of ",(0,o.kt)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," (",(0,o.kt)("inlineCode",{parentName:"p"},"0.0.X"),"), the default mongodb binary version will not be changed."),(0,o.kt)("p",null,"There are some exceptions:"),(0,o.kt)("ul",null,(0,o.kt)("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.kt)("em",{parentName:"li"},"minor")," (",(0,o.kt)("inlineCode",{parentName:"li"},"0.X.0"),") release will happen."),(0,o.kt)("li",{parentName:"ul"},"A mongodb binary may be broken, then the default version will be changed and a ",(0,o.kt)("em",{parentName:"li"},"minor")," (",(0,o.kt)("inlineCode",{parentName:"li"},"0.X.0"),") release will happen.")),(0,o.kt)("p",null,"The versions with a broken default binary may get deprecated (when possible)."),(0,o.kt)("p",null,"For Packages that are named with a version (like ",(0,o.kt)("inlineCode",{parentName:"p"},"mongodb-memory-server-global-4.2"),"), the patch version (",(0,o.kt)("inlineCode",{parentName:"p"},"0.0.X"),") of a binary may be changed with minor (",(0,o.kt)("inlineCode",{parentName:"p"},"0.X.0"),") releases."),(0,o.kt)("admonition",{type:"note"},(0,o.kt)("p",{parentName:"admonition"},"Starting with MongoDB version 5.0, the default versions for ",(0,o.kt)("inlineCode",{parentName:"p"},"mongodb-memory-server-core")," will only be major ",(0,o.kt)("inlineCode",{parentName:"p"},"X.0.0")," versions (no ",(0,o.kt)("inlineCode",{parentName:"p"},"X.X.0")," versions), see ",(0,o.kt)("a",{parentName:"p",href:"https://docs.mongodb.com/manual/reference/versioning/#std-label-release-version-numbers"},"MongoDB Versioning"),".")),(0,o.kt)("h2",{id:"mongodb-memory-server-core-version-table"},(0,o.kt)("inlineCode",{parentName:"h2"},"mongodb-memory-server-core")," Version Table"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"th"},"mongodb-memory-server-core")," Version"),(0,o.kt)("th",{parentName:"tr",align:"center"},"Default MongoDB Version"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"10.0.x - 10.0.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"7.0.11")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"9.2.x - 9.2.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"6.0.14")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"9.0.x - 9.1.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"6.0.9")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"8.14.x - 8.16.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"5.0.19")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"8.13.x - 8.13.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"5.0.18")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"8.11.x - 8.12.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"5.0.13")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"8.6.x - 8.10.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"5.0.8")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"8.0.x - 8.5.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"5.0.3")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"7.5.x - 7.5.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"4.0.27")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"7.0.x - 7.4.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"4.0.25")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"6.4.x - 6.9.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"4.0.14")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},"6.0.x - 6.4.x"),(0,o.kt)("td",{parentName:"tr",align:"center"},"4.0.3")))),(0,o.kt)("h2",{id:"mongodb-memory-server-global--version-table"},(0,o.kt)("inlineCode",{parentName:"h2"},"mongodb-memory-server-global-*")," Version Table"),(0,o.kt)("p",null,"This Section will show all ",(0,o.kt)("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.kt)("p",null,"If the branch is named like ",(0,o.kt)("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.kt)("inlineCode",{parentName:"p"},"old/6.x"),", then it will not get any updates to MMS 7.0 or higher)"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"center"},"Package Name"),(0,o.kt)("th",{parentName:"tr",align:"center"},"Provided MongoDB Version"),(0,o.kt)("th",{parentName:"tr",align:"center"},"Current Branch"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.4")),(0,o.kt)("td",{parentName:"tr",align:"center"},"4.4.28"),(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"master"))),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.2")),(0,o.kt)("td",{parentName:"tr",align:"center"},"4.2.24"),(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"master"))),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-4.0")),(0,o.kt)("td",{parentName:"tr",align:"center"},"4.0.28"),(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"master"))),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-3.6")),(0,o.kt)("td",{parentName:"tr",align:"center"},"3.6.23"),(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"old/7.x"))),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"mongodb-memory-server-global-3.4")),(0,o.kt)("td",{parentName:"tr",align:"center"},"3.4.20"),(0,o.kt)("td",{parentName:"tr",align:"center"},(0,o.kt)("inlineCode",{parentName:"td"},"old/6.x"))))))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9082ebdf.dd089d94.js b/assets/js/9082ebdf.dd089d94.js new file mode 100644 index 000000000..20b4ed7aa --- /dev/null +++ b/assets/js/9082ebdf.dd089d94.js @@ -0,0 +1 @@ +"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.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/935f2afb.3691dd17.js b/assets/js/935f2afb.3691dd17.js new file mode 100644 index 000000000..a1daccbfa --- /dev/null +++ b/assets/js/935f2afb.3691dd17.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[581],{5610:function(e){e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"api":[{"type":"category","label":"Start","items":[{"type":"link","label":"Welcome to the API","href":"/mongodb-memory-server/docs/api/index-api","docId":"api/index-api"},{"type":"link","label":"Config Options","href":"/mongodb-memory-server/docs/api/config-options","docId":"api/config-options"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Classes","items":[{"type":"link","label":"MongoMemoryServer","href":"/mongodb-memory-server/docs/api/classes/mongo-memory-server","docId":"api/classes/mongo-memory-server"},{"type":"link","label":"MongoMemoryReplSet","href":"/mongodb-memory-server/docs/api/classes/mongo-memory-replset","docId":"api/classes/mongo-memory-replset"},{"type":"link","label":"MongoInstance","href":"/mongodb-memory-server/docs/api/classes/mongo-instance","docId":"api/classes/mongo-instance"},{"type":"link","label":"MongoBinary","href":"/mongodb-memory-server/docs/api/classes/mongo-binary","docId":"api/classes/mongo-binary"},{"type":"link","label":"DryMongoBinary","href":"/mongodb-memory-server/docs/api/classes/dry-mongo-binary","docId":"api/classes/dry-mongo-binary"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Enums","items":[{"type":"link","label":"MongoMemoryServerStates","href":"/mongodb-memory-server/docs/api/enums/mongo-memory-server-states","docId":"api/enums/mongo-memory-server-states"},{"type":"link","label":"MongoMemoryReplSetStates","href":"/mongodb-memory-server/docs/api/enums/mongo-memory-replset-states","docId":"api/enums/mongo-memory-replset-states"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Interfaces","items":[{"type":"link","label":"MongoMemoryServerOpts","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-opts","docId":"api/interfaces/mongo-memory-server-opts"},{"type":"link","label":"AutomaticAuth","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-automaticauth","docId":"api/interfaces/mongo-memory-server-automaticauth"},{"type":"link","label":"CreateUser","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-createuser","docId":"api/interfaces/mongo-memory-server-createuser"},{"type":"link","label":"MongoMemoryInstanceOpts","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-instance-opts","docId":"api/interfaces/mongo-memory-instance-opts"},{"type":"link","label":"ReplicaMemberConfig","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-instance-replicamemberconfig","docId":"api/interfaces/mongo-memory-instance-replicamemberconfig"},{"type":"link","label":"MongoBinaryOpts","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-binary-opts","docId":"api/interfaces/mongo-memory-binary-opts"},{"type":"link","label":"MongoMemoryReplSetOpts","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-replset-opts","docId":"api/interfaces/mongo-memory-replset-opts"},{"type":"link","label":"DisposeOptions","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-dispose-opts","docId":"api/interfaces/mongo-memory-dispose-opts"},{"type":"link","label":"ReplSetOpts","href":"/mongodb-memory-server/docs/api/interfaces/replset-opts","docId":"api/interfaces/replset-opts"}],"collapsed":true,"collapsible":true}],"guides":[{"type":"category","label":"Getting Started","items":[{"type":"link","label":"Quick Start Guide","href":"/mongodb-memory-server/docs/guides/quick-start-guide","docId":"guides/quick-start-guide"},{"type":"link","label":"Frequently Asked Questions","href":"/mongodb-memory-server/docs/guides/faq","docId":"guides/faq"},{"type":"link","label":"Known Issues","href":"/mongodb-memory-server/docs/guides/known-issues","docId":"guides/known-issues"},{"type":"link","label":"Supported Systems","href":"/mongodb-memory-server/docs/guides/supported-systems","docId":"guides/supported-systems"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Guides","items":[{"type":"category","label":"Integration Examples","items":[{"type":"link","label":"Integration with Test Runners","href":"/mongodb-memory-server/docs/guides/integration-examples/test-runners","docId":"guides/integration-examples/test-runners"},{"type":"link","label":"Integration with Docker","href":"/mongodb-memory-server/docs/guides/integration-examples/docker","docId":"guides/integration-examples/docker"}],"collapsed":true,"collapsible":true},{"type":"link","label":"Enable Debug Mode","href":"/mongodb-memory-server/docs/guides/enable-debug-mode","docId":"guides/enable-debug-mode"},{"type":"link","label":"Known Issues","href":"/mongodb-memory-server/docs/guides/known-issues","docId":"guides/known-issues"},{"type":"link","label":"Details for Errors & Warnings","href":"/mongodb-memory-server/docs/guides/error-warning-details","docId":"guides/error-warning-details"},{"type":"link","label":"Mongodb Server Versions","href":"/mongodb-memory-server/docs/guides/mongodb-server-versions","docId":"guides/mongodb-server-versions"},{"type":"link","label":"Common Issues","href":"/mongodb-memory-server/docs/guides/common-issues","docId":"guides/common-issues"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Migration","items":[{"type":"link","label":"Migrate to version 10.0.0","href":"/mongodb-memory-server/docs/guides/migration/migrate10","docId":"guides/migration/migrate10"},{"type":"link","label":"Migrate to version 9.0.0","href":"/mongodb-memory-server/docs/guides/migration/migrate9","docId":"guides/migration/migrate9"},{"type":"link","label":"Migrate to version 8.0.0","href":"/mongodb-memory-server/docs/guides/migration/migrate8","docId":"guides/migration/migrate8"},{"type":"link","label":"Migrate to version 7.0.0","href":"/mongodb-memory-server/docs/guides/migration/migrate7","docId":"guides/migration/migrate7"}],"collapsed":true,"collapsible":true}]},"docs":{"api/classes/dry-mongo-binary":{"id":"api/classes/dry-mongo-binary","title":"DryMongoBinary","description":"API Documentation of DryMongoBinary-Class","sidebar":"api"},"api/classes/mongo-binary":{"id":"api/classes/mongo-binary","title":"MongoBinary","description":"API Documentation of MongoBinary-Class","sidebar":"api"},"api/classes/mongo-instance":{"id":"api/classes/mongo-instance","title":"MongoInstance","description":"API Documentation of MongoInstance-Class","sidebar":"api"},"api/classes/mongo-memory-replset":{"id":"api/classes/mongo-memory-replset","title":"MongoMemoryReplSet","description":"API Documentation of MongoMemoryReplSet-Class","sidebar":"api"},"api/classes/mongo-memory-server":{"id":"api/classes/mongo-memory-server","title":"MongoMemoryServer","description":"API Documentation of MongoMemoryServer-Class","sidebar":"api"},"api/config-options":{"id":"api/config-options","title":"Config Options","description":"List of all Config Options","sidebar":"api"},"api/enums/mongo-memory-replset-states":{"id":"api/enums/mongo-memory-replset-states","title":"MongoMemoryReplSetStates","description":"API Documentation of MongoMemoryReplSetStates-Enum","sidebar":"api"},"api/enums/mongo-memory-server-states":{"id":"api/enums/mongo-memory-server-states","title":"MongoMemoryServerStates","description":"API Documentation of MongoMemoryServerStates-Enum","sidebar":"api"},"api/index-api":{"id":"api/index-api","title":"Welcome to the API","description":"In API will be documented what functions & values do, even internal protected / private ones","sidebar":"api"},"api/interfaces/mongo-memory-binary-opts":{"id":"api/interfaces/mongo-memory-binary-opts","title":"MongoBinaryOpts","description":"API Documentation of MongoBinaryOpts-Interface","sidebar":"api"},"api/interfaces/mongo-memory-dispose-opts":{"id":"api/interfaces/mongo-memory-dispose-opts","title":"DisposeOptions","description":"API Documentation of DisposeOptions-Interface","sidebar":"api"},"api/interfaces/mongo-memory-instance-opts":{"id":"api/interfaces/mongo-memory-instance-opts","title":"MongoMemoryInstanceOpts","description":"API Documentation of MongoMemoryInstanceOpts-Interface","sidebar":"api"},"api/interfaces/mongo-memory-instance-replicamemberconfig":{"id":"api/interfaces/mongo-memory-instance-replicamemberconfig","title":"ReplicaMemberConfig","description":"API Documentation of ReplicaMemberConfig-Interface","sidebar":"api"},"api/interfaces/mongo-memory-replset-opts":{"id":"api/interfaces/mongo-memory-replset-opts","title":"MongoMemoryReplSetOpts","description":"API Documentation of MongoMemoryReplSetOpts-Interface","sidebar":"api"},"api/interfaces/mongo-memory-server-automaticauth":{"id":"api/interfaces/mongo-memory-server-automaticauth","title":"AutomaticAuth","description":"API Documentation of AutomaticAuth-Interface","sidebar":"api"},"api/interfaces/mongo-memory-server-createuser":{"id":"api/interfaces/mongo-memory-server-createuser","title":"CreateUser","description":"API Documentation of CreateUser-Interface","sidebar":"api"},"api/interfaces/mongo-memory-server-opts":{"id":"api/interfaces/mongo-memory-server-opts","title":"MongoMemoryServerOpts","description":"API Documentation of MongoMemoryServerOpts-Interface","sidebar":"api"},"api/interfaces/replset-opts":{"id":"api/interfaces/replset-opts","title":"ReplSetOpts","description":"API Documentation of ReplSetOpts-Interface","sidebar":"api"},"guides/common-issues":{"id":"guides/common-issues","title":"Common Issues","description":"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.","sidebar":"guides"},"guides/enable-debug-mode":{"id":"guides/enable-debug-mode","title":"Enable Debug Mode","description":"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.","sidebar":"guides"},"guides/error-warning-details":{"id":"guides/error-warning-details","title":"Details for Errors & Warnings","description":"StateError","sidebar":"guides"},"guides/faq":{"id":"guides/faq","title":"Frequently Asked Questions","description":"Do binaries get automatically deleted?","sidebar":"guides"},"guides/integration-examples/docker":{"id":"guides/integration-examples/docker","title":"Integration with Docker","description":"This Guide will show how mongodb-memory-server can be used with Docker & dockerfiles.","sidebar":"guides"},"guides/integration-examples/test-runners":{"id":"guides/integration-examples/test-runners","title":"Integration with Test Runners","description":"This Guide will show how mongodb-memory-server can be used with different frameworks","sidebar":"guides"},"guides/known-issues":{"id":"guides/known-issues","title":"Known Issues","description":"ArchLinux on Docker","sidebar":"guides"},"guides/migration/migrate10":{"id":"guides/migration/migrate10","title":"Migrate to version 10.0.0","description":"Here are the Important changes made for 10.0.0","sidebar":"guides"},"guides/migration/migrate7":{"id":"guides/migration/migrate7","title":"Migrate to version 7.0.0","description":"Here are the Important changes made for 7.0.0","sidebar":"guides"},"guides/migration/migrate8":{"id":"guides/migration/migrate8","title":"Migrate to version 8.0.0","description":"Here are the Important changes made for 8.0.0","sidebar":"guides"},"guides/migration/migrate9":{"id":"guides/migration/migrate9","title":"Migrate to version 9.0.0","description":"Here are the Important changes made for 9.0.0","sidebar":"guides"},"guides/mongodb-server-versions":{"id":"guides/mongodb-server-versions","title":"Mongodb Server Versions","description":"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.","sidebar":"guides"},"guides/quick-start-guide":{"id":"guides/quick-start-guide","title":"Quick Start Guide","description":"This Guide will show how to setup this package for basic use","sidebar":"guides"},"guides/supported-systems":{"id":"guides/supported-systems","title":"Supported Systems","description":"Currently Supported platforms:","sidebar":"guides"},"test":{"id":"test","title":"Docusaurus Testing","description":"This file is meant to show what Docusaurus is capable of and how it looks in this projects styles"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.e95c590f.js b/assets/js/935f2afb.e95c590f.js deleted file mode 100644 index 42939ec73..000000000 --- a/assets/js/935f2afb.e95c590f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[53],{1109:function(e){e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"api":[{"type":"category","label":"Start","items":[{"type":"link","label":"Welcome to the API","href":"/mongodb-memory-server/docs/api/index-api","docId":"api/index-api"},{"type":"link","label":"Config Options","href":"/mongodb-memory-server/docs/api/config-options","docId":"api/config-options"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Classes","items":[{"type":"link","label":"MongoMemoryServer","href":"/mongodb-memory-server/docs/api/classes/mongo-memory-server","docId":"api/classes/mongo-memory-server"},{"type":"link","label":"MongoMemoryReplSet","href":"/mongodb-memory-server/docs/api/classes/mongo-memory-replset","docId":"api/classes/mongo-memory-replset"},{"type":"link","label":"MongoInstance","href":"/mongodb-memory-server/docs/api/classes/mongo-instance","docId":"api/classes/mongo-instance"},{"type":"link","label":"MongoBinary","href":"/mongodb-memory-server/docs/api/classes/mongo-binary","docId":"api/classes/mongo-binary"},{"type":"link","label":"DryMongoBinary","href":"/mongodb-memory-server/docs/api/classes/dry-mongo-binary","docId":"api/classes/dry-mongo-binary"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Enums","items":[{"type":"link","label":"MongoMemoryServerStates","href":"/mongodb-memory-server/docs/api/enums/mongo-memory-server-states","docId":"api/enums/mongo-memory-server-states"},{"type":"link","label":"MongoMemoryReplSetStates","href":"/mongodb-memory-server/docs/api/enums/mongo-memory-replset-states","docId":"api/enums/mongo-memory-replset-states"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Interfaces","items":[{"type":"link","label":"MongoMemoryServerOpts","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-opts","docId":"api/interfaces/mongo-memory-server-opts"},{"type":"link","label":"AutomaticAuth","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-automaticauth","docId":"api/interfaces/mongo-memory-server-automaticauth"},{"type":"link","label":"CreateUser","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-server-createuser","docId":"api/interfaces/mongo-memory-server-createuser"},{"type":"link","label":"MongoMemoryInstanceOpts","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-instance-opts","docId":"api/interfaces/mongo-memory-instance-opts"},{"type":"link","label":"ReplicaMemberConfig","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-instance-replicamemberconfig","docId":"api/interfaces/mongo-memory-instance-replicamemberconfig"},{"type":"link","label":"MongoBinaryOpts","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-binary-opts","docId":"api/interfaces/mongo-memory-binary-opts"},{"type":"link","label":"MongoMemoryReplSetOpts","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-replset-opts","docId":"api/interfaces/mongo-memory-replset-opts"},{"type":"link","label":"DisposeOptions","href":"/mongodb-memory-server/docs/api/interfaces/mongo-memory-dispose-opts","docId":"api/interfaces/mongo-memory-dispose-opts"},{"type":"link","label":"ReplSetOpts","href":"/mongodb-memory-server/docs/api/interfaces/replset-opts","docId":"api/interfaces/replset-opts"}],"collapsed":true,"collapsible":true}],"guides":[{"type":"category","label":"Getting Started","items":[{"type":"link","label":"Quick Start Guide","href":"/mongodb-memory-server/docs/guides/quick-start-guide","docId":"guides/quick-start-guide"},{"type":"link","label":"Frequently Asked Questions","href":"/mongodb-memory-server/docs/guides/faq","docId":"guides/faq"},{"type":"link","label":"Known Issues","href":"/mongodb-memory-server/docs/guides/known-issues","docId":"guides/known-issues"},{"type":"link","label":"Supported Systems","href":"/mongodb-memory-server/docs/guides/supported-systems","docId":"guides/supported-systems"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Guides","items":[{"type":"category","label":"Integration Examples","items":[{"type":"link","label":"Integration with Test Runners","href":"/mongodb-memory-server/docs/guides/integration-examples/test-runners","docId":"guides/integration-examples/test-runners"},{"type":"link","label":"Integration with Docker","href":"/mongodb-memory-server/docs/guides/integration-examples/docker","docId":"guides/integration-examples/docker"}],"collapsed":true,"collapsible":true},{"type":"link","label":"Enable Debug Mode","href":"/mongodb-memory-server/docs/guides/enable-debug-mode","docId":"guides/enable-debug-mode"},{"type":"link","label":"Known Issues","href":"/mongodb-memory-server/docs/guides/known-issues","docId":"guides/known-issues"},{"type":"link","label":"Details for Errors & Warnings","href":"/mongodb-memory-server/docs/guides/error-warning-details","docId":"guides/error-warning-details"},{"type":"link","label":"Mongodb Server Versions","href":"/mongodb-memory-server/docs/guides/mongodb-server-versions","docId":"guides/mongodb-server-versions"},{"type":"link","label":"Common Issues","href":"/mongodb-memory-server/docs/guides/common-issues","docId":"guides/common-issues"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Migration","items":[{"type":"link","label":"Migrate to version 10.0.0","href":"/mongodb-memory-server/docs/guides/migration/migrate10","docId":"guides/migration/migrate10"},{"type":"link","label":"Migrate to version 9.0.0","href":"/mongodb-memory-server/docs/guides/migration/migrate9","docId":"guides/migration/migrate9"},{"type":"link","label":"Migrate to version 8.0.0","href":"/mongodb-memory-server/docs/guides/migration/migrate8","docId":"guides/migration/migrate8"},{"type":"link","label":"Migrate to version 7.0.0","href":"/mongodb-memory-server/docs/guides/migration/migrate7","docId":"guides/migration/migrate7"}],"collapsed":true,"collapsible":true}]},"docs":{"api/classes/dry-mongo-binary":{"id":"api/classes/dry-mongo-binary","title":"DryMongoBinary","description":"API Documentation of DryMongoBinary-Class","sidebar":"api"},"api/classes/mongo-binary":{"id":"api/classes/mongo-binary","title":"MongoBinary","description":"API Documentation of MongoBinary-Class","sidebar":"api"},"api/classes/mongo-instance":{"id":"api/classes/mongo-instance","title":"MongoInstance","description":"API Documentation of MongoInstance-Class","sidebar":"api"},"api/classes/mongo-memory-replset":{"id":"api/classes/mongo-memory-replset","title":"MongoMemoryReplSet","description":"API Documentation of MongoMemoryReplSet-Class","sidebar":"api"},"api/classes/mongo-memory-server":{"id":"api/classes/mongo-memory-server","title":"MongoMemoryServer","description":"API Documentation of MongoMemoryServer-Class","sidebar":"api"},"api/config-options":{"id":"api/config-options","title":"Config Options","description":"List of all Config Options","sidebar":"api"},"api/enums/mongo-memory-replset-states":{"id":"api/enums/mongo-memory-replset-states","title":"MongoMemoryReplSetStates","description":"API Documentation of MongoMemoryReplSetStates-Enum","sidebar":"api"},"api/enums/mongo-memory-server-states":{"id":"api/enums/mongo-memory-server-states","title":"MongoMemoryServerStates","description":"API Documentation of MongoMemoryServerStates-Enum","sidebar":"api"},"api/index-api":{"id":"api/index-api","title":"Welcome to the API","description":"In API will be documented what functions & values do, even internal protected / private ones","sidebar":"api"},"api/interfaces/mongo-memory-binary-opts":{"id":"api/interfaces/mongo-memory-binary-opts","title":"MongoBinaryOpts","description":"API Documentation of MongoBinaryOpts-Interface","sidebar":"api"},"api/interfaces/mongo-memory-dispose-opts":{"id":"api/interfaces/mongo-memory-dispose-opts","title":"DisposeOptions","description":"API Documentation of DisposeOptions-Interface","sidebar":"api"},"api/interfaces/mongo-memory-instance-opts":{"id":"api/interfaces/mongo-memory-instance-opts","title":"MongoMemoryInstanceOpts","description":"API Documentation of MongoMemoryInstanceOpts-Interface","sidebar":"api"},"api/interfaces/mongo-memory-instance-replicamemberconfig":{"id":"api/interfaces/mongo-memory-instance-replicamemberconfig","title":"ReplicaMemberConfig","description":"API Documentation of ReplicaMemberConfig-Interface","sidebar":"api"},"api/interfaces/mongo-memory-replset-opts":{"id":"api/interfaces/mongo-memory-replset-opts","title":"MongoMemoryReplSetOpts","description":"API Documentation of MongoMemoryReplSetOpts-Interface","sidebar":"api"},"api/interfaces/mongo-memory-server-automaticauth":{"id":"api/interfaces/mongo-memory-server-automaticauth","title":"AutomaticAuth","description":"API Documentation of AutomaticAuth-Interface","sidebar":"api"},"api/interfaces/mongo-memory-server-createuser":{"id":"api/interfaces/mongo-memory-server-createuser","title":"CreateUser","description":"API Documentation of CreateUser-Interface","sidebar":"api"},"api/interfaces/mongo-memory-server-opts":{"id":"api/interfaces/mongo-memory-server-opts","title":"MongoMemoryServerOpts","description":"API Documentation of MongoMemoryServerOpts-Interface","sidebar":"api"},"api/interfaces/replset-opts":{"id":"api/interfaces/replset-opts","title":"ReplSetOpts","description":"API Documentation of ReplSetOpts-Interface","sidebar":"api"},"guides/common-issues":{"id":"guides/common-issues","title":"Common Issues","description":"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.","sidebar":"guides"},"guides/enable-debug-mode":{"id":"guides/enable-debug-mode","title":"Enable Debug Mode","description":"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.","sidebar":"guides"},"guides/error-warning-details":{"id":"guides/error-warning-details","title":"Details for Errors & Warnings","description":"StateError","sidebar":"guides"},"guides/faq":{"id":"guides/faq","title":"Frequently Asked Questions","description":"Do binaries get automatically deleted?","sidebar":"guides"},"guides/integration-examples/docker":{"id":"guides/integration-examples/docker","title":"Integration with Docker","description":"This Guide will show how mongodb-memory-server can be used with Docker & dockerfiles.","sidebar":"guides"},"guides/integration-examples/test-runners":{"id":"guides/integration-examples/test-runners","title":"Integration with Test Runners","description":"This Guide will show how mongodb-memory-server can be used with different frameworks","sidebar":"guides"},"guides/known-issues":{"id":"guides/known-issues","title":"Known Issues","description":"ArchLinux on Docker","sidebar":"guides"},"guides/migration/migrate10":{"id":"guides/migration/migrate10","title":"Migrate to version 10.0.0","description":"Here are the Important changes made for 10.0.0","sidebar":"guides"},"guides/migration/migrate7":{"id":"guides/migration/migrate7","title":"Migrate to version 7.0.0","description":"Here are the Important changes made for 7.0.0","sidebar":"guides"},"guides/migration/migrate8":{"id":"guides/migration/migrate8","title":"Migrate to version 8.0.0","description":"Here are the Important changes made for 8.0.0","sidebar":"guides"},"guides/migration/migrate9":{"id":"guides/migration/migrate9","title":"Migrate to version 9.0.0","description":"Here are the Important changes made for 9.0.0","sidebar":"guides"},"guides/mongodb-server-versions":{"id":"guides/mongodb-server-versions","title":"Mongodb Server Versions","description":"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.","sidebar":"guides"},"guides/quick-start-guide":{"id":"guides/quick-start-guide","title":"Quick Start Guide","description":"This Guide will show how to setup this package for basic use","sidebar":"guides"},"guides/supported-systems":{"id":"guides/supported-systems","title":"Supported Systems","description":"Currently Supported platforms:","sidebar":"guides"},"test":{"id":"test","title":"Docusaurus Testing","description":"This file is meant to show what Docusaurus is capable of and how it looks in this projects styles"}}}')}}]); \ No newline at end of file diff --git a/assets/js/972.d4b21274.js b/assets/js/972.d4b21274.js deleted file mode 100644 index 48a6dcaf3..000000000 --- a/assets/js/972.d4b21274.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[972],{4972:function(e,t,n){n.r(t),n.d(t,{default:function(){return i}});var o=n(7294),a=n(5999),r=n(1944),l=n(5163);function i(){return o.createElement(o.Fragment,null,o.createElement(r.d,{title:(0,a.I)({id:"theme.NotFound.title",message:"Page Not Found"})}),o.createElement(l.Z,null,o.createElement("main",{className:"container margin-vert--xl"},o.createElement("div",{className:"row"},o.createElement("div",{className:"col col--6 col--offset-3"},o.createElement("h1",{className:"hero__title"},o.createElement(a.Z,{id:"theme.NotFound.title",description:"The title of the 404 page"},"Page Not Found")),o.createElement("p",null,o.createElement(a.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page"},"We could not find what you were looking for.")),o.createElement("p",null,o.createElement(a.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page"},"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/9795f834.29d02e91.js b/assets/js/9795f834.41690aba.js similarity index 62% rename from assets/js/9795f834.29d02e91.js rename to assets/js/9795f834.41690aba.js index 944fb91f1..7c504e32b 100644 --- a/assets/js/9795f834.29d02e91.js +++ b/assets/js/9795f834.41690aba.js @@ -1 +1 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[515],{3905:function(e,n,t){t.d(n,{Zo:function(){return c},kt:function(){return g}});var o=t(7294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,o)}return t}function a(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var d=o.createContext({}),s=function(e){var n=o.useContext(d),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=s(e.components);return o.createElement(d.Provider,{value:n},e.children)},m="mdxType",p={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},u=o.forwardRef((function(e,n){var t=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),m=s(t),u=r,g=m["".concat(d,".").concat(u)]||m[u]||p[u]||i;return t?o.createElement(g,a(a({ref:n},c),{},{components:t})):o.createElement(g,a({ref:n},c))}));function g(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,a=new Array(i);a[0]=u;var l={};for(var d in n)hasOwnProperty.call(n,d)&&(l[d]=n[d]);l.originalType=e,l[m]="string"==typeof e?e:r,a[1]=l;for(var s=2;s.dockerignore",id:"dockerignore",level:3},{value:"dockerfile",id:"dockerfile",level:3}],p={toc:m},u="wrapper";function g(e){var n=e.components,t=(0,r.Z)(e,a);return(0,i.kt)(u,(0,o.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"This Guide will show how ",(0,i.kt)("inlineCode",{parentName:"p"},"mongodb-memory-server")," can be used with Docker & dockerfiles."),(0,i.kt)("h2",{id:"important-notes-before-starting"},"Important Notes before Starting"),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"It is common that images like ",(0,i.kt)("inlineCode",{parentName:"p"},"node:16-alpine")," are used, which will not work with this package, because mongodb does not provide binaries for Alpine yet.\nIt is recommended to switch to images like ",(0,i.kt)("inlineCode",{parentName:"p"},"node:16")," (or ",(0,i.kt)("inlineCode",{parentName:"p"},"node:16-buster"),") for Debian builds."),(0,i.kt)("p",{parentName:"admonition"},"See ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/guides/known-issues#no-build-available-for-alpine-linux"},"No Build available for Alpine Linux"),".")),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Docker Debian builds (at least with ",(0,i.kt)("inlineCode",{parentName:"p"},"debian:11"),"), extra packages have to be installed:"),(0,i.kt)("pre",{parentName:"admonition"},(0,i.kt)("code",{parentName:"pre",className:"language-sh"},"apt-get install libcurl4 # for Debian 10+ to fix CURL_OPENSSL_4\n# OR\napt-get install libcurl3 # for Debian 9 (and before) to fix CURL_OPENSSL_3\n"))),(0,i.kt)("h2",{id:"writing-a-dockerfile-with-mongodb-binary-caching"},"Writing a dockerfile with mongodb binary caching"),(0,i.kt)("p",null,"Sometimes you want to have the tests isolated from the host system and also have caching working for mongodb-memory-server."),(0,i.kt)("h3",{id:"dockerignore"},(0,i.kt)("inlineCode",{parentName:"h3"},".dockerignore")),(0,i.kt)("p",null,"It is recommended to have the following added to the ",(0,i.kt)("inlineCode",{parentName:"p"},".dockerignore")," file to make sure that no host-specific things are copied into the image:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-dockerignore"},"# ignore all node_modules, no matter where, like when having a monorepo\n**/node_modules\n")),(0,i.kt)("p",null,"If the above is not added to the ",(0,i.kt)("inlineCode",{parentName:"p"},".dockeringore")," then the following may happen:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Best case is just added bloat if the host system is not debian (like having the host's mongodb binary copied into the image)"),(0,i.kt)("li",{parentName:"ul"},"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")),(0,i.kt)("p",null,"Alternatively, if no ",(0,i.kt)("inlineCode",{parentName:"p"},".dockeringore")," is used, the following could also be added to the ",(0,i.kt)("inlineCode",{parentName:"p"},"dockerfile"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-dockerfile"},'# ...\nCOPY node:node . /project\n\n# Put this Instruction between the COPY and the RUN "npm install" steps\n# The following recursively deletes all directories it finds that are a directory AND have a name matching "node_modules"\nRUN find . -type d -iname "node_modules" -exec rm -rf {} \\;\n\nRUN npm install\n# ...\n')),(0,i.kt)("h3",{id:"dockerfile"},(0,i.kt)("inlineCode",{parentName:"h3"},"dockerfile")),(0,i.kt)("p",null,"The following ",(0,i.kt)("inlineCode",{parentName:"p"},"dockerfile")," contains the recommended steps to build a good MMS image:"),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"The following ",(0,i.kt)("inlineCode",{parentName:"p"},"dockerfile")," has examples for 2 package managers: ",(0,i.kt)("inlineCode",{parentName:"p"},"npm")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"yarn"),", be sure to remove the one that will not be used.")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-dockerfile"},'# Using a Debian build\nFROM node:16\n\n# Installing "libcurl4" because some Debian images may not come with this package installed, but is required by the mongodb binaries\nRUN apt-get install libcurl4\n\n# Settings the CWD (Current Work Directory) to "/project" to have a isolated folder for the project\n# Note: it is not recommended to set it to "/home/dockeruser", but to use "/home/dockeruser/project"\nWORKDIR /project\n\n# Copy the project (all files) into the image into "/project" as user "node:node"\n# User "node:node" is the default nodejs user in the docker images\nCOPY node:node . /project\n\n# Explicitly set the user that will be used for the next Instructions and ENTRYPOINT\nUSER node\n\n# Install all required dependencies locked to the package-lock (or yarn.lock)\n# Replace "npm install" with your package manager command of choice\nRUN npm install --ci\n# OR\nRUN yarn install --frozen-lockfile\n\n# Set the default command that will be used when running the image\n# Replace this with your command / package manager command of choice\nENTRYPOINT ["npm", "run", "test"]\n# OR\nENTRYPOINT ["yarn", "run", "test"]\n')))}g.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[706],{5680:function(e,n,t){t.d(n,{xA:function(){return c},yg:function(){return u}});var o=t(6540);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,o)}return t}function a(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var d=o.createContext({}),s=function(e){var n=o.useContext(d),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=s(e.components);return o.createElement(d.Provider,{value:n},e.children)},m="mdxType",g={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},p=o.forwardRef((function(e,n){var t=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),m=s(t),p=r,u=m["".concat(d,".").concat(p)]||m[p]||g[p]||i;return t?o.createElement(u,a(a({ref:n},c),{},{components:t})):o.createElement(u,a({ref:n},c))}));function u(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,a=new Array(i);a[0]=p;var l={};for(var d in n)hasOwnProperty.call(n,d)&&(l[d]=n[d]);l.originalType=e,l[m]="string"==typeof e?e:r,a[1]=l;for(var s=2;s.dockerignore",id:"dockerignore",level:3},{value:"dockerfile",id:"dockerfile",level:3}],g={toc:m},p="wrapper";function u(e){var n=e.components,t=(0,r.A)(e,a);return(0,i.yg)(p,(0,o.A)({},g,t,{components:n,mdxType:"MDXLayout"}),(0,i.yg)("p",null,"This Guide will show how ",(0,i.yg)("inlineCode",{parentName:"p"},"mongodb-memory-server")," can be used with Docker & dockerfiles."),(0,i.yg)("h2",{id:"important-notes-before-starting"},"Important Notes before Starting"),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"It is common that images like ",(0,i.yg)("inlineCode",{parentName:"p"},"node:16-alpine")," are used, which will not work with this package, because mongodb does not provide binaries for Alpine yet.\nIt is recommended to switch to images like ",(0,i.yg)("inlineCode",{parentName:"p"},"node:16")," (or ",(0,i.yg)("inlineCode",{parentName:"p"},"node:16-buster"),") for Debian builds."),(0,i.yg)("p",{parentName:"admonition"},"See ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/guides/known-issues#no-build-available-for-alpine-linux"},"No Build available for Alpine Linux"),".")),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Docker Debian builds (at least with ",(0,i.yg)("inlineCode",{parentName:"p"},"debian:11"),"), extra packages have to be installed:"),(0,i.yg)("pre",{parentName:"admonition"},(0,i.yg)("code",{parentName:"pre",className:"language-sh"},"apt-get install libcurl4 # for Debian 10+ to fix CURL_OPENSSL_4\n# OR\napt-get install libcurl3 # for Debian 9 (and before) to fix CURL_OPENSSL_3\n"))),(0,i.yg)("h2",{id:"writing-a-dockerfile-with-mongodb-binary-caching"},"Writing a dockerfile with mongodb binary caching"),(0,i.yg)("p",null,"Sometimes you want to have the tests isolated from the host system and also have caching working for mongodb-memory-server."),(0,i.yg)("h3",{id:"dockerignore"},(0,i.yg)("inlineCode",{parentName:"h3"},".dockerignore")),(0,i.yg)("p",null,"It is recommended to have the following added to the ",(0,i.yg)("inlineCode",{parentName:"p"},".dockerignore")," file to make sure that no host-specific things are copied into the image:"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-dockerignore"},"# ignore all node_modules, no matter where, like when having a monorepo\n**/node_modules\n")),(0,i.yg)("p",null,"If the above is not added to the ",(0,i.yg)("inlineCode",{parentName:"p"},".dockeringore")," then the following may happen:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"Best case is just added bloat if the host system is not debian (like having the host's mongodb binary copied into the image)"),(0,i.yg)("li",{parentName:"ul"},"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")),(0,i.yg)("p",null,"Alternatively, if no ",(0,i.yg)("inlineCode",{parentName:"p"},".dockeringore")," is used, the following could also be added to the ",(0,i.yg)("inlineCode",{parentName:"p"},"dockerfile"),":"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-dockerfile"},'# ...\nCOPY node:node . /project\n\n# Put this Instruction between the COPY and the RUN "npm install" steps\n# The following recursively deletes all directories it finds that are a directory AND have a name matching "node_modules"\nRUN find . -type d -iname "node_modules" -exec rm -rf {} \\;\n\nRUN npm install\n# ...\n')),(0,i.yg)("h3",{id:"dockerfile"},(0,i.yg)("inlineCode",{parentName:"h3"},"dockerfile")),(0,i.yg)("p",null,"The following ",(0,i.yg)("inlineCode",{parentName:"p"},"dockerfile")," contains the recommended steps to build a good MMS image:"),(0,i.yg)("admonition",{type:"note"},(0,i.yg)("p",{parentName:"admonition"},"The following ",(0,i.yg)("inlineCode",{parentName:"p"},"dockerfile")," has examples for 2 package managers: ",(0,i.yg)("inlineCode",{parentName:"p"},"npm")," and ",(0,i.yg)("inlineCode",{parentName:"p"},"yarn"),", be sure to remove the one that will not be used.")),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-dockerfile"},'# Using a Debian build\nFROM node:16\n\n# Installing "libcurl4" because some Debian images may not come with this package installed, but is required by the mongodb binaries\nRUN apt-get install libcurl4\n\n# Settings the CWD (Current Work Directory) to "/project" to have a isolated folder for the project\n# Note: it is not recommended to set it to "/home/dockeruser", but to use "/home/dockeruser/project"\nWORKDIR /project\n\n# Copy the project (all files) into the image into "/project" as user "node:node"\n# User "node:node" is the default nodejs user in the docker images\nCOPY node:node . /project\n\n# Explicitly set the user that will be used for the next Instructions and ENTRYPOINT\nUSER node\n\n# Install all required dependencies locked to the package-lock (or yarn.lock)\n# Replace "npm install" with your package manager command of choice\nRUN npm install --ci\n# OR\nRUN yarn install --frozen-lockfile\n\n# Set the default command that will be used when running the image\n# Replace this with your command / package manager command of choice\nENTRYPOINT ["npm", "run", "test"]\n# OR\nENTRYPOINT ["yarn", "run", "test"]\n')))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9f6ab2c9.09478866.js b/assets/js/9f6ab2c9.09478866.js deleted file mode 100644 index 8e409adf1..000000000 --- a/assets/js/9f6ab2c9.09478866.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[848],{3905:function(e,r,n){n.d(r,{Zo:function(){return u},kt:function(){return p}});var t=n(7294);function o(e,r,n){return r in e?Object.defineProperty(e,r,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[r]=n,e}function i(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 a(e){for(var r=1;r=0||(o[n]=e[n]);return o}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var d=t.createContext({}),l=function(e){var r=t.useContext(d),n=r;return e&&(n="function"==typeof e?e(r):a(a({},r),e)),n},u=function(e){var r=l(e.components);return t.createElement(d.Provider,{value:r},e.children)},m="mdxType",g={inlineCode:"code",wrapper:function(e){var r=e.children;return t.createElement(t.Fragment,{},r)}},c=t.forwardRef((function(e,r){var n=e.components,o=e.mdxType,i=e.originalType,d=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),m=l(n),c=o,p=m["".concat(d,".").concat(c)]||m[c]||g[c]||i;return n?t.createElement(p,a(a({ref:r},u),{},{components:n})):t.createElement(p,a({ref:r},u))}));function p(e,r){var n=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=c;var s={};for(var d in r)hasOwnProperty.call(r,d)&&(s[d]=r[d]);s.originalType=e,s[m]="string"==typeof e?e:o,a[1]=s;for(var l=2;linstance.auth is no longer required to enable Authentication",id:"instanceauth-is-no-longer-required-to-enable-authentication",level:3},{value:"More Errors moved to Custom Error classes",id:"more-errors-moved-to-custom-error-classes",level:3}],g={toc:m},c="wrapper";function p(e){var r=e.components,n=(0,o.Z)(e,a);return(0,i.kt)(c,(0,t.Z)({},g,n,{components:r,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"Here are the Important changes made for 8.0.0"),(0,i.kt)("admonition",{title:"Important, Read this first",type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"This Guide is written for migration from version ",(0,i.kt)("inlineCode",{parentName:"p"},"7.6.0")," to ",(0,i.kt)("inlineCode",{parentName:"p"},"8.0.0"),", for versions ",(0,i.kt)("inlineCode",{parentName:"p"},">8.0.0 <9.0.0"),", please consult the ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md"},"CHANGELOG"))),(0,i.kt)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,i.kt)("h3",{id:"default-mongodb-server-version-upgraded-to-503"},"Default MongoDB Server version upgraded to 5.0.3"),(0,i.kt)("p",null,"The Default MongoDB Server version for 8.0 is ",(0,i.kt)("inlineCode",{parentName:"p"},"5.0.3"),", see ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/guides/mongodb-server-versions"},"MongoDB Server Versions"),"."),(0,i.kt)("h3",{id:"mongodb-driver-version-upgraded-to-4x"},"Mongodb Driver Version upgraded to 4.x"),(0,i.kt)("p",null,"The used MongoDB Driver version is now ",(0,i.kt)("inlineCode",{parentName:"p"},"4.1.2"),"."),(0,i.kt)("h2",{id:"non-breaking-changes--additions"},"Non-Breaking changes / Additions"),(0,i.kt)("h3",{id:"binary-file-name-is-now-parsed-from-archive_name-and-download_url"},"Binary file name is now parsed from ARCHIVE_NAME and DOWNLOAD_URL"),(0,i.kt)("p",null,"The Binary file name (like ",(0,i.kt)("inlineCode",{parentName:"p"},"mongod-x64-ubuntu-4.0.0"),") is now parsed from ",(0,i.kt)("a",{parentName:"p",href:"../../api/config-options#archive_name"},(0,i.kt)("inlineCode",{parentName:"a"},"ARCHIVE_NAME"))," and ",(0,i.kt)("a",{parentName:"p",href:"../../api/config-options#download_url"},(0,i.kt)("inlineCode",{parentName:"a"},"DOWNLOAD_URL")),"."),(0,i.kt)("h3",{id:"a-error-now-gets-thrown-if-debian-10-or-higher-is-used-with-mongodb-version-below-420"},"A Error now gets thrown if Debian 10 (or higher) is used with mongodb version below 4.2.0"),(0,i.kt)("p",null,"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)"),(0,i.kt)("h3",{id:"instanceauth-is-no-longer-required-to-enable-authentication"},(0,i.kt)("inlineCode",{parentName:"h3"},"instance.auth")," is no longer required to enable Authentication"),(0,i.kt)("p",null,"Option ",(0,i.kt)("inlineCode",{parentName:"p"},"instance.auth")," is now no longer required to be set to enable Authentication when ",(0,i.kt)("inlineCode",{parentName:"p"},"auth")," (top-level) is set."),(0,i.kt)("h3",{id:"more-errors-moved-to-custom-error-classes"},"More Errors moved to Custom Error classes"),(0,i.kt)("p",null,"More Errors have been moved to a custom Error class."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9f6ab2c9.2055a04e.js b/assets/js/9f6ab2c9.2055a04e.js new file mode 100644 index 000000000..362228c85 --- /dev/null +++ b/assets/js/9f6ab2c9.2055a04e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[537],{5680:function(e,r,n){n.d(r,{xA:function(){return l},yg:function(){return p}});var o=n(6540);function t(e,r,n){return r in e?Object.defineProperty(e,r,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[r]=n,e}function i(e,r){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);r&&(o=o.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),n.push.apply(n,o)}return n}function a(e){for(var r=1;r=0||(t[n]=e[n]);return t}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(t[n]=e[n])}return t}var d=o.createContext({}),g=function(e){var r=o.useContext(d),n=r;return e&&(n="function"==typeof e?e(r):a(a({},r),e)),n},l=function(e){var r=g(e.components);return o.createElement(d.Provider,{value:r},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var r=e.children;return o.createElement(o.Fragment,{},r)}},c=o.forwardRef((function(e,r){var n=e.components,t=e.mdxType,i=e.originalType,d=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=g(n),c=t,p=u["".concat(d,".").concat(c)]||u[c]||m[c]||i;return n?o.createElement(p,a(a({ref:r},l),{},{components:n})):o.createElement(p,a({ref:r},l))}));function p(e,r){var n=arguments,t=r&&r.mdxType;if("string"==typeof e||t){var i=n.length,a=new Array(i);a[0]=c;var s={};for(var d in r)hasOwnProperty.call(r,d)&&(s[d]=r[d]);s.originalType=e,s[u]="string"==typeof e?e:t,a[1]=s;for(var g=2;ginstance.auth is no longer required to enable Authentication",id:"instanceauth-is-no-longer-required-to-enable-authentication",level:3},{value:"More Errors moved to Custom Error classes",id:"more-errors-moved-to-custom-error-classes",level:3}],m={toc:u},c="wrapper";function p(e){var r=e.components,n=(0,t.A)(e,a);return(0,i.yg)(c,(0,o.A)({},m,n,{components:r,mdxType:"MDXLayout"}),(0,i.yg)("p",null,"Here are the Important changes made for 8.0.0"),(0,i.yg)("admonition",{title:"Important, Read this first",type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"This Guide is written for migration from version ",(0,i.yg)("inlineCode",{parentName:"p"},"7.6.0")," to ",(0,i.yg)("inlineCode",{parentName:"p"},"8.0.0"),", for versions ",(0,i.yg)("inlineCode",{parentName:"p"},">8.0.0 <9.0.0"),", please consult the ",(0,i.yg)("a",{parentName:"p",href:"https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md"},"CHANGELOG"))),(0,i.yg)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,i.yg)("h3",{id:"default-mongodb-server-version-upgraded-to-503"},"Default MongoDB Server version upgraded to 5.0.3"),(0,i.yg)("p",null,"The Default MongoDB Server version for 8.0 is ",(0,i.yg)("inlineCode",{parentName:"p"},"5.0.3"),", see ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/guides/mongodb-server-versions"},"MongoDB Server Versions"),"."),(0,i.yg)("h3",{id:"mongodb-driver-version-upgraded-to-4x"},"Mongodb Driver Version upgraded to 4.x"),(0,i.yg)("p",null,"The used MongoDB Driver version is now ",(0,i.yg)("inlineCode",{parentName:"p"},"4.1.2"),"."),(0,i.yg)("h2",{id:"non-breaking-changes--additions"},"Non-Breaking changes / Additions"),(0,i.yg)("h3",{id:"binary-file-name-is-now-parsed-from-archive_name-and-download_url"},"Binary file name is now parsed from ARCHIVE_NAME and DOWNLOAD_URL"),(0,i.yg)("p",null,"The Binary file name (like ",(0,i.yg)("inlineCode",{parentName:"p"},"mongod-x64-ubuntu-4.0.0"),") is now parsed from ",(0,i.yg)("a",{parentName:"p",href:"../../api/config-options#archive_name"},(0,i.yg)("inlineCode",{parentName:"a"},"ARCHIVE_NAME"))," and ",(0,i.yg)("a",{parentName:"p",href:"../../api/config-options#download_url"},(0,i.yg)("inlineCode",{parentName:"a"},"DOWNLOAD_URL")),"."),(0,i.yg)("h3",{id:"a-error-now-gets-thrown-if-debian-10-or-higher-is-used-with-mongodb-version-below-420"},"A Error now gets thrown if Debian 10 (or higher) is used with mongodb version below 4.2.0"),(0,i.yg)("p",null,"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)"),(0,i.yg)("h3",{id:"instanceauth-is-no-longer-required-to-enable-authentication"},(0,i.yg)("inlineCode",{parentName:"h3"},"instance.auth")," is no longer required to enable Authentication"),(0,i.yg)("p",null,"Option ",(0,i.yg)("inlineCode",{parentName:"p"},"instance.auth")," is now no longer required to be set to enable Authentication when ",(0,i.yg)("inlineCode",{parentName:"p"},"auth")," (top-level) is set."),(0,i.yg)("h3",{id:"more-errors-moved-to-custom-error-classes"},"More Errors moved to Custom Error classes"),(0,i.yg)("p",null,"More Errors have been moved to a custom Error class."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a5852e81.358fc4f2.js b/assets/js/a5852e81.358fc4f2.js deleted file mode 100644 index 7a8f99647..000000000 --- a/assets/js/a5852e81.358fc4f2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[551],{1614:function(e,r,t){t.r(r);var n=t(7294),o=t(6550),s=t(4996);r.default=function(){return n.createElement(o.l_,{to:(0,s.Z)("/")})}}}]); \ No newline at end of file diff --git a/assets/js/a5852e81.6e284725.js b/assets/js/a5852e81.6e284725.js new file mode 100644 index 000000000..533be1e14 --- /dev/null +++ b/assets/js/a5852e81.6e284725.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[598],{3806:function(e,r,t){t.r(r);var n=t(6540),o=t(6347),s=t(6025);r.default=function(){return n.createElement(o.rd,{to:(0,s.A)("/")})}}}]); \ No newline at end of file diff --git a/assets/js/a8d48a20.2eed5ea4.js b/assets/js/a8d48a20.2eed5ea4.js deleted file mode 100644 index 6b0a81885..000000000 --- a/assets/js/a8d48a20.2eed5ea4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[61],{3905:function(e,n,t){t.d(n,{Zo:function(){return d},kt:function(){return f}});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},d=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},c=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(t),c=o,f=u["".concat(s,".").concat(c)]||u[c]||m[c]||i;return t?r.createElement(f,a(a({ref:n},d),{},{components:t})):r.createElement(f,a({ref:n},d))}));function f(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var i=t.length,a=new Array(i);a[0]=c;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[u]="string"==typeof e?e:o,a[1]=l;for(var p=2;pMongoBinaryOpts",id:"values-for-mongobinaryopts",level:2},{value:"checkMD5",id:"checkmd5",level:3},{value:"Values for BaseDryMongoBinaryOptions",id:"values-for-basedrymongobinaryoptions",level:2},{value:"version",id:"version",level:3},{value:"downloadDir",id:"downloaddir",level:3},{value:"os",id:"os",level:3},{value:"arch",id:"arch",level:3},{value:"platform",id:"platform",level:3},{value:"systemBinary",id:"systembinary",level:3},{value:"Helper Type AnyOS",id:"helper-type-anyos",level:2},{value:"Values for OtherOS",id:"values-for-otheros",level:2},{value:"os",id:"otheros-os",level:3},{value:"Values for LinuxOS",id:"values-for-linuxos",level:2},{value:"os",id:"linuxos-os",level:3},{value:"dist",id:"dist",level:3},{value:"release",id:"release",level:3},{value:"codename",id:"codename",level:3},{value:"id_like",id:"id_like",level:3}],m={toc:u},c="wrapper";function f(e){var n=e.components,t=(0,o.Z)(e,a);return(0,i.kt)(c,(0,r.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"API Documentation of ",(0,i.kt)("inlineCode",{parentName:"p"},"MongoBinaryOpts"),"-Interface"),(0,i.kt)("h2",{id:"values-for-mongobinaryopts"},"Values for ",(0,i.kt)("inlineCode",{parentName:"h2"},"MongoBinaryOpts")),(0,i.kt)("p",null,"Inherits most values from ",(0,i.kt)("a",{parentName:"p",href:"#values-for-basedrymongobinaryoptions"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseDryMongoBinaryOptions")),"."),(0,i.kt)("h3",{id:"checkmd5"},"checkMD5"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"checkMD5?: boolean")),(0,i.kt)("p",null,"Set wheter to perform a MD5 check on the downloaded archive."),(0,i.kt)("h2",{id:"values-for-basedrymongobinaryoptions"},"Values for ",(0,i.kt)("inlineCode",{parentName:"h2"},"BaseDryMongoBinaryOptions")),(0,i.kt)("h3",{id:"version"},"version"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"version?: string")),(0,i.kt)("p",null,"Set which binary version to download, see ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#version"},"config option ",(0,i.kt)("inlineCode",{parentName:"a"},"VERSION"))," for more."),(0,i.kt)("h3",{id:"downloaddir"},"downloadDir"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"downloadDir?: string")),(0,i.kt)("p",null,"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."),(0,i.kt)("h3",{id:"os"},"os"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"os?: AnyOS")),(0,i.kt)("p",null,"Set OS information that is necessary for generating the archive name, uses ",(0,i.kt)("a",{parentName:"p",href:"#helper-type-anyos"},(0,i.kt)("inlineCode",{parentName:"a"},"AnyOS")),"."),(0,i.kt)("h3",{id:"arch"},"arch"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"arch?: string")),(0,i.kt)("p",null,"Set which Architecture to use,supports the same values as ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#arch"},"config option ",(0,i.kt)("inlineCode",{parentName:"a"},"ARCH")),"."),(0,i.kt)("h3",{id:"platform"},"platform"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"platform?: string")),(0,i.kt)("p",null,"Set which Platform to use,supports the same values as ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#platform"},"config option ",(0,i.kt)("inlineCode",{parentName:"a"},"PLATFORM")),"."),(0,i.kt)("h3",{id:"systembinary"},"systemBinary"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"systemBinary?: string")),(0,i.kt)("p",null,"Set the SystemBinary path, if set this path will be used instead of finding a binary.",(0,i.kt)("br",{parentName:"p"}),"\n","If this path does not exist or does not have the required permissions, a error will be thrown instead of downloading."),(0,i.kt)("h2",{id:"helper-type-anyos"},"Helper Type ",(0,i.kt)("inlineCode",{parentName:"h2"},"AnyOS")),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"AnyOS = OtherOS | LinuxOS")),(0,i.kt)("p",null,"Uses either ",(0,i.kt)("a",{parentName:"p",href:"#values-for-otheros"},(0,i.kt)("inlineCode",{parentName:"a"},"OtherOS"))," or ",(0,i.kt)("a",{parentName:"p",href:"#values-for-linuxos"},(0,i.kt)("inlineCode",{parentName:"a"},"LinuxOS")),"."),(0,i.kt)("h2",{id:"values-for-otheros"},"Values for ",(0,i.kt)("inlineCode",{parentName:"h2"},"OtherOS")),(0,i.kt)("h3",{id:"otheros-os"},"os"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"os: 'aix' | 'android' | 'darwin' | 'freebsd' | 'openbsd' | 'sunos' | 'win32' | 'cygwin' | string")),(0,i.kt)("p",null,"Set the Platform the current system is on."),(0,i.kt)("h2",{id:"values-for-linuxos"},"Values for ",(0,i.kt)("inlineCode",{parentName:"h2"},"LinuxOS")),(0,i.kt)("p",null,"Inherits from ",(0,i.kt)("a",{parentName:"p",href:"#values-for-otheros"},(0,i.kt)("inlineCode",{parentName:"a"},"OtherOS")),"."),(0,i.kt)("h3",{id:"linuxos-os"},"os"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"os: 'linux'")),(0,i.kt)("p",null,"Value of the current Platform the system is on. In ",(0,i.kt)("a",{parentName:"p",href:"#values-for-linuxos"},(0,i.kt)("inlineCode",{parentName:"a"},"LinuxOS")),", this value can only be ",(0,i.kt)("inlineCode",{parentName:"p"},"linux"),"."),(0,i.kt)("h3",{id:"dist"},"dist"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"dist: string")),(0,i.kt)("p",null,"Value of the current Distribution the current system is on."),(0,i.kt)("h3",{id:"release"},"release"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"release: string")),(0,i.kt)("p",null,"Value of the current Release the Distribution is on."),(0,i.kt)("h3",{id:"codename"},"codename"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"codename?: string")),(0,i.kt)("p",null,"Value of the codename of the current Distribution Release."),(0,i.kt)("h3",{id:"id_like"},"id_like"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"id_like?: string[]")),(0,i.kt)("p",null,"List of Distributions this Distribution is like."))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a8d48a20.3b9558a9.js b/assets/js/a8d48a20.3b9558a9.js new file mode 100644 index 000000000..e5f2850fc --- /dev/null +++ b/assets/js/a8d48a20.3b9558a9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[503],{5680:function(e,n,r){r.d(n,{xA:function(){return y},yg:function(){return m}});var o=r(6540);function t(e,n,r){return n in e?Object.defineProperty(e,n,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[n]=r,e}function i(e,n){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),r.push.apply(r,o)}return r}function a(e){for(var n=1;n=0||(t[r]=e[r]);return t}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(t[r]=e[r])}return t}var s=o.createContext({}),p=function(e){var n=o.useContext(s),r=n;return e&&(r="function"==typeof e?e(n):a(a({},n),e)),r},y=function(e){var n=p(e.components);return o.createElement(s.Provider,{value:n},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},g=o.forwardRef((function(e,n){var r=e.components,t=e.mdxType,i=e.originalType,s=e.parentName,y=l(e,["components","mdxType","originalType","parentName"]),d=p(r),g=t,m=d["".concat(s,".").concat(g)]||d[g]||u[g]||i;return r?o.createElement(m,a(a({ref:n},y),{},{components:r})):o.createElement(m,a({ref:n},y))}));function m(e,n){var r=arguments,t=n&&n.mdxType;if("string"==typeof e||t){var i=r.length,a=new Array(i);a[0]=g;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[d]="string"==typeof e?e:t,a[1]=l;for(var p=2;pMongoBinaryOpts",id:"values-for-mongobinaryopts",level:2},{value:"checkMD5",id:"checkmd5",level:3},{value:"Values for BaseDryMongoBinaryOptions",id:"values-for-basedrymongobinaryoptions",level:2},{value:"version",id:"version",level:3},{value:"downloadDir",id:"downloaddir",level:3},{value:"os",id:"os",level:3},{value:"arch",id:"arch",level:3},{value:"platform",id:"platform",level:3},{value:"systemBinary",id:"systembinary",level:3},{value:"Helper Type AnyOS",id:"helper-type-anyos",level:2},{value:"Values for OtherOS",id:"values-for-otheros",level:2},{value:"os",id:"otheros-os",level:3},{value:"Values for LinuxOS",id:"values-for-linuxos",level:2},{value:"os",id:"linuxos-os",level:3},{value:"dist",id:"dist",level:3},{value:"release",id:"release",level:3},{value:"codename",id:"codename",level:3},{value:"id_like",id:"id_like",level:3}],u={toc:d},g="wrapper";function m(e){var n=e.components,r=(0,t.A)(e,a);return(0,i.yg)(g,(0,o.A)({},u,r,{components:n,mdxType:"MDXLayout"}),(0,i.yg)("p",null,"API Documentation of ",(0,i.yg)("inlineCode",{parentName:"p"},"MongoBinaryOpts"),"-Interface"),(0,i.yg)("h2",{id:"values-for-mongobinaryopts"},"Values for ",(0,i.yg)("inlineCode",{parentName:"h2"},"MongoBinaryOpts")),(0,i.yg)("p",null,"Inherits most values from ",(0,i.yg)("a",{parentName:"p",href:"#values-for-basedrymongobinaryoptions"},(0,i.yg)("inlineCode",{parentName:"a"},"BaseDryMongoBinaryOptions")),"."),(0,i.yg)("h3",{id:"checkmd5"},"checkMD5"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"checkMD5?: boolean")),(0,i.yg)("p",null,"Set wheter to perform a MD5 check on the downloaded archive."),(0,i.yg)("h2",{id:"values-for-basedrymongobinaryoptions"},"Values for ",(0,i.yg)("inlineCode",{parentName:"h2"},"BaseDryMongoBinaryOptions")),(0,i.yg)("h3",{id:"version"},"version"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"version?: string")),(0,i.yg)("p",null,"Set which binary version to download, see ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#version"},"config option ",(0,i.yg)("inlineCode",{parentName:"a"},"VERSION"))," for more."),(0,i.yg)("h3",{id:"downloaddir"},"downloadDir"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"downloadDir?: string")),(0,i.yg)("p",null,"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."),(0,i.yg)("h3",{id:"os"},"os"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"os?: AnyOS")),(0,i.yg)("p",null,"Set OS information that is necessary for generating the archive name, uses ",(0,i.yg)("a",{parentName:"p",href:"#helper-type-anyos"},(0,i.yg)("inlineCode",{parentName:"a"},"AnyOS")),"."),(0,i.yg)("h3",{id:"arch"},"arch"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"arch?: string")),(0,i.yg)("p",null,"Set which Architecture to use,supports the same values as ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#arch"},"config option ",(0,i.yg)("inlineCode",{parentName:"a"},"ARCH")),"."),(0,i.yg)("h3",{id:"platform"},"platform"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"platform?: string")),(0,i.yg)("p",null,"Set which Platform to use,supports the same values as ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#platform"},"config option ",(0,i.yg)("inlineCode",{parentName:"a"},"PLATFORM")),"."),(0,i.yg)("h3",{id:"systembinary"},"systemBinary"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"systemBinary?: string")),(0,i.yg)("p",null,"Set the SystemBinary path, if set this path will be used instead of finding a binary.",(0,i.yg)("br",{parentName:"p"}),"\n","If this path does not exist or does not have the required permissions, a error will be thrown instead of downloading."),(0,i.yg)("h2",{id:"helper-type-anyos"},"Helper Type ",(0,i.yg)("inlineCode",{parentName:"h2"},"AnyOS")),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"AnyOS = OtherOS | LinuxOS")),(0,i.yg)("p",null,"Uses either ",(0,i.yg)("a",{parentName:"p",href:"#values-for-otheros"},(0,i.yg)("inlineCode",{parentName:"a"},"OtherOS"))," or ",(0,i.yg)("a",{parentName:"p",href:"#values-for-linuxos"},(0,i.yg)("inlineCode",{parentName:"a"},"LinuxOS")),"."),(0,i.yg)("h2",{id:"values-for-otheros"},"Values for ",(0,i.yg)("inlineCode",{parentName:"h2"},"OtherOS")),(0,i.yg)("h3",{id:"otheros-os"},"os"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"os: 'aix' | 'android' | 'darwin' | 'freebsd' | 'openbsd' | 'sunos' | 'win32' | 'cygwin' | string")),(0,i.yg)("p",null,"Set the Platform the current system is on."),(0,i.yg)("h2",{id:"values-for-linuxos"},"Values for ",(0,i.yg)("inlineCode",{parentName:"h2"},"LinuxOS")),(0,i.yg)("p",null,"Inherits from ",(0,i.yg)("a",{parentName:"p",href:"#values-for-otheros"},(0,i.yg)("inlineCode",{parentName:"a"},"OtherOS")),"."),(0,i.yg)("h3",{id:"linuxos-os"},"os"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"os: 'linux'")),(0,i.yg)("p",null,"Value of the current Platform the system is on. In ",(0,i.yg)("a",{parentName:"p",href:"#values-for-linuxos"},(0,i.yg)("inlineCode",{parentName:"a"},"LinuxOS")),", this value can only be ",(0,i.yg)("inlineCode",{parentName:"p"},"linux"),"."),(0,i.yg)("h3",{id:"dist"},"dist"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"dist: string")),(0,i.yg)("p",null,"Value of the current Distribution the current system is on."),(0,i.yg)("h3",{id:"release"},"release"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"release: string")),(0,i.yg)("p",null,"Value of the current Release the Distribution is on."),(0,i.yg)("h3",{id:"codename"},"codename"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"codename?: string")),(0,i.yg)("p",null,"Value of the codename of the current Distribution Release."),(0,i.yg)("h3",{id:"id_like"},"id_like"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"id_like?: string[]")),(0,i.yg)("p",null,"List of Distributions this Distribution is like."))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a97422aa.6196a1a2.js b/assets/js/a97422aa.6196a1a2.js new file mode 100644 index 000000000..3e488819f --- /dev/null +++ b/assets/js/a97422aa.6196a1a2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[26],{5680:function(e,t,n){n.d(t,{xA:function(){return c},yg:function(){return g}});var a=n(6540);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(n),m=o,g=d["".concat(p,".").concat(m)]||d[m]||u[m]||r;return n?a.createElement(g,i(i({ref:t},c),{},{components:n})):a.createElement(g,i({ref:t},c))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=m;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:o,i[1]=s;for(var l=2;l=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(n),m=o,f=d["".concat(p,".").concat(m)]||d[m]||u[m]||r;return n?a.createElement(f,i(i({ref:t},c),{},{components:n})):a.createElement(f,i({ref:t},c))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=m;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:o,i[1]=s;for(var l=2;l=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),m=p(n),d=a,g=m["".concat(s,".").concat(d)]||m[d]||u[d]||i;return n?r.createElement(g,o(o({ref:t},c),{},{components:n})):r.createElement(g,o({ref:t},c))}));function g(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[m]="string"==typeof e?e:a,o[1]=l;for(var p=2;p {\n // async code in where\n})();\n"))),(0,i.kt)("h2",{id:"requirements"},"Requirements"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"NodeJS: 16.20.1+"),(0,i.kt)("li",{parentName:"ul"},"Typescript: 5.3+ (if used)")),(0,i.kt)("p",null,"When on Linux, one of the following are required:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"having ",(0,i.kt)("inlineCode",{parentName:"li"},"lsb-core")," installed (or any that provides the ",(0,i.kt)("inlineCode",{parentName:"li"},"lsb_release")," command)"),(0,i.kt)("li",{parentName:"ul"},"having an ",(0,i.kt)("inlineCode",{parentName:"li"},"/etc/os-release")," file that is compliant to the ",(0,i.kt)("a",{parentName:"li",href:"https://www.freedesktop.org/software/systemd/man/os-release.html"},"OS-Release Spec")),(0,i.kt)("li",{parentName:"ul"},"having an ",(0,i.kt)("inlineCode",{parentName:"li"},"/etc/*-release")," file that is compliant to the ",(0,i.kt)("a",{parentName:"li",href:"https://www.freedesktop.org/software/systemd/man/os-release.html"},"OS-Release Spec")," (and does not include ",(0,i.kt)("inlineCode",{parentName:"li"},"lsb"),")"),(0,i.kt)("li",{parentName:"ul"},"manually specify which version & system should be used")),(0,i.kt)("p",null,"On Linux, you will also need ",(0,i.kt)("inlineCode",{parentName:"p"},"libcurl")," (or ",(0,i.kt)("inlineCode",{parentName:"p"},"libcurl3"),' on some older distro versions). This will probably only be an issue on "slim" Docker images.'),(0,i.kt)("h2",{id:"choose-the-right-package"},"Choose the right package"),(0,i.kt)("p",null,"There are multiple packages for this project, here are the differences:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"mongodb-memory-server-core")," is the main package, which does not have any hooks on install"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"mongodb-memory-server")," adds hooks to install on ",(0,i.kt)("inlineCode",{parentName:"li"},"yarn install")," or ",(0,i.kt)("inlineCode",{parentName:"li"},"npm install")," to install the ",(0,i.kt)("em",{parentName:"li"},"latest package locally")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"mongodb-memory-server-global")," adds hooks to install on ",(0,i.kt)("inlineCode",{parentName:"li"},"yarn install")," or ",(0,i.kt)("inlineCode",{parentName:"li"},"npm install")," to install the ",(0,i.kt)("em",{parentName:"li"},"latest package globally")," (into $HOME)"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"mongodb-memory-server-global-X.X")," adds hooks to install on ",(0,i.kt)("inlineCode",{parentName:"li"},"yarn install")," or ",(0,i.kt)("inlineCode",{parentName:"li"},"npm install")," to install ",(0,i.kt)("em",{parentName:"li"},"MongoDB with version ",(0,i.kt)("inlineCode",{parentName:"em"},"X.X")," globally")," (into $HOME)")),(0,i.kt)("h2",{id:"normal-server"},"Normal Server"),(0,i.kt)("p",null,"A Normal Server can be easily started with:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"import { MongoMemoryServer } from 'mongodb-memory-server';\n\n// This will create an new instance of \"MongoMemoryServer\" and automatically start it\nconst mongod = await MongoMemoryServer.create();\n\nconst uri = mongod.getUri();\n\n// The Server can be stopped again with\nawait mongod.stop();\n")),(0,i.kt)("h2",{id:"replicaset"},"ReplicaSet"),(0,i.kt)("p",null,"A ReplicaSet can be easily started with:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'import { MongoMemoryReplSet } from \'mongodb-memory-server\';\n\n// This will create an new instance of "MongoMemoryReplSet" and automatically start all Servers\nconst replset = await MongoMemoryReplSet.create({ replSet: { count: 4 } }); // This will create an ReplSet with 4 members\n// To use Transactions, the "storageEngine" needs to be changed to `wiredTiger`\nconst replset = await MongoMemoryReplSet.create({ replSet: { count: 4, storageEngine: \'wiredTiger\' } }); // This will create an ReplSet with 4 members and storage-engine "wiredTiger"\n\nconst uri = replset.getUri();\n\n// The ReplSet can be stopped again with\nawait replset.stop();\n')),(0,i.kt)("h2",{id:"final-notes"},"Final Notes"),(0,i.kt)("admonition",{type:"danger"},(0,i.kt)("p",{parentName:"admonition"},"When you are not using a global instance for tests and run multi-threaded tests, it can cause Race Conditions.")))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/af543849.ed0acd37.js b/assets/js/af543849.ed0acd37.js new file mode 100644 index 000000000..eaeac1133 --- /dev/null +++ b/assets/js/af543849.ed0acd37.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[153],{5680:function(e,n,t){t.d(n,{xA:function(){return c},yg:function(){return d}});var r=t(6540);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},c=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},g=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),m=p(t),g=a,d=m["".concat(s,".").concat(g)]||m[g]||u[g]||i;return t?r.createElement(d,o(o({ref:n},c),{},{components:t})):r.createElement(d,o({ref:n},c))}));function d(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=g;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[m]="string"==typeof e?e:a,o[1]=l;for(var p=2;p {\n // async code in where\n})();\n"))),(0,i.yg)("h2",{id:"requirements"},"Requirements"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"NodeJS: 16.20.1+"),(0,i.yg)("li",{parentName:"ul"},"Typescript: 5.3+ (if used)")),(0,i.yg)("p",null,"When on Linux, one of the following are required:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"having ",(0,i.yg)("inlineCode",{parentName:"li"},"lsb-core")," installed (or any that provides the ",(0,i.yg)("inlineCode",{parentName:"li"},"lsb_release")," command)"),(0,i.yg)("li",{parentName:"ul"},"having an ",(0,i.yg)("inlineCode",{parentName:"li"},"/etc/os-release")," file that is compliant to the ",(0,i.yg)("a",{parentName:"li",href:"https://www.freedesktop.org/software/systemd/man/os-release.html"},"OS-Release Spec")),(0,i.yg)("li",{parentName:"ul"},"having an ",(0,i.yg)("inlineCode",{parentName:"li"},"/etc/*-release")," file that is compliant to the ",(0,i.yg)("a",{parentName:"li",href:"https://www.freedesktop.org/software/systemd/man/os-release.html"},"OS-Release Spec")," (and does not include ",(0,i.yg)("inlineCode",{parentName:"li"},"lsb"),")"),(0,i.yg)("li",{parentName:"ul"},"manually specify which version & system should be used")),(0,i.yg)("p",null,"On Linux, you will also need ",(0,i.yg)("inlineCode",{parentName:"p"},"libcurl")," (or ",(0,i.yg)("inlineCode",{parentName:"p"},"libcurl3"),' on some older distro versions). This will probably only be an issue on "slim" Docker images.'),(0,i.yg)("h2",{id:"choose-the-right-package"},"Choose the right package"),(0,i.yg)("p",null,"There are multiple packages for this project, here are the differences:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"mongodb-memory-server-core")," is the main package, which does not have any hooks on install"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"mongodb-memory-server")," adds hooks to install on ",(0,i.yg)("inlineCode",{parentName:"li"},"yarn install")," or ",(0,i.yg)("inlineCode",{parentName:"li"},"npm install")," to install the ",(0,i.yg)("em",{parentName:"li"},"latest package locally")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"mongodb-memory-server-global")," adds hooks to install on ",(0,i.yg)("inlineCode",{parentName:"li"},"yarn install")," or ",(0,i.yg)("inlineCode",{parentName:"li"},"npm install")," to install the ",(0,i.yg)("em",{parentName:"li"},"latest package globally")," (into $HOME)"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"mongodb-memory-server-global-X.X")," adds hooks to install on ",(0,i.yg)("inlineCode",{parentName:"li"},"yarn install")," or ",(0,i.yg)("inlineCode",{parentName:"li"},"npm install")," to install ",(0,i.yg)("em",{parentName:"li"},"MongoDB with version ",(0,i.yg)("inlineCode",{parentName:"em"},"X.X")," globally")," (into $HOME)")),(0,i.yg)("h2",{id:"normal-server"},"Normal Server"),(0,i.yg)("p",null,"A Normal Server can be easily started with:"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-ts"},"import { MongoMemoryServer } from 'mongodb-memory-server';\n\n// This will create an new instance of \"MongoMemoryServer\" and automatically start it\nconst mongod = await MongoMemoryServer.create();\n\nconst uri = mongod.getUri();\n\n// The Server can be stopped again with\nawait mongod.stop();\n")),(0,i.yg)("h2",{id:"replicaset"},"ReplicaSet"),(0,i.yg)("p",null,"A ReplicaSet can be easily started with:"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-ts"},'import { MongoMemoryReplSet } from \'mongodb-memory-server\';\n\n// This will create an new instance of "MongoMemoryReplSet" and automatically start all Servers\nconst replset = await MongoMemoryReplSet.create({ replSet: { count: 4 } }); // This will create an ReplSet with 4 members\n// To use Transactions, the "storageEngine" needs to be changed to `wiredTiger`\nconst replset = await MongoMemoryReplSet.create({ replSet: { count: 4, storageEngine: \'wiredTiger\' } }); // This will create an ReplSet with 4 members and storage-engine "wiredTiger"\n\nconst uri = replset.getUri();\n\n// The ReplSet can be stopped again with\nawait replset.stop();\n')),(0,i.yg)("h2",{id:"final-notes"},"Final Notes"),(0,i.yg)("admonition",{type:"danger"},(0,i.yg)("p",{parentName:"admonition"},"When you are not using a global instance for tests and run multi-threaded tests, it can cause Race Conditions.")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b0db94fd.42364ff9.js b/assets/js/b0db94fd.42364ff9.js new file mode 100644 index 000000000..1b0b75f90 --- /dev/null +++ b/assets/js/b0db94fd.42364ff9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[506],{5680:function(e,r,t){t.d(r,{xA:function(){return p},yg:function(){return y}});var n=t(6540);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function i(e){for(var r=1;r=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var l=n.createContext({}),c=function(e){var r=n.useContext(l),t=r;return e&&(t="function"==typeof e?e(r):i(i({},r),e)),t},p=function(e){var r=c(e.components);return n.createElement(l.Provider,{value:r},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},d=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),m=c(t),d=o,y=m["".concat(l,".").concat(d)]||m[d]||u[d]||a;return t?n.createElement(y,i(i({ref:r},p),{},{components:t})):n.createElement(y,i({ref:r},p))}));function y(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=d;var s={};for(var l in r)hasOwnProperty.call(r,l)&&(s[l]=r[l]);s.originalType=e,s[m]="string"==typeof e?e:o,i[1]=s;for(var c=2;c=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),m=c(r),d=o,f=m["".concat(l,".").concat(d)]||m[d]||u[d]||a;return r?n.createElement(f,i(i({ref:t},p),{},{components:r})):n.createElement(f,i({ref:t},p))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:o,i[1]=s;for(var c=2;c=0||(o[n]=e[n]);return o}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=t.createContext({}),u=function(e){var r=t.useContext(c),n=r;return e&&(n="function"==typeof e?e(r):s(s({},r),e)),n},m=function(e){var r=u(e.components);return t.createElement(c.Provider,{value:r},e.children)},p="mdxType",l={inlineCode:"code",wrapper:function(e){var r=e.children;return t.createElement(t.Fragment,{},r)}},d=t.forwardRef((function(e,r){var n=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,m=a(e,["components","mdxType","originalType","parentName"]),p=u(n),d=o,y=p["".concat(c,".").concat(d)]||p[d]||l[d]||i;return n?t.createElement(y,s(s({ref:r},m),{},{components:n})):t.createElement(y,s({ref:r},m))}));function y(e,r){var n=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var i=n.length,s=new Array(i);s[0]=d;var a={};for(var c in r)hasOwnProperty.call(r,c)&&(a[c]=r[c]);a.originalType=e,a[p]="string"==typeof e?e:o,s[1]=a;for(var u=2;u 0) {\n retries -= 1;\n try {\n await _setup(db);\n } catch (err) {\n if (err instanceof mongodb.MongoWriteConcernError && /operation was interrupted/.test(err.message)) {\n continue;\n }\n\n throw err;\n }\n }\n}\n\nasync function _setup(db) {\n await db.dropDatabase();\n}\n")),(0,i.kt)("p",null,"See ",(0,i.kt)("a",{parentName:"p",href:"https://www.mongodb.com/docs/manual/core/retryable-writes/#retryable-write-operations"},"Operations which are retry-able"),"."))}y.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[416],{5680:function(e,r,n){n.d(r,{xA:function(){return m},yg:function(){return y}});var t=n(6540);function o(e,r,n){return r in e?Object.defineProperty(e,r,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[r]=n,e}function i(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 s(e){for(var r=1;r=0||(o[n]=e[n]);return o}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=t.createContext({}),u=function(e){var r=t.useContext(c),n=r;return e&&(n="function"==typeof e?e(r):s(s({},r),e)),n},m=function(e){var r=u(e.components);return t.createElement(c.Provider,{value:r},e.children)},p="mdxType",l={inlineCode:"code",wrapper:function(e){var r=e.children;return t.createElement(t.Fragment,{},r)}},d=t.forwardRef((function(e,r){var n=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,m=a(e,["components","mdxType","originalType","parentName"]),p=u(n),d=o,y=p["".concat(c,".").concat(d)]||p[d]||l[d]||i;return n?t.createElement(y,s(s({ref:r},m),{},{components:n})):t.createElement(y,s({ref:r},m))}));function y(e,r){var n=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var i=n.length,s=new Array(i);s[0]=d;var a={};for(var c in r)hasOwnProperty.call(r,c)&&(a[c]=r[c]);a.originalType=e,a[p]="string"==typeof e?e:o,s[1]=a;for(var u=2;u 0) {\n retries -= 1;\n try {\n await _setup(db);\n } catch (err) {\n if (err instanceof mongodb.MongoWriteConcernError && /operation was interrupted/.test(err.message)) {\n continue;\n }\n\n throw err;\n }\n }\n}\n\nasync function _setup(db) {\n await db.dropDatabase();\n}\n")),(0,i.yg)("p",null,"See ",(0,i.yg)("a",{parentName:"p",href:"https://www.mongodb.com/docs/manual/core/retryable-writes/#retryable-write-operations"},"Operations which are retry-able"),"."))}y.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c4f5d8e4.6b49d40d.js b/assets/js/c4f5d8e4.6b49d40d.js new file mode 100644 index 000000000..a320458da --- /dev/null +++ b/assets/js/c4f5d8e4.6b49d40d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[634],{2468:function(e,t,n){n.r(t),n.d(t,{default:function(){return g}});var r=n(8168),a=n(6540),s=n(53),o=n(8816),i=n(5489),l=n(4586),m=n(6025),c={heroBanner:"heroBanner_UJJx",buttons:"buttons_pzbO",features:"features_keug",featureImage:"featureImage_yA8i"},u=[{title:"Easy to Use",description:a.createElement(a.Fragment,null,'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)')},{title:"Supports all MongoDB supports systems",description:a.createElement(a.Fragment,null,"mongodb-memory-server supporst all systems there are mongodb binaries are for, including some unofficial environments where some other binary works.")},{title:"Supports both Single-Instance and Replica Sets",description:a.createElement(a.Fragment,null,"mongodb-memory-server can be quickly used with single mongodb instances or spin up a entire replicaset.")}];function d(e){var t=e.imageUrl,n=e.title,r=e.description,o=(0,m.A)(t);return a.createElement("div",{className:(0,s.A)("col col--4",c.feature)},o&&a.createElement("div",{className:"text--center"},a.createElement("img",{className:c.featureImage,src:o,alt:n})),a.createElement("h3",null,n),a.createElement("p",null,r))}var g=function(){var e=(0,l.A)().siteConfig,t=void 0===e?{}:e;return a.createElement(o.A,{title:t.title,description:t.tagline},a.createElement("header",{className:(0,s.A)("hero hero--primary",c.heroBanner)},a.createElement("div",{className:"container"},a.createElement("h1",{className:"hero__title"},t.title),a.createElement("p",{className:"hero__subtitle"},t.tagline),a.createElement("div",{className:c.buttons},a.createElement(i.A,{className:(0,s.A)("button button--outline button--secondary button--lg",c.getStarted),to:(0,m.A)("docs/guides/quick-start-guide")},"Get Started")))),a.createElement("main",null,u&&u.length>0&&a.createElement("section",{className:c.features},a.createElement("div",{className:"container"},a.createElement("div",{className:"row"},u.map((function(e,t){return a.createElement(d,(0,r.A)({key:t},e))})))))))}}}]); \ No newline at end of file diff --git a/assets/js/c4f5d8e4.998c3770.js b/assets/js/c4f5d8e4.998c3770.js deleted file mode 100644 index 0025426e9..000000000 --- a/assets/js/c4f5d8e4.998c3770.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[195],{5239:function(e,t,n){n.r(t),n.d(t,{default:function(){return g}});var r=n(7462),a=n(7294),s=n(6010),o=n(5163),i=n(9960),l=n(2263),m=n(4996),c={heroBanner:"heroBanner_UJJx",buttons:"buttons_pzbO",features:"features_keug",featureImage:"featureImage_yA8i"},u=[{title:"Easy to Use",description:a.createElement(a.Fragment,null,'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)')},{title:"Supports all MongoDB supports systems",description:a.createElement(a.Fragment,null,"mongodb-memory-server supporst all systems there are mongodb binaries are for, including some unofficial environments where some other binary works.")},{title:"Supports both Single-Instance and Replica Sets",description:a.createElement(a.Fragment,null,"mongodb-memory-server can be quickly used with single mongodb instances or spin up a entire replicaset.")}];function d(e){var t=e.imageUrl,n=e.title,r=e.description,o=(0,m.Z)(t);return a.createElement("div",{className:(0,s.Z)("col col--4",c.feature)},o&&a.createElement("div",{className:"text--center"},a.createElement("img",{className:c.featureImage,src:o,alt:n})),a.createElement("h3",null,n),a.createElement("p",null,r))}var g=function(){var e=(0,l.Z)().siteConfig,t=void 0===e?{}:e;return a.createElement(o.Z,{title:t.title,description:t.tagline},a.createElement("header",{className:(0,s.Z)("hero hero--primary",c.heroBanner)},a.createElement("div",{className:"container"},a.createElement("h1",{className:"hero__title"},t.title),a.createElement("p",{className:"hero__subtitle"},t.tagline),a.createElement("div",{className:c.buttons},a.createElement(i.Z,{className:(0,s.Z)("button button--outline button--secondary button--lg",c.getStarted),to:(0,m.Z)("docs/guides/quick-start-guide")},"Get Started")))),a.createElement("main",null,u&&u.length>0&&a.createElement("section",{className:c.features},a.createElement("div",{className:"container"},a.createElement("div",{className:"row"},u.map((function(e,t){return a.createElement(d,(0,r.Z)({key:t},e))})))))))}}}]); \ No newline at end of file diff --git a/assets/js/ca5259b8.06396863.js b/assets/js/ca5259b8.06396863.js new file mode 100644 index 000000000..549a73952 --- /dev/null +++ b/assets/js/ca5259b8.06396863.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[362],{5680:function(e,n,r){r.d(n,{xA:function(){return s},yg:function(){return d}});var t=r(6540);function a(e,n,r){return n in e?Object.defineProperty(e,n,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[n]=r,e}function o(e,n){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),r.push.apply(r,t)}return r}function i(e){for(var n=1;n=0||(a[r]=e[r]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=t.createContext({}),m=function(e){var n=t.useContext(p),r=n;return e&&(r="function"==typeof e?e(n):i(i({},n),e)),r},s=function(e){var n=m(e.components);return t.createElement(p.Provider,{value:n},e.children)},y="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},g=t.forwardRef((function(e,n){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),y=m(r),g=a,d=y["".concat(p,".").concat(g)]||y[g]||c[g]||o;return r?t.createElement(d,i(i({ref:n},s),{},{components:r})):t.createElement(d,i({ref:n},s))}));function d(e,n){var r=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=g;var l={};for(var p in n)hasOwnProperty.call(n,p)&&(l[p]=n[p]);l.originalType=e,l[y]="string"==typeof e?e:a,i[1]=l;for(var m=2;m=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var p=r.createContext({}),m=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},s=function(e){var n=m(e.components);return r.createElement(p.Provider,{value:n},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),c=m(t),u=a,f=c["".concat(p,".").concat(u)]||c[u]||d[u]||o;return t?r.createElement(f,i(i({ref:n},s),{},{components:t})):r.createElement(f,i({ref:n},s))}));function f(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,i=new Array(o);i[0]=u;var l={};for(var p in n)hasOwnProperty.call(n,p)&&(l[p]=n[p]);l.originalType=e,l[c]="string"==typeof e?e:a,i[1]=l;for(var m=2;m=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=s(n),c=a,g=d["".concat(l,".").concat(c)]||d[c]||u[c]||o;return n?r.createElement(g,i(i({ref:t},m),{},{components:n})):r.createElement(g,i({ref:t},m))}));function g(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=c;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[d]="string"==typeof e?e:a,i[1]=p;for(var s=2;sMongoMemoryInstanceOpts",id:"values-for-mongomemoryinstanceopts",level:2},{value:"auth",id:"auth",level:3},{value:"dbName",id:"dbname",level:3},{value:"ip",id:"ip",level:3},{value:"replSet",id:"replset",level:3},{value:"keyfileLocation",id:"keyfilelocation",level:3},{value:"Values for MongoMemoryInstanceOptsBase",id:"values-for-mongomemoryinstanceoptsbase",level:2},{value:"args",id:"args",level:3},{value:"port",id:"port",level:3},{value:"dbPath",id:"dbpath",level:3},{value:"storageEngine",id:"storageengine",level:3},{value:"replicaMemberConfig",id:"replicamemberconfig",level:3},{value:"Helper Type StorageEngine",id:"helper-type-storageengine",level:2}],u={toc:d},c="wrapper";function g(e){var t=e.components,n=(0,a.Z)(e,i);return(0,o.kt)(c,(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,"API Documentation of ",(0,o.kt)("inlineCode",{parentName:"p"},"MongoMemoryInstanceOpts"),"-Interface"),(0,o.kt)("h2",{id:"values-for-mongomemoryinstanceopts"},"Values for ",(0,o.kt)("inlineCode",{parentName:"h2"},"MongoMemoryInstanceOpts")),(0,o.kt)("p",null,"Inherits from ",(0,o.kt)("a",{parentName:"p",href:"#values-for-mongomemoryinstanceoptsbase"},(0,o.kt)("inlineCode",{parentName:"a"},"MongoMemoryInstanceOptsBase")),"."),(0,o.kt)("h3",{id:"auth"},"auth"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"auth?: boolean"),(0,o.kt)("br",{parentName:"p"}),"\n","Default: ",(0,o.kt)("inlineCode",{parentName:"p"},"false")),(0,o.kt)("p",null,"Set which option auth argument to add:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"if ",(0,o.kt)("inlineCode",{parentName:"li"},"true"),", add ",(0,o.kt)("inlineCode",{parentName:"li"},"--auth")),(0,o.kt)("li",{parentName:"ul"},"if ",(0,o.kt)("inlineCode",{parentName:"li"},"false"),", add ",(0,o.kt)("inlineCode",{parentName:"li"},"--noauth"))),(0,o.kt)("p",null,"This options gets automatically set (overwritten) when using ",(0,o.kt)("inlineCode",{parentName:"p"},"createAuth"),"."),(0,o.kt)("h3",{id:"dbname"},"dbName"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"dbName?: string")),(0,o.kt)("p",null,"Previously set the ",(0,o.kt)("inlineCode",{parentName:"p"},"dbName")," for the ",(0,o.kt)("inlineCode",{parentName:"p"},"getUri")," calls, but currently unused."),(0,o.kt)("h3",{id:"ip"},"ip"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"ip?: string")),(0,o.kt)("p",null,"Set the ip to bind to, if defined will add the argument ",(0,o.kt)("inlineCode",{parentName:"p"},"--bind_ip")," with the input string."),(0,o.kt)("h3",{id:"replset"},"replSet"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"replSet?: string")),(0,o.kt)("p",null,"Set the ReplSet name to use, if defined will add the argument ",(0,o.kt)("inlineCode",{parentName:"p"},"--replSet")," with the input string."),(0,o.kt)("h3",{id:"keyfilelocation"},"keyfileLocation"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"keyfileLocation?: string")),(0,o.kt)("p",null,"Set a custom location for where the keyfile for authentication will be stored, if defined will add the argument ",(0,o.kt)("inlineCode",{parentName:"p"},"--keyfile")," with the input string.",(0,o.kt)("br",{parentName:"p"}),"\n","Only has a effect when used in a ",(0,o.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-replset"},(0,o.kt)("inlineCode",{parentName:"a"},"MongoMemoryReplSet"))," and ",(0,o.kt)("inlineCode",{parentName:"p"},"auth")," is enabled.",(0,o.kt)("br",{parentName:"p"}),"\n","This option will get automatically set when not manually defined."),(0,o.kt)("h2",{id:"values-for-mongomemoryinstanceoptsbase"},"Values for ",(0,o.kt)("inlineCode",{parentName:"h2"},"MongoMemoryInstanceOptsBase")),(0,o.kt)("h3",{id:"args"},"args"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"args?: string[]")),(0,o.kt)("p",null,"Set extra Arguments to add to the started instance, will likely overwrite arguments set by other options, depending on how the binary parses arguments."),(0,o.kt)("h3",{id:"port"},"port"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"port?: number")),(0,o.kt)("p",null,"When set, adds the ",(0,o.kt)("inlineCode",{parentName:"p"},"--port")," argument with the input.",(0,o.kt)("br",{parentName:"p"}),"\n","This options will get automatically set with a free port that is found."),(0,o.kt)("h3",{id:"dbpath"},"dbPath"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"dbPath?: string")),(0,o.kt)("p",null,"When set, adds the ",(0,o.kt)("inlineCode",{parentName:"p"},"--dbpath")," argument with the input.",(0,o.kt)("br",{parentName:"p"}),"\n","This option will automatically be set with a directory generated by ",(0,o.kt)("a",{parentName:"p",href:"https://nodejs.org/api/fs.html#fspromisesmkdtempprefix-options"},(0,o.kt)("inlineCode",{parentName:"a"},"mkdtemp")),"."),(0,o.kt)("h3",{id:"storageengine"},"storageEngine"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"storageEngine?: StorageEngine"),(0,o.kt)("br",{parentName:"p"}),"\n","Default: ",(0,o.kt)("inlineCode",{parentName:"p"},"ephemeralForTest")," (unless mongodb version is ",(0,o.kt)("inlineCode",{parentName:"p"},"7.0.0"),", where its ",(0,o.kt)("inlineCode",{parentName:"p"},"wiredTiger"),")"),(0,o.kt)("p",null,"Set which storage engine to use, uses ",(0,o.kt)("a",{parentName:"p",href:"#helper-type-storageengine"},(0,o.kt)("inlineCode",{parentName:"a"},"StorageEngine")),"."),(0,o.kt)("h3",{id:"replicamemberconfig"},"replicaMemberConfig"),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"replicaMemberConfig?: ReplicaMemberConfig")),(0,o.kt)("p",null,"Set custom a custom Replica Member Config, uses ",(0,o.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/mongo-memory-instance-replicamemberconfig"},(0,o.kt)("inlineCode",{parentName:"a"},"ReplicaMemberConfig")),".",(0,o.kt)("br",{parentName:"p"}),"\n","Only has a effect when started with ",(0,o.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-replset"},(0,o.kt)("inlineCode",{parentName:"a"},"MongoMemoryReplSet")),"."),(0,o.kt)("h2",{id:"helper-type-storageengine"},"Helper Type ",(0,o.kt)("inlineCode",{parentName:"h2"},"StorageEngine")),(0,o.kt)("p",null,"Typings: ",(0,o.kt)("inlineCode",{parentName:"p"},"StorageEngine = 'ephemeralForTest' | 'wiredTiger'")),(0,o.kt)("p",null,"Storage Engines supported by mongodb, see ",(0,o.kt)("a",{parentName:"p",href:"https://www.mongodb.com/docs/manual/core/storage-engines/"},"MongoDB Storage Engines"),"."),(0,o.kt)("p",null,"Custom Explanation:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"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"),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"wiredTiger")," is a storage engine which stores data on disk.")),(0,o.kt)("admonition",{type:"warning"},(0,o.kt)("p",{parentName:"admonition"},"MongoDB has stated that storage-engine ",(0,o.kt)("inlineCode",{parentName:"p"},"ephemeralForTest")," is unstable and has been deprecated, it will be removed with mongodb 7."),(0,o.kt)("p",{parentName:"admonition"},"In MMS there has been no observation of ",(0,o.kt)("inlineCode",{parentName:"p"},"ephemeralForTest")," being unstable (aside from some missing features) and will continue to be the default until mongodb-memory-server changes to a version where ",(0,o.kt)("inlineCode",{parentName:"p"},"ephemeralForTest")," is not present anymore."),(0,o.kt)("p",{parentName:"admonition"},"With mongodb-memory-server 9.0.0, if mongodb 7.0.0 or higher is used, ",(0,o.kt)("inlineCode",{parentName:"p"},"wiredTiger")," is the default engine.")))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d351376f.ba3000bd.js b/assets/js/d351376f.ba3000bd.js new file mode 100644 index 000000000..59eca1681 --- /dev/null +++ b/assets/js/d351376f.ba3000bd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[712],{5680:function(e,n,t){t.d(n,{xA:function(){return g},yg:function(){return u}});var r=t(6540);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),s=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},g=function(e){var n=s(e.components);return r.createElement(l.Provider,{value:n},e.children)},m="mdxType",y={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,g=p(e,["components","mdxType","originalType","parentName"]),m=s(t),d=a,u=m["".concat(l,".").concat(d)]||m[d]||y[d]||o;return t?r.createElement(u,i(i({ref:n},g),{},{components:t})):r.createElement(u,i({ref:n},g))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,i=new Array(o);i[0]=d;var p={};for(var l in n)hasOwnProperty.call(n,l)&&(p[l]=n[l]);p.originalType=e,p[m]="string"==typeof e?e:a,i[1]=p;for(var s=2;sMongoMemoryInstanceOpts",id:"values-for-mongomemoryinstanceopts",level:2},{value:"auth",id:"auth",level:3},{value:"dbName",id:"dbname",level:3},{value:"ip",id:"ip",level:3},{value:"replSet",id:"replset",level:3},{value:"keyfileLocation",id:"keyfilelocation",level:3},{value:"Values for MongoMemoryInstanceOptsBase",id:"values-for-mongomemoryinstanceoptsbase",level:2},{value:"args",id:"args",level:3},{value:"port",id:"port",level:3},{value:"dbPath",id:"dbpath",level:3},{value:"storageEngine",id:"storageengine",level:3},{value:"replicaMemberConfig",id:"replicamemberconfig",level:3},{value:"Helper Type StorageEngine",id:"helper-type-storageengine",level:2}],y={toc:m},d="wrapper";function u(e){var n=e.components,t=(0,a.A)(e,i);return(0,o.yg)(d,(0,r.A)({},y,t,{components:n,mdxType:"MDXLayout"}),(0,o.yg)("p",null,"API Documentation of ",(0,o.yg)("inlineCode",{parentName:"p"},"MongoMemoryInstanceOpts"),"-Interface"),(0,o.yg)("h2",{id:"values-for-mongomemoryinstanceopts"},"Values for ",(0,o.yg)("inlineCode",{parentName:"h2"},"MongoMemoryInstanceOpts")),(0,o.yg)("p",null,"Inherits from ",(0,o.yg)("a",{parentName:"p",href:"#values-for-mongomemoryinstanceoptsbase"},(0,o.yg)("inlineCode",{parentName:"a"},"MongoMemoryInstanceOptsBase")),"."),(0,o.yg)("h3",{id:"auth"},"auth"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"auth?: boolean"),(0,o.yg)("br",{parentName:"p"}),"\n","Default: ",(0,o.yg)("inlineCode",{parentName:"p"},"false")),(0,o.yg)("p",null,"Set which option auth argument to add:"),(0,o.yg)("ul",null,(0,o.yg)("li",{parentName:"ul"},"if ",(0,o.yg)("inlineCode",{parentName:"li"},"true"),", add ",(0,o.yg)("inlineCode",{parentName:"li"},"--auth")),(0,o.yg)("li",{parentName:"ul"},"if ",(0,o.yg)("inlineCode",{parentName:"li"},"false"),", add ",(0,o.yg)("inlineCode",{parentName:"li"},"--noauth"))),(0,o.yg)("p",null,"This options gets automatically set (overwritten) when using ",(0,o.yg)("inlineCode",{parentName:"p"},"createAuth"),"."),(0,o.yg)("h3",{id:"dbname"},"dbName"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"dbName?: string")),(0,o.yg)("p",null,"Previously set the ",(0,o.yg)("inlineCode",{parentName:"p"},"dbName")," for the ",(0,o.yg)("inlineCode",{parentName:"p"},"getUri")," calls, but currently unused."),(0,o.yg)("h3",{id:"ip"},"ip"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"ip?: string")),(0,o.yg)("p",null,"Set the ip to bind to, if defined will add the argument ",(0,o.yg)("inlineCode",{parentName:"p"},"--bind_ip")," with the input string."),(0,o.yg)("h3",{id:"replset"},"replSet"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"replSet?: string")),(0,o.yg)("p",null,"Set the ReplSet name to use, if defined will add the argument ",(0,o.yg)("inlineCode",{parentName:"p"},"--replSet")," with the input string."),(0,o.yg)("h3",{id:"keyfilelocation"},"keyfileLocation"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"keyfileLocation?: string")),(0,o.yg)("p",null,"Set a custom location for where the keyfile for authentication will be stored, if defined will add the argument ",(0,o.yg)("inlineCode",{parentName:"p"},"--keyfile")," with the input string.",(0,o.yg)("br",{parentName:"p"}),"\n","Only has a effect when used in a ",(0,o.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-replset"},(0,o.yg)("inlineCode",{parentName:"a"},"MongoMemoryReplSet"))," and ",(0,o.yg)("inlineCode",{parentName:"p"},"auth")," is enabled.",(0,o.yg)("br",{parentName:"p"}),"\n","This option will get automatically set when not manually defined."),(0,o.yg)("h2",{id:"values-for-mongomemoryinstanceoptsbase"},"Values for ",(0,o.yg)("inlineCode",{parentName:"h2"},"MongoMemoryInstanceOptsBase")),(0,o.yg)("h3",{id:"args"},"args"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"args?: string[]")),(0,o.yg)("p",null,"Set extra Arguments to add to the started instance, will likely overwrite arguments set by other options, depending on how the binary parses arguments."),(0,o.yg)("h3",{id:"port"},"port"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"port?: number")),(0,o.yg)("p",null,"When set, adds the ",(0,o.yg)("inlineCode",{parentName:"p"},"--port")," argument with the input.",(0,o.yg)("br",{parentName:"p"}),"\n","This options will get automatically set with a free port that is found."),(0,o.yg)("h3",{id:"dbpath"},"dbPath"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"dbPath?: string")),(0,o.yg)("p",null,"When set, adds the ",(0,o.yg)("inlineCode",{parentName:"p"},"--dbpath")," argument with the input.",(0,o.yg)("br",{parentName:"p"}),"\n","This option will automatically be set with a directory generated by ",(0,o.yg)("a",{parentName:"p",href:"https://nodejs.org/api/fs.html#fspromisesmkdtempprefix-options"},(0,o.yg)("inlineCode",{parentName:"a"},"mkdtemp")),"."),(0,o.yg)("h3",{id:"storageengine"},"storageEngine"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"storageEngine?: StorageEngine"),(0,o.yg)("br",{parentName:"p"}),"\n","Default: ",(0,o.yg)("inlineCode",{parentName:"p"},"ephemeralForTest")," (unless mongodb version is ",(0,o.yg)("inlineCode",{parentName:"p"},"7.0.0"),", where its ",(0,o.yg)("inlineCode",{parentName:"p"},"wiredTiger"),")"),(0,o.yg)("p",null,"Set which storage engine to use, uses ",(0,o.yg)("a",{parentName:"p",href:"#helper-type-storageengine"},(0,o.yg)("inlineCode",{parentName:"a"},"StorageEngine")),"."),(0,o.yg)("h3",{id:"replicamemberconfig"},"replicaMemberConfig"),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"replicaMemberConfig?: ReplicaMemberConfig")),(0,o.yg)("p",null,"Set custom a custom Replica Member Config, uses ",(0,o.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/mongo-memory-instance-replicamemberconfig"},(0,o.yg)("inlineCode",{parentName:"a"},"ReplicaMemberConfig")),".",(0,o.yg)("br",{parentName:"p"}),"\n","Only has a effect when started with ",(0,o.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-replset"},(0,o.yg)("inlineCode",{parentName:"a"},"MongoMemoryReplSet")),"."),(0,o.yg)("h2",{id:"helper-type-storageengine"},"Helper Type ",(0,o.yg)("inlineCode",{parentName:"h2"},"StorageEngine")),(0,o.yg)("p",null,"Typings: ",(0,o.yg)("inlineCode",{parentName:"p"},"StorageEngine = 'ephemeralForTest' | 'wiredTiger'")),(0,o.yg)("p",null,"Storage Engines supported by mongodb, see ",(0,o.yg)("a",{parentName:"p",href:"https://www.mongodb.com/docs/manual/core/storage-engines/"},"MongoDB Storage Engines"),"."),(0,o.yg)("p",null,"Custom Explanation:"),(0,o.yg)("ul",null,(0,o.yg)("li",{parentName:"ul"},(0,o.yg)("inlineCode",{parentName:"li"},"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"),(0,o.yg)("li",{parentName:"ul"},(0,o.yg)("inlineCode",{parentName:"li"},"wiredTiger")," is a storage engine which stores data on disk.")),(0,o.yg)("admonition",{type:"warning"},(0,o.yg)("p",{parentName:"admonition"},"MongoDB has stated that storage-engine ",(0,o.yg)("inlineCode",{parentName:"p"},"ephemeralForTest")," is unstable and has been deprecated, it will be removed with mongodb 7."),(0,o.yg)("p",{parentName:"admonition"},"In MMS there has been no observation of ",(0,o.yg)("inlineCode",{parentName:"p"},"ephemeralForTest")," being unstable (aside from some missing features) and will continue to be the default until mongodb-memory-server changes to a version where ",(0,o.yg)("inlineCode",{parentName:"p"},"ephemeralForTest")," is not present anymore."),(0,o.yg)("p",{parentName:"admonition"},"With mongodb-memory-server 9.0.0, if mongodb 7.0.0 or higher is used, ",(0,o.yg)("inlineCode",{parentName:"p"},"wiredTiger")," is the default engine.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d5016940.366a2e06.js b/assets/js/d5016940.b55e0830.js similarity index 59% rename from assets/js/d5016940.366a2e06.js rename to assets/js/d5016940.b55e0830.js index c77b567e6..152d6856f 100644 --- a/assets/js/d5016940.366a2e06.js +++ b/assets/js/d5016940.b55e0830.js @@ -1 +1 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[416],{3905:function(e,n,t){t.d(n,{Zo:function(){return m},kt:function(){return g}});var o=t(7294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,o)}return t}function s(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var c=o.createContext({}),l=function(e){var n=o.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):s(s({},n),e)),t},m=function(e){var n=l(e.components);return o.createElement(c.Provider,{value:n},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},d=o.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),p=l(t),d=r,g=p["".concat(c,".").concat(d)]||p[d]||u[d]||a;return t?o.createElement(g,s(s({ref:n},m),{},{components:t})):o.createElement(g,s({ref:n},m))}));function g(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,s=new Array(a);s[0]=d;var i={};for(var c in n)hasOwnProperty.call(n,c)&&(i[c]=n[c]);i.originalType=e,i[p]="string"==typeof e?e:r,s[1]=i;for(var l=2;l/test/globalSetup.ts",\n "globalTeardown": "/test/globalTeardown.ts",\n "setupFilesAfterEnv": [\n "/test/setupFile.ts"\n ]\n}\n\n')),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"globalSetup.ts"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { MongoMemoryServer } from 'mongodb-memory-server';\nimport * as mongoose from 'mongoose';\nimport { config } from './utils/config';\n\nexport = async function globalSetup() {\n if (config.Memory) { // Config to decide if an mongodb-memory-server instance should be used\n // it's needed in global space, because we don't want to create a new instance every test-suite\n const instance = await MongoMemoryServer.create();\n const uri = instance.getUri();\n (global as any).__MONGOINSTANCE = instance;\n process.env.MONGO_URI = uri.slice(0, uri.lastIndexOf('/'));\n } else {\n process.env.MONGO_URI = `mongodb://${config.IP}:${config.Port}`;\n }\n\n // The following is to make sure the database is clean before a test suite starts\n const conn = await mongoose.connect(`${process.env.MONGO_URI}/${config.Database}`);\n await conn.connection.db.dropDatabase();\n await mongoose.disconnect();\n};\n\n")),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"globalTeardown.ts"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { MongoMemoryServer } from 'mongodb-memory-server';\nimport { config } from './utils/config';\n\nexport = async function globalTeardown() {\n if (config.Memory) { // Config to decide if an mongodb-memory-server instance should be used\n const instance: MongoMemoryServer = (global as any).__MONGOINSTANCE;\n await instance.stop();\n }\n};\n")),(0,a.kt)("p",null,"and an ",(0,a.kt)("a",{parentName:"p",href:"https://jestjs.io/docs/en/configuration#setupfilesafterenv-array"},(0,a.kt)("inlineCode",{parentName:"a"},"setupFilesAfterEnv"))," can be used to connect something like ",(0,a.kt)("inlineCode",{parentName:"p"},"mongoose")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"mongodb")),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"setupFile.ts"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"beforeAll(async () => {\n // put your client connection code here, example with mongoose:\n await mongoose.connect(process.env['MONGO_URI']);\n});\n\nafterAll(async () => {\n // put your client disconnection code here, example with mongoose:\n await mongoose.disconnect();\n});\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"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.",(0,a.kt)("br",{parentName:"p"}),"\n","Use either ",(0,a.kt)("a",{parentName:"p",href:"https://jestjs.io/docs/configuration#maxworkers-number--string"},(0,a.kt)("inlineCode",{parentName:"a"},"--maxWorkers 4"))," or ",(0,a.kt)("a",{parentName:"p",href:"https://jestjs.io/docs/cli#--runinband"},(0,a.kt)("inlineCode",{parentName:"a"},"--runInBand"))," to limit the workers.")),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"Keep in mind that jest's global-setup and global-teardown do ",(0,a.kt)("strong",{parentName:"p"},"not")," share a environment with the tests themself, and so require ",(0,a.kt)("inlineCode",{parentName:"p"},"setupFile")," / ",(0,a.kt)("inlineCode",{parentName:"p"},"setupFilesAfterEnv")," to actually connect.")),(0,a.kt)("h2",{id:"mocha--chai"},"mocha / chai"),(0,a.kt)("span",{class:"badge badge--secondary"},"mocha version (unknown)"),(0,a.kt)("p",null,"Start Mocha with ",(0,a.kt)("inlineCode",{parentName:"p"},"--timeout 60000")," cause first download of MongoDB binaries may take a time."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import mongoose from 'mongoose';\nimport { MongoMemoryServer } from 'mongodb-memory-server';\n\nlet mongoServer;\n\nbefore(async () => {\n mongoServer = await MongoMemoryServer.create();\n const mongoUri = mongoServer.getUri();\n await mongoose.connect(mongoUri);\n});\n\nafter(async () => {\n await mongoose.disconnect();\n await mongoServer.stop();\n});\n\ndescribe('...', () => {\n it('...', async () => {\n const User = mongoose.model('User', new mongoose.Schema({ name: String }));\n const cnt = await User.countDocuments();\n expect(cnt).to.equal(0);\n });\n});\n")),(0,a.kt)("h2",{id:"ava-test-runner"},"AVA test runner"),(0,a.kt)("p",null,"For AVA there is a ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/zellwk/ava/blob/8b7ccba1d80258b272ae7cae6ba4967cd1c13030/docs/recipes/endpoint-testing-with-mongoose.md"},"detailed written tutorial")," on how to test mongoose models with mongodb-memory-server by ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/zellwk"},"@zellwk"),"."),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"Note that this tutorial is pre mongodb-memory-server 7.x.")))}g.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[260],{5680:function(e,n,t){t.d(n,{xA:function(){return m},yg:function(){return d}});var o=t(6540);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,o)}return t}function s(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var c=o.createContext({}),l=function(e){var n=o.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):s(s({},n),e)),t},m=function(e){var n=l(e.components);return o.createElement(c.Provider,{value:n},e.children)},g="mdxType",p={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},u=o.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),g=l(t),u=r,d=g["".concat(c,".").concat(u)]||g[u]||p[u]||a;return t?o.createElement(d,s(s({ref:n},m),{},{components:t})):o.createElement(d,s({ref:n},m))}));function d(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,s=new Array(a);s[0]=u;var i={};for(var c in n)hasOwnProperty.call(n,c)&&(i[c]=n[c]);i.originalType=e,i[g]="string"==typeof e?e:r,s[1]=i;for(var l=2;l/test/globalSetup.ts",\n "globalTeardown": "/test/globalTeardown.ts",\n "setupFilesAfterEnv": [\n "/test/setupFile.ts"\n ]\n}\n\n')),(0,a.yg)("p",null,(0,a.yg)("inlineCode",{parentName:"p"},"globalSetup.ts"),":"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-ts"},"import { MongoMemoryServer } from 'mongodb-memory-server';\nimport * as mongoose from 'mongoose';\nimport { config } from './utils/config';\n\nexport = async function globalSetup() {\n if (config.Memory) { // Config to decide if an mongodb-memory-server instance should be used\n // it's needed in global space, because we don't want to create a new instance every test-suite\n const instance = await MongoMemoryServer.create();\n const uri = instance.getUri();\n (global as any).__MONGOINSTANCE = instance;\n process.env.MONGO_URI = uri.slice(0, uri.lastIndexOf('/'));\n } else {\n process.env.MONGO_URI = `mongodb://${config.IP}:${config.Port}`;\n }\n\n // The following is to make sure the database is clean before a test suite starts\n const conn = await mongoose.connect(`${process.env.MONGO_URI}/${config.Database}`);\n await conn.connection.db.dropDatabase();\n await mongoose.disconnect();\n};\n\n")),(0,a.yg)("p",null,(0,a.yg)("inlineCode",{parentName:"p"},"globalTeardown.ts"),":"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-ts"},"import { MongoMemoryServer } from 'mongodb-memory-server';\nimport { config } from './utils/config';\n\nexport = async function globalTeardown() {\n if (config.Memory) { // Config to decide if an mongodb-memory-server instance should be used\n const instance: MongoMemoryServer = (global as any).__MONGOINSTANCE;\n await instance.stop();\n }\n};\n")),(0,a.yg)("p",null,"and an ",(0,a.yg)("a",{parentName:"p",href:"https://jestjs.io/docs/en/configuration#setupfilesafterenv-array"},(0,a.yg)("inlineCode",{parentName:"a"},"setupFilesAfterEnv"))," can be used to connect something like ",(0,a.yg)("inlineCode",{parentName:"p"},"mongoose")," or ",(0,a.yg)("inlineCode",{parentName:"p"},"mongodb")),(0,a.yg)("p",null,(0,a.yg)("inlineCode",{parentName:"p"},"setupFile.ts"),":"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-ts"},"beforeAll(async () => {\n // put your client connection code here, example with mongoose:\n await mongoose.connect(process.env['MONGO_URI']);\n});\n\nafterAll(async () => {\n // put your client disconnection code here, example with mongoose:\n await mongoose.disconnect();\n});\n")),(0,a.yg)("admonition",{type:"caution"},(0,a.yg)("p",{parentName:"admonition"},"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.",(0,a.yg)("br",{parentName:"p"}),"\n","Use either ",(0,a.yg)("a",{parentName:"p",href:"https://jestjs.io/docs/configuration#maxworkers-number--string"},(0,a.yg)("inlineCode",{parentName:"a"},"--maxWorkers 4"))," or ",(0,a.yg)("a",{parentName:"p",href:"https://jestjs.io/docs/cli#--runinband"},(0,a.yg)("inlineCode",{parentName:"a"},"--runInBand"))," to limit the workers.")),(0,a.yg)("admonition",{type:"note"},(0,a.yg)("p",{parentName:"admonition"},"Keep in mind that jest's global-setup and global-teardown do ",(0,a.yg)("strong",{parentName:"p"},"not")," share a environment with the tests themself, and so require ",(0,a.yg)("inlineCode",{parentName:"p"},"setupFile")," / ",(0,a.yg)("inlineCode",{parentName:"p"},"setupFilesAfterEnv")," to actually connect.")),(0,a.yg)("h2",{id:"mocha--chai"},"mocha / chai"),(0,a.yg)("span",{class:"badge badge--secondary"},"mocha version (unknown)"),(0,a.yg)("p",null,"Start Mocha with ",(0,a.yg)("inlineCode",{parentName:"p"},"--timeout 60000")," cause first download of MongoDB binaries may take a time."),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-ts"},"import mongoose from 'mongoose';\nimport { MongoMemoryServer } from 'mongodb-memory-server';\n\nlet mongoServer;\n\nbefore(async () => {\n mongoServer = await MongoMemoryServer.create();\n const mongoUri = mongoServer.getUri();\n await mongoose.connect(mongoUri);\n});\n\nafter(async () => {\n await mongoose.disconnect();\n await mongoServer.stop();\n});\n\ndescribe('...', () => {\n it('...', async () => {\n const User = mongoose.model('User', new mongoose.Schema({ name: String }));\n const cnt = await User.countDocuments();\n expect(cnt).to.equal(0);\n });\n});\n")),(0,a.yg)("h2",{id:"ava-test-runner"},"AVA test runner"),(0,a.yg)("p",null,"For AVA there is a ",(0,a.yg)("a",{parentName:"p",href:"https://github.com/zellwk/ava/blob/8b7ccba1d80258b272ae7cae6ba4967cd1c13030/docs/recipes/endpoint-testing-with-mongoose.md"},"detailed written tutorial")," on how to test mongoose models with mongodb-memory-server by ",(0,a.yg)("a",{parentName:"p",href:"https://github.com/zellwk"},"@zellwk"),"."),(0,a.yg)("admonition",{type:"note"},(0,a.yg)("p",{parentName:"admonition"},"Note that this tutorial is pre mongodb-memory-server 7.x.")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/db74d20c.8910a6a5.js b/assets/js/db74d20c.8910a6a5.js deleted file mode 100644 index 7e2fcdad1..000000000 --- a/assets/js/db74d20c.8910a6a5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[176],{3905:function(e,t,n){n.d(t,{Zo:function(){return d},kt:function(){return k}});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(n),c=r,k=m["".concat(p,".").concat(c)]||m[c]||u[c]||i;return n?a.createElement(k,o(o({ref:t},d),{},{components:n})):a.createElement(k,o({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=c;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[m]="string"==typeof e?e:r,o[1]=l;for(var s=2;s = {})")),(0,i.kt)("p",null,"Create an new ReplSet without starting it"),(0,i.kt)("admonition",{type:"tip"},(0,i.kt)("p",{parentName:"admonition"},"When directly starting the replset, ",(0,i.kt)("a",{parentName:"p",href:"#create"},(0,i.kt)("inlineCode",{parentName:"a"},"create"))," should be used")),(0,i.kt)("h3",{id:"create"},"create"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"static async create(opts?: Partial): Promise")),(0,i.kt)("p",null,"Create an new ReplSet and start it (while being an Promise)"),(0,i.kt)("h3",{id:"statechange"},"stateChange"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected stateChange(newState: MongoMemoryReplSetStates, ...args: any[]): void")),(0,i.kt)("p",null,"Used to change the state of the class, uses ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/enums/mongo-memory-replset-states"},(0,i.kt)("inlineCode",{parentName:"a"},"MongoMemoryReplSetStates")," enum"),", it is ",(0,i.kt)("inlineCode",{parentName:"p"},"protected")," to not accidentally use it"),(0,i.kt)("h3",{id:"getinstanceopts"},"getInstanceOpts"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected getInstanceOpts(baseOpts: MongoMemoryInstancePropBase = {}): MongoMemoryInstanceProp")),(0,i.kt)("p",null,"Constructs the options used for an instance"),(0,i.kt)("h3",{id:"geturi"},"getUri"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"getUri(otherDb?: string): string")),(0,i.kt)("p",null,"Get an mongodb-usable uri (can also be used in mongoose)"),(0,i.kt)("p",null,"When no arguments are set, the URI will always use ip ",(0,i.kt)("inlineCode",{parentName:"p"},"127.0.0.1")," and end with ",(0,i.kt)("inlineCode",{parentName:"p"},"/?replicaSet=ReplSetName")," (not setting a database).",(0,i.kt)("br",{parentName:"p"}),"\n","When setting ",(0,i.kt)("inlineCode",{parentName:"p"},"otherDbName"),", the value of ",(0,i.kt)("inlineCode",{parentName:"p"},"otherDbName")," will be appended after ",(0,i.kt)("inlineCode",{parentName:"p"},"/")," and before any query arguments.",(0,i.kt)("br",{parentName:"p"}),"\n","When setting ",(0,i.kt)("inlineCode",{parentName:"p"},"otherIp"),", the ip will be the value of ",(0,i.kt)("inlineCode",{parentName:"p"},"otherIp")," instead of ",(0,i.kt)("inlineCode",{parentName:"p"},"127.0.0.1")," (for all instances)."),(0,i.kt)("h3",{id:"start"},"start"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"async start(): Promise")),(0,i.kt)("p",null,"Used to start an new ReplSet or to Re-Start an stopped ReplSet"),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Will Error if ReplSet is already running")),(0,i.kt)("h3",{id:"initallservers"},"initAllServers"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected async initAllServers(): Promise")),(0,i.kt)("p",null,"Used by ",(0,i.kt)("a",{parentName:"p",href:"#start"},(0,i.kt)("inlineCode",{parentName:"a"},"start"))," and to restart without fully running everything again"),(0,i.kt)("h3",{id:"ensurekeyfile"},"ensureKeyFile"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected async ensureKeyFile(): Promise")),(0,i.kt)("p",null,"Ensures and returns that ",(0,i.kt)("a",{parentName:"p",href:"#_keyfiletmp"},(0,i.kt)("inlineCode",{parentName:"a"},"_keyfiletmp"))," is defined an exists and also that the keyfile is created"),(0,i.kt)("h3",{id:"stop"},"stop"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"async stop(cleanupOptions?: Cleanup): Promise")),(0,i.kt)("p",null,"Stop an running instance, this function will by default call ",(0,i.kt)("a",{parentName:"p",href:"#cleanup"},(0,i.kt)("inlineCode",{parentName:"a"},".cleanup"))," with ",(0,i.kt)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }"),"."),(0,i.kt)("p",null,"With ",(0,i.kt)("inlineCode",{parentName:"p"},"cleanupOptions")," options for cleanup can be manually set."),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Will not Error if instance is not running")),(0,i.kt)("h3",{id:"cleanup"},"cleanup"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"async cleanup(options?: Cleanup): Promise")),(0,i.kt)("p",null,"Cleanup all files used by this ReplSet's instances, by default ",(0,i.kt)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }")," is used."),(0,i.kt)("p",null,"With ",(0,i.kt)("inlineCode",{parentName:"p"},"options")," can be set how to run a cleanup."),(0,i.kt)("h3",{id:"waituntilrunning"},"waitUntilRunning"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"async waitUntilRunning(): Promise")),(0,i.kt)("p",null,"Wait until all instances are running."),(0,i.kt)("p",null,"It is recommended to ",(0,i.kt)("inlineCode",{parentName:"p"},"await")," the promise returned from ",(0,i.kt)("inlineCode",{parentName:"p"},"start")," when available."),(0,i.kt)("p",null,"Does not start the replset instance if not already starting (unlike ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-server#ensureinstance"},(0,i.kt)("inlineCode",{parentName:"a"},"ensureInstance")),")."),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Will Error if state is not ",(0,i.kt)("inlineCode",{parentName:"p"},"running")," or ",(0,i.kt)("inlineCode",{parentName:"p"},"init"),".")),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Will ",(0,i.kt)("strong",{parentName:"p"},"not")," Error if a error is encountered while waiting.")),(0,i.kt)("h3",{id:"_initreplset"},"_initReplSet"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected async _initReplSet(): Promise")),(0,i.kt)("p",null,"This is used to connect to the first server and initiate the ReplSet with an command",(0,i.kt)("br",null),"\nAlso enables ",(0,i.kt)("inlineCode",{parentName:"p"},"auth")),(0,i.kt)("h3",{id:"_initserver"},"_initServer"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected _initServer(instanceOpts: MongoMemoryInstanceProp): MongoMemoryServer")),(0,i.kt)("p",null,"Creates an new ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-server"},(0,i.kt)("inlineCode",{parentName:"a"},"instance"))," for the ReplSet"),(0,i.kt)("h3",{id:"_waitforprimary"},"_waitForPrimary"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected async _waitForPrimary(timeout: number = 1000 * 30, where?: string): Promise")),(0,i.kt)("p",null,"Wait until the ReplSet has elected an Primary, the ",(0,i.kt)("inlineCode",{parentName:"p"},"where")," string will be added to the error if the timeout is reached"),(0,i.kt)("h2",{id:"values"},"Values"),(0,i.kt)("h3",{id:"servers"},"servers"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"servers: MongoMemoryServer[]")),(0,i.kt)("p",null,"Stores all the servers of this ReplSet"),(0,i.kt)("h3",{id:"instanceopts"},"instanceOpts"),(0,i.kt)("p",null,"Typings:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"get instanceOpts(): MongoMemoryInstancePropBase[]")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"set instanceOpts(val: MongoMemoryInstancePropBase[])"))),(0,i.kt)("p",null,"Getter & Setter for ",(0,i.kt)("a",{parentName:"p",href:"#_instanceopts"},(0,i.kt)("inlineCode",{parentName:"a"},"_instanceOpts"))),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Will Throw an Error if ",(0,i.kt)("inlineCode",{parentName:"p"},"state")," is not ",(0,i.kt)("inlineCode",{parentName:"p"},"stopped"))),(0,i.kt)("h3",{id:"_instanceopts"},"_instanceOpts"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected _instanceOpts!: MongoMemoryInstancePropBase[]")),(0,i.kt)("p",null,"Stores Options used for an instance"),(0,i.kt)("h3",{id:"binaryopts"},"binaryOpts"),(0,i.kt)("p",null,"Typings:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"get binaryOpts(): MongoBinaryOpts")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"set binaryOpts(val: MongoBinaryOpts)"))),(0,i.kt)("p",null,"Getter & Setter for ",(0,i.kt)("a",{parentName:"p",href:"#_binaryopts"},(0,i.kt)("inlineCode",{parentName:"a"},"_binaryOpts"))),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Will Throw an Error if ",(0,i.kt)("inlineCode",{parentName:"p"},"state")," is not ",(0,i.kt)("inlineCode",{parentName:"p"},"stopped"))),(0,i.kt)("h3",{id:"_binaryopts"},"_binaryOpts"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected _binaryOpts!: MongoBinaryOpts")),(0,i.kt)("p",null,"Stores the options used for the binary"),(0,i.kt)("h3",{id:"replsetopts"},"replSetOpts"),(0,i.kt)("p",null,"Typings:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"get replSetOpts(): ReplSetOpts")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"set replSetOpts(val: ReplSetOpts)"))),(0,i.kt)("p",null,"Getter & Setter for ",(0,i.kt)("a",{parentName:"p",href:"#_replsetopts"},(0,i.kt)("inlineCode",{parentName:"a"},"_replSetOpts"))),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Will Throw an Error if ",(0,i.kt)("inlineCode",{parentName:"p"},"state")," is not ",(0,i.kt)("inlineCode",{parentName:"p"},"stopped"))),(0,i.kt)("h3",{id:"_replsetopts"},"_replSetOpts"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected _replSetOpts!: Required")),(0,i.kt)("p",null,"Stores the options used for the ReplSet Initiation, uses ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/replset-opts"},(0,i.kt)("inlineCode",{parentName:"a"},"ReplSetOpts")),"."),(0,i.kt)("h3",{id:"_keyfiletmp"},"_keyfiletmp"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected _keyfiletmp?: string")),(0,i.kt)("p",null,"Stores the path of the created temporary directory for the keyfile location"),(0,i.kt)("h3",{id:"state"},"state"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"get state(): MongoMemoryReplSetStates")),(0,i.kt)("p",null,"Getter for ",(0,i.kt)("a",{parentName:"p",href:"#_state"},(0,i.kt)("inlineCode",{parentName:"a"},"_state"))),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Will Throw an Error if ",(0,i.kt)("inlineCode",{parentName:"p"},"state")," is not ",(0,i.kt)("inlineCode",{parentName:"p"},"stopped"))),(0,i.kt)("h3",{id:"_state"},"_state"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected _state: MongoMemoryReplSetStates")),(0,i.kt)("p",null,"Stores the current State, uses ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/enums/mongo-memory-replset-states"},(0,i.kt)("inlineCode",{parentName:"a"},"MongoMemoryReplSetStates")," enum"),"."),(0,i.kt)("h3",{id:"_rancreateauth"},"_ranCreateAuth"),(0,i.kt)("span",{class:"badge badge--warning"},"Internal"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"protected _ranCreateAuth: boolean")),(0,i.kt)("p",null,"Stores if the auth creation has already ran"))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/db74d20c.8a8e9f59.js b/assets/js/db74d20c.8a8e9f59.js new file mode 100644 index 000000000..fc2563fee --- /dev/null +++ b/assets/js/db74d20c.8a8e9f59.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[973],{5680:function(e,n,t){t.d(n,{xA:function(){return g},yg:function(){return u}});var a=t(6540);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function o(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var p=a.createContext({}),s=function(e){var n=a.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},g=function(e){var n=s(e.components);return a.createElement(p.Provider,{value:n},e.children)},y="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},m=a.forwardRef((function(e,n){var t=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,g=l(e,["components","mdxType","originalType","parentName"]),y=s(t),m=r,u=y["".concat(p,".").concat(m)]||y[m]||d[m]||i;return t?a.createElement(u,o(o({ref:n},g),{},{components:t})):a.createElement(u,o({ref:n},g))}));function u(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,o=new Array(i);o[0]=m;var l={};for(var p in n)hasOwnProperty.call(n,p)&&(l[p]=n[p]);l.originalType=e,l[y]="string"==typeof e?e:r,o[1]=l;for(var s=2;s = {})")),(0,i.yg)("p",null,"Create an new ReplSet without starting it"),(0,i.yg)("admonition",{type:"tip"},(0,i.yg)("p",{parentName:"admonition"},"When directly starting the replset, ",(0,i.yg)("a",{parentName:"p",href:"#create"},(0,i.yg)("inlineCode",{parentName:"a"},"create"))," should be used")),(0,i.yg)("h3",{id:"create"},"create"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"static async create(opts?: Partial): Promise")),(0,i.yg)("p",null,"Create an new ReplSet and start it (while being an Promise)"),(0,i.yg)("h3",{id:"statechange"},"stateChange"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected stateChange(newState: MongoMemoryReplSetStates, ...args: any[]): void")),(0,i.yg)("p",null,"Used to change the state of the class, uses ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/enums/mongo-memory-replset-states"},(0,i.yg)("inlineCode",{parentName:"a"},"MongoMemoryReplSetStates")," enum"),", it is ",(0,i.yg)("inlineCode",{parentName:"p"},"protected")," to not accidentally use it"),(0,i.yg)("h3",{id:"getinstanceopts"},"getInstanceOpts"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected getInstanceOpts(baseOpts: MongoMemoryInstancePropBase = {}): MongoMemoryInstanceProp")),(0,i.yg)("p",null,"Constructs the options used for an instance"),(0,i.yg)("h3",{id:"geturi"},"getUri"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"getUri(otherDb?: string): string")),(0,i.yg)("p",null,"Get an mongodb-usable uri (can also be used in mongoose)"),(0,i.yg)("p",null,"When no arguments are set, the URI will always use ip ",(0,i.yg)("inlineCode",{parentName:"p"},"127.0.0.1")," and end with ",(0,i.yg)("inlineCode",{parentName:"p"},"/?replicaSet=ReplSetName")," (not setting a database).",(0,i.yg)("br",{parentName:"p"}),"\n","When setting ",(0,i.yg)("inlineCode",{parentName:"p"},"otherDbName"),", the value of ",(0,i.yg)("inlineCode",{parentName:"p"},"otherDbName")," will be appended after ",(0,i.yg)("inlineCode",{parentName:"p"},"/")," and before any query arguments.",(0,i.yg)("br",{parentName:"p"}),"\n","When setting ",(0,i.yg)("inlineCode",{parentName:"p"},"otherIp"),", the ip will be the value of ",(0,i.yg)("inlineCode",{parentName:"p"},"otherIp")," instead of ",(0,i.yg)("inlineCode",{parentName:"p"},"127.0.0.1")," (for all instances)."),(0,i.yg)("h3",{id:"start"},"start"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"async start(): Promise")),(0,i.yg)("p",null,"Used to start an new ReplSet or to Re-Start an stopped ReplSet"),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Will Error if ReplSet is already running")),(0,i.yg)("h3",{id:"initallservers"},"initAllServers"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected async initAllServers(): Promise")),(0,i.yg)("p",null,"Used by ",(0,i.yg)("a",{parentName:"p",href:"#start"},(0,i.yg)("inlineCode",{parentName:"a"},"start"))," and to restart without fully running everything again"),(0,i.yg)("h3",{id:"ensurekeyfile"},"ensureKeyFile"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected async ensureKeyFile(): Promise")),(0,i.yg)("p",null,"Ensures and returns that ",(0,i.yg)("a",{parentName:"p",href:"#_keyfiletmp"},(0,i.yg)("inlineCode",{parentName:"a"},"_keyfiletmp"))," is defined an exists and also that the keyfile is created"),(0,i.yg)("h3",{id:"stop"},"stop"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"async stop(cleanupOptions?: Cleanup): Promise")),(0,i.yg)("p",null,"Stop an running instance, this function will by default call ",(0,i.yg)("a",{parentName:"p",href:"#cleanup"},(0,i.yg)("inlineCode",{parentName:"a"},".cleanup"))," with ",(0,i.yg)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }"),"."),(0,i.yg)("p",null,"With ",(0,i.yg)("inlineCode",{parentName:"p"},"cleanupOptions")," options for cleanup can be manually set."),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Will not Error if instance is not running")),(0,i.yg)("h3",{id:"cleanup"},"cleanup"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"async cleanup(options?: Cleanup): Promise")),(0,i.yg)("p",null,"Cleanup all files used by this ReplSet's instances, by default ",(0,i.yg)("inlineCode",{parentName:"p"},"{ doCleanup: true, force: false }")," is used."),(0,i.yg)("p",null,"With ",(0,i.yg)("inlineCode",{parentName:"p"},"options")," can be set how to run a cleanup."),(0,i.yg)("h3",{id:"waituntilrunning"},"waitUntilRunning"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"async waitUntilRunning(): Promise")),(0,i.yg)("p",null,"Wait until all instances are running."),(0,i.yg)("p",null,"It is recommended to ",(0,i.yg)("inlineCode",{parentName:"p"},"await")," the promise returned from ",(0,i.yg)("inlineCode",{parentName:"p"},"start")," when available."),(0,i.yg)("p",null,"Does not start the replset instance if not already starting (unlike ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-server#ensureinstance"},(0,i.yg)("inlineCode",{parentName:"a"},"ensureInstance")),")."),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Will Error if state is not ",(0,i.yg)("inlineCode",{parentName:"p"},"running")," or ",(0,i.yg)("inlineCode",{parentName:"p"},"init"),".")),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Will ",(0,i.yg)("strong",{parentName:"p"},"not")," Error if a error is encountered while waiting.")),(0,i.yg)("h3",{id:"_initreplset"},"_initReplSet"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected async _initReplSet(): Promise")),(0,i.yg)("p",null,"This is used to connect to the first server and initiate the ReplSet with an command",(0,i.yg)("br",null),"\nAlso enables ",(0,i.yg)("inlineCode",{parentName:"p"},"auth")),(0,i.yg)("h3",{id:"_initserver"},"_initServer"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected _initServer(instanceOpts: MongoMemoryInstanceProp): MongoMemoryServer")),(0,i.yg)("p",null,"Creates an new ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-server"},(0,i.yg)("inlineCode",{parentName:"a"},"instance"))," for the ReplSet"),(0,i.yg)("h3",{id:"_waitforprimary"},"_waitForPrimary"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected async _waitForPrimary(timeout: number = 1000 * 30, where?: string): Promise")),(0,i.yg)("p",null,"Wait until the ReplSet has elected an Primary, the ",(0,i.yg)("inlineCode",{parentName:"p"},"where")," string will be added to the error if the timeout is reached"),(0,i.yg)("h2",{id:"values"},"Values"),(0,i.yg)("h3",{id:"servers"},"servers"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"servers: MongoMemoryServer[]")),(0,i.yg)("p",null,"Stores all the servers of this ReplSet"),(0,i.yg)("h3",{id:"instanceopts"},"instanceOpts"),(0,i.yg)("p",null,"Typings:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"get instanceOpts(): MongoMemoryInstancePropBase[]")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"set instanceOpts(val: MongoMemoryInstancePropBase[])"))),(0,i.yg)("p",null,"Getter & Setter for ",(0,i.yg)("a",{parentName:"p",href:"#_instanceopts"},(0,i.yg)("inlineCode",{parentName:"a"},"_instanceOpts"))),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Will Throw an Error if ",(0,i.yg)("inlineCode",{parentName:"p"},"state")," is not ",(0,i.yg)("inlineCode",{parentName:"p"},"stopped"))),(0,i.yg)("h3",{id:"_instanceopts"},"_instanceOpts"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected _instanceOpts!: MongoMemoryInstancePropBase[]")),(0,i.yg)("p",null,"Stores Options used for an instance"),(0,i.yg)("h3",{id:"binaryopts"},"binaryOpts"),(0,i.yg)("p",null,"Typings:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"get binaryOpts(): MongoBinaryOpts")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"set binaryOpts(val: MongoBinaryOpts)"))),(0,i.yg)("p",null,"Getter & Setter for ",(0,i.yg)("a",{parentName:"p",href:"#_binaryopts"},(0,i.yg)("inlineCode",{parentName:"a"},"_binaryOpts"))),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Will Throw an Error if ",(0,i.yg)("inlineCode",{parentName:"p"},"state")," is not ",(0,i.yg)("inlineCode",{parentName:"p"},"stopped"))),(0,i.yg)("h3",{id:"_binaryopts"},"_binaryOpts"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected _binaryOpts!: MongoBinaryOpts")),(0,i.yg)("p",null,"Stores the options used for the binary"),(0,i.yg)("h3",{id:"replsetopts"},"replSetOpts"),(0,i.yg)("p",null,"Typings:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"get replSetOpts(): ReplSetOpts")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("inlineCode",{parentName:"li"},"set replSetOpts(val: ReplSetOpts)"))),(0,i.yg)("p",null,"Getter & Setter for ",(0,i.yg)("a",{parentName:"p",href:"#_replsetopts"},(0,i.yg)("inlineCode",{parentName:"a"},"_replSetOpts"))),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Will Throw an Error if ",(0,i.yg)("inlineCode",{parentName:"p"},"state")," is not ",(0,i.yg)("inlineCode",{parentName:"p"},"stopped"))),(0,i.yg)("h3",{id:"_replsetopts"},"_replSetOpts"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected _replSetOpts!: Required")),(0,i.yg)("p",null,"Stores the options used for the ReplSet Initiation, uses ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/interfaces/replset-opts"},(0,i.yg)("inlineCode",{parentName:"a"},"ReplSetOpts")),"."),(0,i.yg)("h3",{id:"_keyfiletmp"},"_keyfiletmp"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected _keyfiletmp?: string")),(0,i.yg)("p",null,"Stores the path of the created temporary directory for the keyfile location"),(0,i.yg)("h3",{id:"state"},"state"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"get state(): MongoMemoryReplSetStates")),(0,i.yg)("p",null,"Getter for ",(0,i.yg)("a",{parentName:"p",href:"#_state"},(0,i.yg)("inlineCode",{parentName:"a"},"_state"))),(0,i.yg)("admonition",{type:"caution"},(0,i.yg)("p",{parentName:"admonition"},"Will Throw an Error if ",(0,i.yg)("inlineCode",{parentName:"p"},"state")," is not ",(0,i.yg)("inlineCode",{parentName:"p"},"stopped"))),(0,i.yg)("h3",{id:"_state"},"_state"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected _state: MongoMemoryReplSetStates")),(0,i.yg)("p",null,"Stores the current State, uses ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/enums/mongo-memory-replset-states"},(0,i.yg)("inlineCode",{parentName:"a"},"MongoMemoryReplSetStates")," enum"),"."),(0,i.yg)("h3",{id:"_rancreateauth"},"_ranCreateAuth"),(0,i.yg)("span",{class:"badge badge--warning"},"Internal"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"protected _ranCreateAuth: boolean")),(0,i.yg)("p",null,"Stores if the auth creation has already ran"))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e3728ee4.8241cdc5.js b/assets/js/e3728ee4.8241cdc5.js deleted file mode 100644 index ee3f5ff91..000000000 --- a/assets/js/e3728ee4.8241cdc5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[60],{3905:function(e,t,n){n.d(t,{Zo:function(){return l},kt:function(){return f}});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var a=o.createContext({}),c=function(e){var t=o.useContext(a),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},l=function(e){var t=c(e.components);return o.createElement(a.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,a=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),m=c(n),d=r,f=m["".concat(a,".").concat(d)]||m[d]||u[d]||i;return n?o.createElement(f,s(s({ref:t},l),{},{components:n})):o.createElement(f,s({ref:t},l))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=d;var p={};for(var a in t)hasOwnProperty.call(t,a)&&(p[a]=t[a]);p.originalType=e,p[m]="string"==typeof e?e:r,s[1]=p;for(var c=2;cDisposeOptions",id:"values-for-disposeoptions",level:2},{value:"enabled",id:"enabled",level:3},{value:"cleanup",id:"cleanup",level:3}],u={toc:m},d="wrapper";function f(e){var t=e.components,n=(0,r.Z)(e,s);return(0,i.kt)(d,(0,o.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"API Documentation of ",(0,i.kt)("inlineCode",{parentName:"p"},"DisposeOptions"),"-Interface"),(0,i.kt)("h2",{id:"values-for-disposeoptions"},"Values for ",(0,i.kt)("inlineCode",{parentName:"h2"},"DisposeOptions")),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"enabled?: boolean")),(0,i.kt)("p",null,"Set whether to stop the manager on ",(0,i.kt)("inlineCode",{parentName:"p"},"[Symbol.asyncDispose]")," calls."),(0,i.kt)("h3",{id:"cleanup"},"cleanup"),(0,i.kt)("p",null,"Typings: ",(0,i.kt)("inlineCode",{parentName:"p"},"cleanup?: Cleanup")),(0,i.kt)("p",null,"Set custom cleanup options to be used for disposal, see ",(0,i.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-server#cleanup"},(0,i.kt)("inlineCode",{parentName:"a"},"cleanup")," function")," (the same options apply for the replset)."))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e3728ee4.884ec387.js b/assets/js/e3728ee4.884ec387.js new file mode 100644 index 000000000..cbcbef53b --- /dev/null +++ b/assets/js/e3728ee4.884ec387.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[426],{5680:function(e,n,t){t.d(n,{xA:function(){return l},yg:function(){return f}});var o=t(6540);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,o)}return t}function s(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var a=o.createContext({}),c=function(e){var n=o.useContext(a),t=n;return e&&(t="function"==typeof e?e(n):s(s({},n),e)),t},l=function(e){var n=c(e.components);return o.createElement(a.Provider,{value:n},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},d=o.forwardRef((function(e,n){var t=e.components,r=e.mdxType,i=e.originalType,a=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),m=c(t),d=r,f=m["".concat(a,".").concat(d)]||m[d]||u[d]||i;return t?o.createElement(f,s(s({ref:n},l),{},{components:t})):o.createElement(f,s({ref:n},l))}));function f(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,s=new Array(i);s[0]=d;var p={};for(var a in n)hasOwnProperty.call(n,a)&&(p[a]=n[a]);p.originalType=e,p[m]="string"==typeof e?e:r,s[1]=p;for(var c=2;cDisposeOptions",id:"values-for-disposeoptions",level:2},{value:"enabled",id:"enabled",level:3},{value:"cleanup",id:"cleanup",level:3}],u={toc:m},d="wrapper";function f(e){var n=e.components,t=(0,r.A)(e,s);return(0,i.yg)(d,(0,o.A)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,i.yg)("p",null,"API Documentation of ",(0,i.yg)("inlineCode",{parentName:"p"},"DisposeOptions"),"-Interface"),(0,i.yg)("h2",{id:"values-for-disposeoptions"},"Values for ",(0,i.yg)("inlineCode",{parentName:"h2"},"DisposeOptions")),(0,i.yg)("h3",{id:"enabled"},"enabled"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"enabled?: boolean")),(0,i.yg)("p",null,"Set whether to stop the manager on ",(0,i.yg)("inlineCode",{parentName:"p"},"[Symbol.asyncDispose]")," calls."),(0,i.yg)("h3",{id:"cleanup"},"cleanup"),(0,i.yg)("p",null,"Typings: ",(0,i.yg)("inlineCode",{parentName:"p"},"cleanup?: Cleanup")),(0,i.yg)("p",null,"Set custom cleanup options to be used for disposal, see ",(0,i.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/classes/mongo-memory-server#cleanup"},(0,i.yg)("inlineCode",{parentName:"a"},"cleanup")," function")," (the same options apply for the replset)."))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e9ab2b32.9d5cf28d.js b/assets/js/e9ab2b32.9d5cf28d.js deleted file mode 100644 index 34746d9c8..000000000 --- a/assets/js/e9ab2b32.9d5cf28d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[840],{1151:function(e,r,t){t.r(r);var s=t(7294),u=t(6550),n=t(4996);r.default=function(){return s.createElement(u.l_,{to:(0,n.Z)("docs/guides/quick-start-guide")})}}}]); \ No newline at end of file diff --git a/assets/js/e9ab2b32.e6fa4011.js b/assets/js/e9ab2b32.e6fa4011.js new file mode 100644 index 000000000..001110641 --- /dev/null +++ b/assets/js/e9ab2b32.e6fa4011.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[595],{4245:function(e,r,t){t.r(r);var s=t(6540),u=t(6347),n=t(6025);r.default=function(){return s.createElement(u.rd,{to:(0,n.A)("docs/guides/quick-start-guide")})}}}]); \ No newline at end of file diff --git a/assets/js/ea46b895.c7d5235c.js b/assets/js/ea46b895.c7d5235c.js new file mode 100644 index 000000000..8fc039c41 --- /dev/null +++ b/assets/js/ea46b895.c7d5235c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[691],{5680:function(e,n,t){t.d(n,{xA:function(){return p},yg:function(){return d}});var r=t(6540);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var c=r.createContext({}),l=function(e){var n=r.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(c.Provider,{value:n},e.children)},u="mdxType",y={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},m=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=l(t),m=o,d=u["".concat(c,".").concat(m)]||u[m]||y[m]||a;return t?r.createElement(d,i(i({ref:n},p),{},{components:t})):r.createElement(d,i({ref:n},p))}));function d(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=m;var s={};for(var c in n)hasOwnProperty.call(n,c)&&(s[c]=n[c]);s.originalType=e,s[u]="string"==typeof e?e:o,i[1]=s;for(var l=2;l): Promise")),(0,a.yg)("p",null,"Try to find the binary and if not found download the binary."),(0,a.yg)("h3",{id:"getpath"},"getPath"),(0,a.yg)("p",null,"Typings: ",(0,a.yg)("inlineCode",{parentName:"p"},"static async getPath(opts: MongoBinaryOpts = {}): Promise")),(0,a.yg)("p",null,"Get a working binary and returns the path to it.",(0,a.yg)("br",{parentName:"p"}),"\n","(Calls ",(0,a.yg)("a",{parentName:"p",href:"#download"},(0,a.yg)("inlineCode",{parentName:"a"},"download"))," if ",(0,a.yg)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#runtime_download"},(0,a.yg)("inlineCode",{parentName:"a"},"RUNTIME_DOWNLOAD"))," is ",(0,a.yg)("inlineCode",{parentName:"p"},"true"),")"))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ea46b895.f3896ddf.js b/assets/js/ea46b895.f3896ddf.js deleted file mode 100644 index b4577528d..000000000 --- a/assets/js/ea46b895.f3896ddf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[248],{3905:function(e,n,t){t.d(n,{Zo:function(){return p},kt:function(){return y}});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var c=r.createContext({}),l=function(e){var n=r.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(c.Provider,{value:n},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=l(t),d=o,y=u["".concat(c,".").concat(d)]||u[d]||m[d]||a;return t?r.createElement(y,i(i({ref:n},p),{},{components:t})):r.createElement(y,i({ref:n},p))}));function y(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=d;var s={};for(var c in n)hasOwnProperty.call(n,c)&&(s[c]=n[c]);s.originalType=e,s[u]="string"==typeof e?e:o,i[1]=s;for(var l=2;l): Promise")),(0,a.kt)("p",null,"Try to find the binary and if not found download the binary."),(0,a.kt)("h3",{id:"getpath"},"getPath"),(0,a.kt)("p",null,"Typings: ",(0,a.kt)("inlineCode",{parentName:"p"},"static async getPath(opts: MongoBinaryOpts = {}): Promise")),(0,a.kt)("p",null,"Get a working binary and returns the path to it.",(0,a.kt)("br",{parentName:"p"}),"\n","(Calls ",(0,a.kt)("a",{parentName:"p",href:"#download"},(0,a.kt)("inlineCode",{parentName:"a"},"download"))," if ",(0,a.kt)("a",{parentName:"p",href:"/mongodb-memory-server/docs/api/config-options#runtime_download"},(0,a.kt)("inlineCode",{parentName:"a"},"RUNTIME_DOWNLOAD"))," is ",(0,a.kt)("inlineCode",{parentName:"p"},"true"),")"))}y.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f9ecf5d9.d6473097.js b/assets/js/f9ecf5d9.d6473097.js new file mode 100644 index 000000000..0ec7a5ea5 --- /dev/null +++ b/assets/js/f9ecf5d9.d6473097.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmongodb_memory_server_website=self.webpackChunkmongodb_memory_server_website||[]).push([[814],{5680:function(e,n,r){r.d(n,{xA:function(){return l},yg:function(){return g}});var t=r(6540);function o(e,n,r){return n in e?Object.defineProperty(e,n,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[n]=r,e}function a(e,n){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),r.push.apply(r,t)}return r}function i(e){for(var n=1;n=0||(o[r]=e[r]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var p=t.createContext({}),m=function(e){var n=t.useContext(p),r=n;return e&&(r="function"==typeof e?e(n):i(i({},n),e)),r},l=function(e){var n=m(e.components);return t.createElement(p.Provider,{value:n},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},y=t.forwardRef((function(e,n){var r=e.components,o=e.mdxType,a=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),c=m(r),y=o,g=c["".concat(p,".").concat(y)]||c[y]||u[y]||a;return r?t.createElement(g,i(i({ref:n},l),{},{components:r})):t.createElement(g,i({ref:n},l))}));function g(e,n){var r=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=y;var s={};for(var p in n)hasOwnProperty.call(n,p)&&(s[p]=n[p]);s.originalType=e,s[c]="string"==typeof e?e:o,i[1]=s;for(var m=2;m=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),m=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=m(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),c=m(n),d=o,y=c["".concat(p,".").concat(d)]||c[d]||u[d]||a;return n?r.createElement(y,i(i({ref:t},l),{},{components:n})):r.createElement(y,i({ref:t},l))}));function y(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[c]="string"==typeof e?e:o,i[1]=s;for(var m=2;m=0||(i[a]=e[a]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var l=t.createContext({}),p=function(e){var n=t.useContext(l),a=n;return e&&(a="function"==typeof e?e(n):o(o({},n),e)),a},d=function(e){var n=p(e.components);return t.createElement(l.Provider,{value:n},e.children)},u="mdxType",g={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},y=t.forwardRef((function(e,n){var a=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=p(a),y=i,m=u["".concat(l,".").concat(y)]||u[y]||g[y]||r;return a?t.createElement(m,o(o({ref:n},d),{},{components:a})):t.createElement(m,o({ref:n},d))}));function m(e,n){var a=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=a.length,o=new Array(r);o[0]=y;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var p=2;p=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=a.createContext({}),p=function(e){var n=a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},d=function(e){var n=p(e.components);return a.createElement(l.Provider,{value:n},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},b=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=p(t),b=i,k=u["".concat(l,".").concat(b)]||u[b]||m[b]||r;return t?a.createElement(k,o(o({ref:n},d),{},{components:t})):a.createElement(k,o({ref:n},d))}));function k(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,o=new Array(r);o[0]=b;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var p=2;p1?t-1:0),r=1;r\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = '+e+" "+("/"===e?" (default value)":"")+'

\n

We suggest trying baseUrl =

\n\n'}(e)).replace(/0)&&(j.current.unobserve(e),j.current.disconnect(),null!=I&&window.docusaurus.prefetch(I))}))})),j.current.observe(e))},to:I},g&&{isActive:y,activeClassName:b}))}var g=a.forwardRef(m)},1875:function(e,t){"use strict";t.Z=function(){return null}},5999:function(e,t,n){"use strict";n.d(t,{Z:function(){return s},I:function(){return l}});var r=n(7294);function o(e,t){var n=e.split(/(\{\w+\})/).map((function(e,n){if(n%2==1){var r=null==t?void 0:t[e.slice(1,-1)];if(void 0!==r)return r}return e}));return n.some((function(e){return(0,r.isValidElement)(e)}))?n.map((function(e,t){return(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e})).filter((function(e){return""!==e})):n.join("")}var a=n(7529);function i(e){var t,n,r=e.id,o=e.message;if(void 0===r&&void 0===o)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return null!=(t=null!=(n=a[null!=r?r:o])?n:o)?t:r}function l(e,t){return o(i({message:e.message,id:e.id}),t)}function s(e){var t=e.children,n=e.id,a=e.values;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");var l=i({message:t,id:n});return r.createElement(r.Fragment,null,o(l,a))}},9935:function(e,t,n){"use strict";n.d(t,{m:function(){return r}});var r="default"},3919:function(e,t,n){"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function o(e){return void 0!==e&&!r(e)}n.d(t,{Z:function(){return o},b:function(){return r}})},4996:function(e,t,n){"use strict";n.d(t,{C:function(){return i},Z:function(){return l}});var r=n(7294),o=n(2263),a=n(3919);function i(){var e=(0,o.Z)().siteConfig,t=e.baseUrl,n=e.url,i=(0,r.useCallback)((function(e,r){return function(e,t,n,r){var o=void 0===r?{}:r,i=o.forcePrependBaseUrl,l=void 0!==i&&i,s=o.absolute,u=void 0!==s&&s;if(!n||n.startsWith("#")||(0,a.b)(n))return n;if(l)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;var c=n.startsWith(t)?n:t+n.replace(/^\//,"");return u?e+c:c}(n,t,e,r)}),[n,t]);return{withBaseUrl:i}}function l(e,t){return void 0===t&&(t={}),(0,i().withBaseUrl)(e,t)}},2263:function(e,t,n){"use strict";n.d(t,{Z:function(){return a}});var r=n(7294),o=n(8940);function a(){return(0,r.useContext)(o._)}},2389:function(e,t,n){"use strict";n.d(t,{Z:function(){return a}});var r=n(7294),o=n(8934);function a(){return(0,r.useContext)(o._)}},9670:function(e,t,n){"use strict";n.d(t,{Z:function(){return o}});var r=function(e){return"object"==typeof e&&!!e&&Object.keys(e).length>0};function o(e){var t={};return function e(n,o){Object.entries(n).forEach((function(n){var a=n[0],i=n[1],l=o?o+"."+a:a;r(i)?e(i,l):t[l]=i}))}(e),t}},226:function(e,t,n){"use strict";n.d(t,{_:function(){return o},z:function(){return a}});var r=n(7294),o=r.createContext(null);function a(e){var t=e.children,n=e.value,a=r.useContext(o),i=(0,r.useMemo)((function(){return function(e){var t=e.parent,n=e.value;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}var r=Object.assign({},t.data,null==n?void 0:n.data);return{plugin:t.plugin,data:r}}({parent:a,value:n})}),[a,n]);return r.createElement(o.Provider,{value:i},t)}},143:function(e,t,n){"use strict";n.d(t,{Iw:function(){return g},gA:function(){return f},_r:function(){return c},Jo:function(){return h},zh:function(){return d},yW:function(){return m},gB:function(){return p}});var r=n(6550),o=n(2263),a=n(9935);function i(e,t){void 0===t&&(t={});var n=(0,o.Z)().globalData[e];if(!n&&t.failfast)throw new Error('Docusaurus plugin global data not found for "'+e+'" plugin.');return n}var l=function(e){return e.versions.find((function(e){return e.isLast}))};function s(e,t){var n,o,a=function(e,t){var n=l(e);return[].concat(e.versions.filter((function(e){return e!==n})),[n]).find((function(e){return!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})}))}(e,t),i=null==a?void 0:a.docs.find((function(e){return!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})}));return{activeVersion:a,activeDoc:i,alternateDocVersions:i?(n=i.id,o={},e.versions.forEach((function(e){e.docs.forEach((function(t){t.id===n&&(o[e.name]=t)}))})),o):{}}}var u={},c=function(){var e;return null!=(e=i("docusaurus-plugin-content-docs"))?e:u},d=function(e){return function(e,t,n){void 0===t&&(t=a.m),void 0===n&&(n={});var r=i(e),o=null==r?void 0:r[t];if(!o&&n.failfast)throw new Error('Docusaurus plugin global data not found for "'+e+'" plugin with id "'+t+'".');return o}("docusaurus-plugin-content-docs",e,{failfast:!0})};function f(e){return void 0===e&&(e={}),function(e,t,n){void 0===n&&(n={});var o=Object.entries(e).sort((function(e,t){return t[1].path.localeCompare(e[1].path)})).find((function(e){var n=e[1];return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),a=o?{pluginId:o[0],pluginData:o[1]}:void 0;if(!a&&n.failfast)throw new Error("Can't find active docs plugin for \""+t+'" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: '+Object.values(e).map((function(e){return e.path})).join(", "));return a}(c(),(0,r.TH)().pathname,e)}function p(e){return d(e).versions}function m(e){var t=d(e);return l(t)}function g(e){return s(d(e),(0,r.TH)().pathname)}function h(e){return function(e,t){var n=l(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(d(e),(0,r.TH)().pathname)}},8320:function(e,t,n){"use strict";n.r(t);var r=n(4865),o=n.n(r);o().configure({showSpinner:!1});var a={onRouteUpdate:function(e){var t=e.location,n=e.previousLocation;if(n&&t.pathname!==n.pathname){var r=window.setTimeout((function(){o().start()}),200);return function(){return window.clearTimeout(r)}}},onRouteDidUpdate:function(){o().done()}};t.default=a},3310:function(e,t,n){"use strict";n.r(t);var r,o,a=n(7410),i=n(6809);r=a.Z,o=i.default.themeConfig.prism.additionalLanguages,globalThis.Prism=r,o.forEach((function(e){n(6726)("./prism-"+e)})),delete globalThis.Prism},9471:function(e,t,n){"use strict";n.d(t,{Z:function(){return a}});var r=n(7294),o={iconExternalLink:"iconExternalLink_nPIU"};function a(e){var t=e.width,n=void 0===t?13.5:t,a=e.height,i=void 0===a?13.5:a;return r.createElement("svg",{width:n,height:i,"aria-hidden":"true",viewBox:"0 0 24 24",className:o.iconExternalLink},r.createElement("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"}))}},5163:function(e,t,n){"use strict";n.d(t,{Z:function(){return Yt}});var r=n(7294),o=n(6010),a=n(4763),i=n(1944),l=n(7462),s=n(6550),u=n(5999),c=n(5936),d="__docusaurus_skipToContent_fallback";function f(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function p(){var e=(0,r.useRef)(null),t=(0,s.k6)().action,n=(0,r.useCallback)((function(e){e.preventDefault();var t,n=null!=(t=document.querySelector("main:first-of-type"))?t:document.getElementById(d);n&&f(n)}),[]);return(0,c.S)((function(n){var r=n.location;e.current&&!r.hash&&"PUSH"===t&&f(e.current)})),{containerRef:e,onClick:n}}var m=(0,u.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function g(e){var t,n=null!=(t=e.children)?t:m,o=p(),a=o.containerRef,i=o.onClick;return r.createElement("div",{ref:a,role:"region","aria-label":m},r.createElement("a",(0,l.Z)({},e,{href:"#"+d,onClick:i}),n))}var h=n(5281),v=n(9727),b={skipToContent:"skipToContent_fXgn"};function y(){return r.createElement(g,{className:b.skipToContent})}var w=n(6668),k=n(9689),E=n(3366),S=["width","height","color","strokeWidth","className"];function x(e){var t=e.width,n=void 0===t?21:t,o=e.height,a=void 0===o?21:o,i=e.color,s=void 0===i?"currentColor":i,u=e.strokeWidth,c=void 0===u?1.2:u,d=(e.className,(0,E.Z)(e,S));return r.createElement("svg",(0,l.Z)({viewBox:"0 0 15 15",width:n,height:a},d),r.createElement("g",{stroke:s,strokeWidth:c},r.createElement("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})))}var _={closeButton:"closeButton_CVFx"};function C(e){return r.createElement("button",(0,l.Z)({type:"button","aria-label":(0,u.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"})},e,{className:(0,o.Z)("clean-btn close",_.closeButton,e.className)}),r.createElement(x,{width:14,height:14,strokeWidth:3.1}))}var T={content:"content_knG7"};function L(e){var t=(0,w.L)().announcementBar.content;return r.createElement("div",(0,l.Z)({},e,{className:(0,o.Z)(T.content,e.className),dangerouslySetInnerHTML:{__html:t}}))}var A={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function N(){var e=(0,w.L)().announcementBar,t=(0,k.nT)(),n=t.isActive,o=t.close;if(!n)return null;var a=e.backgroundColor,i=e.textColor,l=e.isCloseable;return r.createElement("div",{className:A.announcementBar,style:{backgroundColor:a,color:i},role:"banner"},l&&r.createElement("div",{className:A.announcementBarPlaceholder}),r.createElement(L,{className:A.announcementBarContent}),l&&r.createElement(C,{onClick:o,className:A.announcementBarClose}))}var O=n(3163),R=n(2466);var P=n(9688),I=n(3102),D=r.createContext(null);function M(e){var t,n,o,a,i,l,s,u=e.children,c=(t=(0,O.e)(),n=(0,I.HY)(),o=(0,r.useState)(!1),a=o[0],i=o[1],l=null!==n.component,s=(0,P.D9)(l),(0,r.useEffect)((function(){l&&!s&&i(!0)}),[l,s]),(0,r.useEffect)((function(){l?t.shown||i(!0):i(!1)}),[t.shown,l]),(0,r.useMemo)((function(){return[a,i]}),[a]));return r.createElement(D.Provider,{value:c},u)}function F(e){if(e.component){var t=e.component;return r.createElement(t,e.props)}}function j(){var e=(0,r.useContext)(D);if(!e)throw new P.i6("NavbarSecondaryMenuDisplayProvider");var t=e[0],n=e[1],o=(0,r.useCallback)((function(){return n(!1)}),[n]),a=(0,I.HY)();return(0,r.useMemo)((function(){return{shown:t,hide:o,content:F(a)}}),[o,a,t])}function B(e){var t=e.header,n=e.primaryMenu,a=e.secondaryMenu,i=j().shown;return r.createElement("div",{className:"navbar-sidebar"},t,r.createElement("div",{className:(0,o.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":i})},r.createElement("div",{className:"navbar-sidebar__item menu"},n),r.createElement("div",{className:"navbar-sidebar__item menu"},a)))}var z=n(2949),U=n(2389);function Z(e){return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"}))}function q(e){return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"}))}var $={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function H(e){var t=e.className,n=e.buttonClassName,a=e.value,i=e.onChange,l=(0,U.Z)(),s=(0,u.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===a?(0,u.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,u.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return r.createElement("div",{className:(0,o.Z)($.toggle,t)},r.createElement("button",{className:(0,o.Z)("clean-btn",$.toggleButton,!l&&$.toggleButtonDisabled,n),type:"button",onClick:function(){return i("dark"===a?"light":"dark")},disabled:!l,title:s,"aria-label":s,"aria-live":"polite"},r.createElement(Z,{className:(0,o.Z)($.toggleIcon,$.lightToggleIcon)}),r.createElement(q,{className:(0,o.Z)($.toggleIcon,$.darkToggleIcon)})))}var G=r.memo(H),V={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function W(e){var t=e.className,n=(0,w.L)().navbar.style,o=(0,w.L)().colorMode.disableSwitch,a=(0,z.I)(),i=a.colorMode,l=a.setColorMode;return o?null:r.createElement(G,{className:t,buttonClassName:"dark"===n?V.darkNavbarColorModeToggle:void 0,value:i,onChange:l})}var Y=n(1327);function K(){return r.createElement(Y.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){var e=(0,O.e)();return r.createElement("button",{type:"button","aria-label":(0,u.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:function(){return e.toggle()}},r.createElement(x,{color:"var(--ifm-color-emphasis-600)"}))}function X(){return r.createElement("div",{className:"navbar-sidebar__brand"},r.createElement(K,null),r.createElement(W,{className:"margin-right--md"}),r.createElement(Q,null))}var J=n(9960),ee=n(4996),te=n(3919);function ne(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var re=n(9471),oe=["activeBasePath","activeBaseRegex","to","href","label","html","isDropdownLink","prependBaseUrlToHref"];function ae(e){var t=e.activeBasePath,n=e.activeBaseRegex,o=e.to,a=e.href,i=e.label,s=e.html,u=e.isDropdownLink,c=e.prependBaseUrlToHref,d=(0,E.Z)(e,oe),f=(0,ee.Z)(o),p=(0,ee.Z)(t),m=(0,ee.Z)(a,{forcePrependBaseUrl:!0}),g=i&&a&&!(0,te.Z)(a),h=s?{dangerouslySetInnerHTML:{__html:s}}:{children:r.createElement(r.Fragment,null,i,g&&r.createElement(re.Z,u&&{width:12,height:12}))};return a?r.createElement(J.Z,(0,l.Z)({href:c?m:a},d,h)):r.createElement(J.Z,(0,l.Z)({to:f,isNavLink:!0},(t||n)&&{isActive:function(e,t){return n?ne(n,t.pathname):t.pathname.startsWith(p)}},d,h))}var ie=["className","isDropdownItem"],le=["className","isDropdownItem"],se=["mobile","position"];function ue(e){var t=e.className,n=e.isDropdownItem,a=void 0!==n&&n,i=(0,E.Z)(e,ie),s=r.createElement(ae,(0,l.Z)({className:(0,o.Z)(a?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:a},i));return a?r.createElement("li",null,s):s}function ce(e){var t=e.className,n=(e.isDropdownItem,(0,E.Z)(e,le));return r.createElement("li",{className:"menu__list-item"},r.createElement(ae,(0,l.Z)({className:(0,o.Z)("menu__link",t)},n)))}function de(e){var t,n=e.mobile,o=void 0!==n&&n,a=(e.position,(0,E.Z)(e,se)),i=o?ce:ue;return r.createElement(i,(0,l.Z)({},a,{activeClassName:null!=(t=a.activeClassName)?t:o?"menu__link--active":"navbar__link--active"}))}var fe=n(6043),pe=n(8596),me=n(2263);var ge=["items","position","className","onClick"],he=["items","className","position","onClick"],ve=["mobile"];function be(e,t){return e.some((function(e){return function(e,t){return!!(0,pe.Mg)(e.to,t)||!!ne(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)}))}function ye(e){var t,n=e.items,a=e.position,i=e.className,s=(e.onClick,(0,E.Z)(e,ge)),u=(0,r.useRef)(null),c=(0,r.useState)(!1),d=c[0],f=c[1];return(0,r.useEffect)((function(){var e=function(e){u.current&&!u.current.contains(e.target)&&f(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),function(){document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[u]),r.createElement("div",{ref:u,className:(0,o.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===a,"dropdown--show":d})},r.createElement(ae,(0,l.Z)({"aria-haspopup":"true","aria-expanded":d,role:"button",href:s.to?void 0:"#",className:(0,o.Z)("navbar__link",i)},s,{onClick:s.to?void 0:function(e){return e.preventDefault()},onKeyDown:function(e){"Enter"===e.key&&(e.preventDefault(),f(!d))}}),null!=(t=s.children)?t:s.label),r.createElement("ul",{className:"dropdown__menu"},n.map((function(e,t){return r.createElement(at,(0,l.Z)({isDropdownItem:!0,activeClassName:"dropdown__link--active"},e,{key:t}))}))))}function we(e){var t,n,a=e.items,i=e.className,u=(e.position,e.onClick),c=(0,E.Z)(e,he),d=(n=(0,me.Z)().siteConfig.baseUrl,(0,s.TH)().pathname.replace(n,"/")),f=be(a,d),p=(0,fe.u)({initialState:function(){return!f}}),m=p.collapsed,g=p.toggleCollapsed,h=p.setCollapsed;return(0,r.useEffect)((function(){f&&h(!f)}),[d,f,h]),r.createElement("li",{className:(0,o.Z)("menu__list-item",{"menu__list-item--collapsed":m})},r.createElement(ae,(0,l.Z)({role:"button",className:(0,o.Z)("menu__link menu__link--sublist menu__link--sublist-caret",i)},c,{onClick:function(e){e.preventDefault(),g()}}),null!=(t=c.children)?t:c.label),r.createElement(fe.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:m},a.map((function(e,t){return r.createElement(at,(0,l.Z)({mobile:!0,isDropdownItem:!0,onClick:u,activeClassName:"menu__link--active"},e,{key:t}))}))))}function ke(e){var t=e.mobile,n=void 0!==t&&t,o=(0,E.Z)(e,ve),a=n?we:ye;return r.createElement(a,o)}var Ee=n(4711),Se=["width","height"];function xe(e){var t=e.width,n=void 0===t?20:t,o=e.height,a=void 0===o?20:o,i=(0,E.Z)(e,Se);return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:n,height:a,"aria-hidden":!0},i),r.createElement("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"}))}var _e="iconLanguage_nlXk",Ce=["mobile","dropdownItemsBefore","dropdownItemsAfter"];var Te=n(1875),Le={searchBox:"searchBox_ZlJk"};function Ae(e){var t=e.children,n=e.className;return r.createElement("div",{className:(0,o.Z)(n,Le.searchBox)},t)}var Ne=n(143),Oe=n(3791),Re=["docId","label","docsPluginId"];var Pe=["sidebarId","label","docsPluginId"];var Ie=["label","to","docsPluginId"];var De=n(373),Me=["mobile","docsPluginId","dropdownActiveClassDisabled","dropdownItemsBefore","dropdownItemsAfter"],Fe=function(e){return e.docs.find((function(t){return t.id===e.mainDocId}))};var je={default:de,localeDropdown:function(e){var t=e.mobile,n=e.dropdownItemsBefore,o=e.dropdownItemsAfter,a=(0,E.Z)(e,Ce),i=(0,me.Z)().i18n,c=i.currentLocale,d=i.locales,f=i.localeConfigs,p=(0,Ee.l)(),m=(0,s.TH)(),g=m.search,h=m.hash,v=d.map((function(e){var n=""+("pathname://"+p.createUrl({locale:e,fullyQualified:!1}))+g+h;return{label:f[e].label,lang:f[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===c?t?"menu__link--active":"dropdown__link--active":""}})),b=[].concat(n,v,o),y=t?(0,u.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):f[c].label;return r.createElement(ke,(0,l.Z)({},a,{mobile:t,label:r.createElement(r.Fragment,null,r.createElement(xe,{className:_e}),y),items:b}))},search:function(e){var t=e.mobile,n=e.className;return t?null:r.createElement(Ae,{className:n},r.createElement(Te.Z,null))},dropdown:ke,html:function(e){var t=e.value,n=e.className,a=e.mobile,i=void 0!==a&&a,l=e.isDropdownItem,s=void 0!==l&&l,u=s?"li":"div";return r.createElement(u,{className:(0,o.Z)({navbar__item:!i&&!s,"menu__list-item":i},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){var t=e.docId,n=e.label,o=e.docsPluginId,a=(0,E.Z)(e,Re),i=(0,Ne.Iw)(o).activeDoc,s=(0,Oe.vY)(t,o);return null===s?null:r.createElement(de,(0,l.Z)({exact:!0},a,{isActive:function(){return(null==i?void 0:i.path)===s.path||!(null==i||!i.sidebar)&&i.sidebar===s.sidebar},label:null!=n?n:s.id,to:s.path}))},docSidebar:function(e){var t=e.sidebarId,n=e.label,o=e.docsPluginId,a=(0,E.Z)(e,Pe),i=(0,Ne.Iw)(o).activeDoc,s=(0,Oe.oz)(t,o).link;if(!s)throw new Error('DocSidebarNavbarItem: Sidebar with ID "'+t+"\" doesn't have anything to be linked to.");return r.createElement(de,(0,l.Z)({exact:!0},a,{isActive:function(){return(null==i?void 0:i.sidebar)===t},label:null!=n?n:s.label,to:s.path}))},docsVersion:function(e){var t=e.label,n=e.to,o=e.docsPluginId,a=(0,E.Z)(e,Ie),i=(0,Oe.lO)(o)[0],s=null!=t?t:i.label,u=null!=n?n:function(e){return e.docs.find((function(t){return t.id===e.mainDocId}))}(i).path;return r.createElement(de,(0,l.Z)({},a,{label:s,to:u}))},docsVersionDropdown:function(e){var t=e.mobile,n=e.docsPluginId,o=e.dropdownActiveClassDisabled,a=e.dropdownItemsBefore,i=e.dropdownItemsAfter,c=(0,E.Z)(e,Me),d=(0,s.TH)(),f=d.search,p=d.hash,m=(0,Ne.Iw)(n),g=(0,Ne.gB)(n),h=(0,De.J)(n).savePreferredVersionName,v=g.map((function(e){var t,n=null!=(t=m.alternateDocVersions[e.name])?t:Fe(e);return{label:e.label,to:""+n.path+f+p,isActive:function(){return e===m.activeVersion},onClick:function(){return h(e.name)}}})),b=[].concat(a,v,i),y=(0,Oe.lO)(n)[0],w=t&&b.length>1?(0,u.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):y.label,k=t&&b.length>1?void 0:Fe(y).path;return b.length<=1?r.createElement(de,(0,l.Z)({},c,{mobile:t,label:w,to:k,isActive:o?function(){return!1}:void 0})):r.createElement(ke,(0,l.Z)({},c,{mobile:t,label:w,to:k,items:b,isActive:o?function(){return!1}:void 0}))}},Be=n(1002);function ze(){ze=function(){return t};var e,t={},n=Object.prototype,r=n.hasOwnProperty,o=Object.defineProperty||function(e,t,n){e[t]=n.value},a="function"==typeof Symbol?Symbol:{},i=a.iterator||"@@iterator",l=a.asyncIterator||"@@asyncIterator",s=a.toStringTag||"@@toStringTag";function u(e,t,n){return Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}),e[t]}try{u({},"")}catch(e){u=function(e,t,n){return e[t]=n}}function c(e,t,n,r){var a=t&&t.prototype instanceof v?t:v,i=Object.create(a.prototype),l=new N(r||[]);return o(i,"_invoke",{value:C(e,n,l)}),i}function d(e,t,n){try{return{type:"normal",arg:e.call(t,n)}}catch(e){return{type:"throw",arg:e}}}t.wrap=c;var f="suspendedStart",p="suspendedYield",m="executing",g="completed",h={};function v(){}function b(){}function y(){}var w={};u(w,i,(function(){return this}));var k=Object.getPrototypeOf,E=k&&k(k(O([])));E&&E!==n&&r.call(E,i)&&(w=E);var S=y.prototype=v.prototype=Object.create(w);function x(e){["next","throw","return"].forEach((function(t){u(e,t,(function(e){return this._invoke(t,e)}))}))}function _(e,t){function n(o,a,i,l){var s=d(e[o],e,a);if("throw"!==s.type){var u=s.arg,c=u.value;return c&&"object"==(0,Be.Z)(c)&&r.call(c,"__await")?t.resolve(c.__await).then((function(e){n("next",e,i,l)}),(function(e){n("throw",e,i,l)})):t.resolve(c).then((function(e){u.value=e,i(u)}),(function(e){return n("throw",e,i,l)}))}l(s.arg)}var a;o(this,"_invoke",{value:function(e,r){function o(){return new t((function(t,o){n(e,r,t,o)}))}return a=a?a.then(o,o):o()}})}function C(t,n,r){var o=f;return function(a,i){if(o===m)throw new Error("Generator is already running");if(o===g){if("throw"===a)throw i;return{value:e,done:!0}}for(r.method=a,r.arg=i;;){var l=r.delegate;if(l){var s=T(l,r);if(s){if(s===h)continue;return s}}if("next"===r.method)r.sent=r._sent=r.arg;else if("throw"===r.method){if(o===f)throw o=g,r.arg;r.dispatchException(r.arg)}else"return"===r.method&&r.abrupt("return",r.arg);o=m;var u=d(t,n,r);if("normal"===u.type){if(o=r.done?g:p,u.arg===h)continue;return{value:u.arg,done:r.done}}"throw"===u.type&&(o=g,r.method="throw",r.arg=u.arg)}}}function T(t,n){var r=n.method,o=t.iterator[r];if(o===e)return n.delegate=null,"throw"===r&&t.iterator.return&&(n.method="return",n.arg=e,T(t,n),"throw"===n.method)||"return"!==r&&(n.method="throw",n.arg=new TypeError("The iterator does not provide a '"+r+"' method")),h;var a=d(o,t.iterator,n.arg);if("throw"===a.type)return n.method="throw",n.arg=a.arg,n.delegate=null,h;var i=a.arg;return i?i.done?(n[t.resultName]=i.value,n.next=t.nextLoc,"return"!==n.method&&(n.method="next",n.arg=e),n.delegate=null,h):i:(n.method="throw",n.arg=new TypeError("iterator result is not an object"),n.delegate=null,h)}function L(e){var t={tryLoc:e[0]};1 in e&&(t.catchLoc=e[1]),2 in e&&(t.finallyLoc=e[2],t.afterLoc=e[3]),this.tryEntries.push(t)}function A(e){var t=e.completion||{};t.type="normal",delete t.arg,e.completion=t}function N(e){this.tryEntries=[{tryLoc:"root"}],e.forEach(L,this),this.reset(!0)}function O(t){if(t||""===t){var n=t[i];if(n)return n.call(t);if("function"==typeof t.next)return t;if(!isNaN(t.length)){var o=-1,a=function n(){for(;++o=0;--a){var i=this.tryEntries[a],l=i.completion;if("root"===i.tryLoc)return o("end");if(i.tryLoc<=this.prev){var s=r.call(i,"catchLoc"),u=r.call(i,"finallyLoc");if(s&&u){if(this.prev=0;--n){var o=this.tryEntries[n];if(o.tryLoc<=this.prev&&r.call(o,"finallyLoc")&&this.prev=0;--t){var n=this.tryEntries[t];if(n.finallyLoc===e)return this.complete(n.completion,n.afterLoc),A(n),h}},catch:function(e){for(var t=this.tryEntries.length-1;t>=0;--t){var n=this.tryEntries[t];if(n.tryLoc===e){var r=n.completion;if("throw"===r.type){var o=r.arg;A(n)}return o}}throw new Error("illegal catch attempt")},delegateYield:function(t,n,r){return this.delegate={iterator:O(t),resultName:n,nextLoc:r},"next"===this.method&&(this.arg=e),h}},t}function Ue(e,t,n,r,o,a,i){try{var l=e[a](i),s=l.value}catch(u){return void n(u)}l.done?t(s):Promise.resolve(s).then(r,o)}function Ze(e){return function(){var t=this,n=arguments;return new Promise((function(r,o){var a=e.apply(t,n);function i(e){Ue(a,r,o,i,l,"next",e)}function l(e){Ue(a,r,o,i,l,"throw",e)}i(void 0)}))}}var qe=["position","className"],$e=["className","position"],He=["mobile"];function Ge(e,t){return"/mongodb-memory-server/"===t?t===e:e.startsWith(t)}function Ve(e){var t=(0,r.useState)([]),n=t[0],o=t[1];return(0,r.useEffect)(Ze(ze().mark((function t(){var n,r;return ze().wrap((function(t){for(;;)switch(t.prev=t.next){case 0:return n=e.label,t.next=3,fetch("/mongodb-memory-server/versions.json").then((function(e){return e.json()})).catch((function(e){var t;console.log("json fetch errored, using default",e);var r,o,a=!!(r=/^\/mongodb-memory-server\/versions\/(\d+\.x|beta)/.exec(window.location.pathname))&&""+r[1];return a?((o={latest:""})[n]=a,o):((t={})[n]="",t)}));case 3:r=t.sent,o(Object.entries(r).map((function(e){return[e[0],"/mongodb-memory-server/"+e[1]]})));case 5:case"end":return t.stop()}}),t)}))),[]),n}function We(e){var t=e.position,n=e.className,a=(0,E.Z)(e,qe),i=(0,r.useRef)(null),u=(0,r.useState)(!1),c=u[0],d=u[1];(0,r.useEffect)((function(){var e=function(e){i.current&&!i.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),function(){document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[i]);var f=Ve(a),p=(0,s.TH)().pathname;return r.createElement("div",{ref:i,id:"versions_dropdown",className:(0,o.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===t,"dropdown--show":c})},r.createElement(ae,(0,l.Z)({"aria-haspopup":"true","aria-expanded":c,role:"button",href:"#",className:(0,o.Z)("navbar__link",n)},a,{onClick:a.to?void 0:function(e){return e.preventDefault()},onKeyDown:function(e){"Enter"===e.key&&(e.preventDefault(),d(!c))}}),a.label),r.createElement("ul",{className:"dropdown__menu"},f.map((function(e,t){var a=e[0],i=e[1];return r.createElement("li",{key:t},r.createElement("a",{href:i,className:(0,o.Z)(Ge(p,i)?"dropdown__link--active":"","dropdown__link",n)},a))}))))}function Ye(e){var t=e.className,n=(e.position,(0,E.Z)(e,$e)),a=Ve(n),i=(0,fe.u)({initialState:!0}),u=i.collapsed,c=i.toggleCollapsed,d=(0,s.TH)().pathname;return r.createElement("li",{className:(0,o.Z)("menu__list-item",{"menu__list-item--collapsed":u})},r.createElement(ae,(0,l.Z)({role:"button",className:(0,o.Z)("menu__link menu__link--sublist menu__link--sublist-caret",t)},n,{label:"Versions",onClick:function(e){e.preventDefault(),c()}}),"Versions"),r.createElement(fe.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:u},a.map((function(e,n){var a=e[0],i=e[1];return r.createElement("li",{className:"menu__list-item",key:n},r.createElement("a",{href:i,className:(0,o.Z)(Ge(d,i)?"menu__link--active":"","menu__link",t)},a))}))))}function Ke(e){var t=e.children,n=e.fallback;return(0,U.Z)()?r.createElement(r.Fragment,null,null==t?void 0:t()):null!=n?n:null}var Qe=["position","className"],Xe=["className","position"],Je=["mobile"];function et(){var e=function(){var e=/^\/mongodb-memory-server\/versions\/(\d+\.x|beta)/.exec(window.location.pathname);return!!e&&""+e[1]}();return!!e&&("beta"===e&&"Beta Version may not always be up-to-date")}function tt(e){e.position;var t=e.className,n=(0,E.Z)(e,Qe),a=et();return a?r.createElement("div",{id:"test",className:(0,o.Z)("navbar__item",{})},r.createElement(ae,(0,l.Z)({role:"button",className:(0,o.Z)("navbar__link",t)},n,{label:a,onClick:n.to?void 0:function(e){return e.preventDefault()},onKeyDown:function(e){"Enter"===e.key&&e.preventDefault()}}),a)):null}function nt(e){var t=e.className,n=(e.position,(0,E.Z)(e,Xe)),a=et();return a?r.createElement("li",{className:(0,o.Z)("menu__list-item",{})},r.createElement(ae,(0,l.Z)({role:"button",className:(0,o.Z)("menu__link",t)},n,{label:a,onClick:function(e){e.preventDefault()}}),a)):null}var rt=Object.assign({},je,{"custom-versions-selector":function(e){var t=e.mobile,n=void 0!==t&&t,o=(0,E.Z)(e,He),a=n?Ye:We;return r.createElement(a,o)},"custom-beta-notice":function(e){var t=e.mobile,n=void 0!==t&&t,o=(0,E.Z)(e,Je),a=n?nt:tt;return r.createElement(Ke,null,(function(){return r.createElement(a,o)}))}}),ot=["type"];function at(e){var t=e.type,n=(0,E.Z)(e,ot),o=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),a=rt[o];if(!a)throw new Error('No NavbarItem component found for type "'+t+'".');return r.createElement(a,n)}function it(){var e=(0,O.e)(),t=(0,w.L)().navbar.items;return r.createElement("ul",{className:"menu__list"},t.map((function(t,n){return r.createElement(at,(0,l.Z)({mobile:!0},t,{onClick:function(){return e.toggle()},key:n}))})))}function lt(e){return r.createElement("button",(0,l.Z)({},e,{type:"button",className:"clean-btn navbar-sidebar__back"}),r.createElement(u.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"},"\u2190 Back to main menu"))}function st(){var e=0===(0,w.L)().navbar.items.length,t=j();return r.createElement(r.Fragment,null,!e&&r.createElement(lt,{onClick:function(){return t.hide()}}),t.content)}function ut(){var e,t=(0,O.e)();return void 0===(e=t.shown)&&(e=!0),(0,r.useEffect)((function(){return document.body.style.overflow=e?"hidden":"visible",function(){document.body.style.overflow="visible"}}),[e]),t.shouldRender?r.createElement(B,{header:r.createElement(X,null),primaryMenu:r.createElement(it,null),secondaryMenu:r.createElement(st,null)}):null}var ct={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function dt(e){return r.createElement("div",(0,l.Z)({role:"presentation"},e,{className:(0,o.Z)("navbar-sidebar__backdrop",e.className)}))}function ft(e){var t=e.children,n=(0,w.L)().navbar,a=n.hideOnScroll,i=n.style,l=(0,O.e)(),s=function(e){var t=(0,r.useState)(e),n=t[0],o=t[1],a=(0,r.useRef)(!1),i=(0,r.useRef)(0),l=(0,r.useCallback)((function(e){null!==e&&(i.current=e.getBoundingClientRect().height)}),[]);return(0,R.RF)((function(t,n){var r=t.scrollY;if(e)if(r=l?o(!1):r+u0&&r.createElement(Mt,{links:n}),logo:o&&r.createElement(zt,{logo:o}),copyright:t&&r.createElement(Ut,{copyright:t})})}var $t=r.memo(qt),Ht=(0,P.Qc)([z.S,k.pl,R.OC,De.L5,i.VC,function(e){var t=e.children;return r.createElement(I.n2,null,r.createElement(O.M,null,r.createElement(M,null,t)))}]);function Gt(e){var t=e.children;return r.createElement(Ht,null,t)}function Vt(e){var t=e.error,n=e.tryAgain;return r.createElement("main",{className:"container margin-vert--xl"},r.createElement("div",{className:"row"},r.createElement("div",{className:"col col--6 col--offset-3"},r.createElement("h1",{className:"hero__title"},r.createElement(u.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed"},"This page crashed.")),r.createElement("div",{className:"margin-vert--lg"},r.createElement(ht,{onClick:n,className:"button button--primary shadow--lw"})),r.createElement("hr",null),r.createElement("div",{className:"margin-vert--md"},r.createElement(vt,{error:t})))))}var Wt={mainWrapper:"mainWrapper_z2l0"};function Yt(e){var t=e.children,n=e.noFooter,l=e.wrapperClassName,s=e.title,u=e.description;return(0,v.t)(),r.createElement(Gt,null,r.createElement(i.d,{title:s,description:u}),r.createElement(y,null),r.createElement(N,null),r.createElement(Tt,null),r.createElement("div",{id:d,className:(0,o.Z)(h.k.wrapper.main,Wt.mainWrapper,l)},r.createElement(a.Z,{fallback:function(e){return r.createElement(Vt,e)}},t)),!n&&r.createElement($t,null))}},1327:function(e,t,n){"use strict";n.d(t,{Z:function(){return p}});var r=n(7462),o=n(3366),a=n(7294),i=n(9960),l=n(4996),s=n(2263),u=n(6668),c=n(941),d=["imageClassName","titleClassName"];function f(e){var t=e.logo,n=e.alt,r=e.imageClassName,o={light:(0,l.Z)(t.src),dark:(0,l.Z)(t.srcDark||t.src)},i=a.createElement(c.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?a.createElement("div",{className:r},i):i}function p(e){var t,n=(0,s.Z)().siteConfig.title,c=(0,u.L)().navbar,p=c.title,m=c.logo,g=e.imageClassName,h=e.titleClassName,v=(0,o.Z)(e,d),b=(0,l.Z)((null==m?void 0:m.href)||"/"),y=p?"":n,w=null!=(t=null==m?void 0:m.alt)?t:y;return a.createElement(i.Z,(0,r.Z)({to:b},v,(null==m?void 0:m.target)&&{target:m.target}),m&&a.createElement(f,{logo:m,alt:w,imageClassName:g}),null!=p&&a.createElement("b",{className:h},p))}},941:function(e,t,n){"use strict";n.d(t,{Z:function(){return d}});var r=n(7462),o=n(3366),a=n(7294),i=n(6010),l=n(2389),s=n(2949),u={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"},c=["sources","className","alt"];function d(e){var t=(0,l.Z)(),n=(0,s.I)().colorMode,d=e.sources,f=e.className,p=e.alt,m=(0,o.Z)(e,c),g=t?"dark"===n?["dark"]:["light"]:["light","dark"];return a.createElement(a.Fragment,null,g.map((function(e){return a.createElement("img",(0,r.Z)({key:e,src:d[e],alt:p,className:(0,i.Z)(u.themedImage,u["themedImage--"+e],f)},m))})))}},6043:function(e,t,n){"use strict";n.d(t,{u:function(){return d},z:function(){return y}});var r=n(7462),o=n(3366),a=n(7294),i=n(412),l=n(1442),s=["collapsed"],u=["lazy"],c="ease-in-out";function d(e){var t=e.initialState,n=(0,a.useState)(null!=t&&t),r=n[0],o=n[1],i=(0,a.useCallback)((function(){o((function(e){return!e}))}),[]);return{collapsed:r,setCollapsed:o,toggleCollapsed:i}}var f={display:"none",overflow:"hidden",height:"0px"},p={display:"block",overflow:"visible",height:"auto"};function m(e,t){var n=t?f:p;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function g(e){var t=e.collapsibleRef,n=e.collapsed,r=e.animation,o=(0,a.useRef)(!1);(0,a.useEffect)((function(){var e,a=t.current;function i(){var e,t,n=a.scrollHeight,o=null!=(e=null==r?void 0:r.duration)?e:function(e){if((0,l.n)())return 1;var t=e/36;return Math.round(10*(4+15*Math.pow(t,.25)+t/5))}(n);return{transition:"height "+o+"ms "+(null!=(t=null==r?void 0:r.easing)?t:c),height:n+"px"}}function s(){var e=i();a.style.transition=e.transition,a.style.height=e.height}if(!o.current)return m(a,n),void(o.current=!0);return a.style.willChange="height",e=requestAnimationFrame((function(){n?(s(),requestAnimationFrame((function(){a.style.height=f.height,a.style.overflow=f.overflow}))):(a.style.display="block",requestAnimationFrame((function(){s()})))})),function(){return cancelAnimationFrame(e)}}),[t,n,r])}function h(e){if(!i.Z.canUseDOM)return e?f:p}function v(e){var t=e.as,n=void 0===t?"div":t,r=e.collapsed,o=e.children,i=e.animation,l=e.onCollapseTransitionEnd,s=e.className,u=e.disableSSRStyle,c=(0,a.useRef)(null);return g({collapsibleRef:c,collapsed:r,animation:i}),a.createElement(n,{ref:c,style:u?void 0:h(r),onTransitionEnd:function(e){"height"===e.propertyName&&(m(c.current,r),null==l||l(r))},className:s},o)}function b(e){var t=e.collapsed,n=(0,o.Z)(e,s),i=(0,a.useState)(!t),l=i[0],u=i[1],c=(0,a.useState)(t),d=c[0],f=c[1];return(0,a.useLayoutEffect)((function(){t||u(!0)}),[t]),(0,a.useLayoutEffect)((function(){l&&f(t)}),[l,t]),l?a.createElement(v,(0,r.Z)({},n,{collapsed:d})):null}function y(e){var t=e.lazy,n=(0,o.Z)(e,u),r=t?b:v;return a.createElement(r,n)}},9689:function(e,t,n){"use strict";n.d(t,{nT:function(){return m},pl:function(){return p}});var r=n(7294),o=n(2389),a=n(12),i=n(9688),l=n(6668),s=(0,a.WA)("docusaurus.announcement.dismiss"),u=(0,a.WA)("docusaurus.announcement.id"),c=function(){return"true"===s.get()},d=function(e){return s.set(String(e))},f=r.createContext(null);function p(e){var t=e.children,n=function(){var e=(0,l.L)().announcementBar,t=(0,o.Z)(),n=(0,r.useState)((function(){return!!t&&c()})),a=n[0],i=n[1];(0,r.useEffect)((function(){i(c())}),[]);var s=(0,r.useCallback)((function(){d(!0),i(!0)}),[]);return(0,r.useEffect)((function(){if(e){var t=e.id,n=u.get();"annoucement-bar"===n&&(n="announcement-bar");var r=t!==n;u.set(t),r&&d(!1),!r&&c()||i(!1)}}),[e]),(0,r.useMemo)((function(){return{isActive:!!e&&!a,close:s}}),[e,a,s])}();return r.createElement(f.Provider,{value:n},t)}function m(){var e=(0,r.useContext)(f);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},2949:function(e,t,n){"use strict";n.d(t,{I:function(){return h},S:function(){return g}});var r=n(7294),o=n(412),a=n(9688),i=n(12),l=n(6668),s=r.createContext(void 0),u="theme",c=(0,i.WA)(u),d={light:"light",dark:"dark"},f=function(e){return e===d.dark?d.dark:d.light},p=function(e){return o.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e)},m=function(e){c.set(f(e))};function g(e){var t=e.children,n=function(){var e=(0,l.L)().colorMode,t=e.defaultMode,n=e.disableSwitch,o=e.respectPrefersColorScheme,a=(0,r.useState)(p(t)),i=a[0],s=a[1];(0,r.useEffect)((function(){n&&c.del()}),[n]);var g=(0,r.useCallback)((function(e,n){void 0===n&&(n={});var r=n.persist,a=void 0===r||r;e?(s(e),a&&m(e)):(s(o?window.matchMedia("(prefers-color-scheme: dark)").matches?d.dark:d.light:t),c.del())}),[o,t]);(0,r.useEffect)((function(){document.documentElement.setAttribute("data-theme",f(i))}),[i]),(0,r.useEffect)((function(){if(!n){var e=function(e){if(e.key===u){var t=c.get();null!==t&&g(f(t))}};return window.addEventListener("storage",e),function(){return window.removeEventListener("storage",e)}}}),[n,g]);var h=(0,r.useRef)(!1);return(0,r.useEffect)((function(){if(!n||o){var e=window.matchMedia("(prefers-color-scheme: dark)"),t=function(){window.matchMedia("print").matches||h.current?h.current=window.matchMedia("print").matches:g(null)};return e.addListener(t),function(){return e.removeListener(t)}}}),[g,n,o]),(0,r.useMemo)((function(){return{colorMode:i,setColorMode:g,get isDarkTheme(){return i===d.dark},setLightTheme:function(){g(d.light)},setDarkTheme:function(){g(d.dark)}}}),[i,g])}();return r.createElement(s.Provider,{value:n},t)}function h(){var e=(0,r.useContext)(s);if(null==e)throw new a.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},373:function(e,t,n){"use strict";n.d(t,{J:function(){return b},L5:function(){return h}});var r=n(7294),o=n(143),a=n(9935),i=n(6668),l=n(3791),s=n(9688),u=n(12),c=function(e){return"docs-preferred-version-"+e},d={save:function(e,t,n){(0,u.WA)(c(e),{persistence:t}).set(n)},read:function(e,t){return(0,u.WA)(c(e),{persistence:t}).get()},clear:function(e,t){(0,u.WA)(c(e),{persistence:t}).del()}},f=function(e){return Object.fromEntries(e.map((function(e){return[e,{preferredVersionName:null}]})))};var p=r.createContext(null);function m(){var e=(0,o._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((function(){return Object.keys(e)}),[e]),a=(0,r.useState)((function(){return f(n)})),l=a[0],s=a[1];return(0,r.useEffect)((function(){s(function(e){var t=e.pluginIds,n=e.versionPersistence,r=e.allDocsData;return Object.fromEntries(t.map((function(e){return[e,(t=e,o=d.read(t,n),r[t].versions.some((function(e){return e.name===o}))?{preferredVersionName:o}:(d.clear(t,n),{preferredVersionName:null}))];var t,o})))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]),[l,(0,r.useMemo)((function(){return{savePreferredVersion:function(e,n){d.save(e,t,n),s((function(t){var r;return Object.assign({},t,((r={})[e]={preferredVersionName:n},r))}))}}}),[t])]}function g(e){var t=e.children,n=m();return r.createElement(p.Provider,{value:n},t)}function h(e){var t=e.children;return l.cE?r.createElement(g,null,t):r.createElement(r.Fragment,null,t)}function v(){var e=(0,r.useContext)(p);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function b(e){var t;void 0===e&&(e=a.m);var n=(0,o.zh)(e),i=v(),l=i[0],s=i[1],u=l[e].preferredVersionName;return{preferredVersion:null!=(t=n.versions.find((function(e){return e.name===u})))?t:null,savePreferredVersionName:(0,r.useCallback)((function(t){s.savePreferredVersion(e,t)}),[s,e])}}},1116:function(e,t,n){"use strict";n.d(t,{V:function(){return s},b:function(){return l}});var r=n(7294),o=n(9688),a=Symbol("EmptyContext"),i=r.createContext(a);function l(e){var t=e.children,n=e.name,o=e.items,a=(0,r.useMemo)((function(){return n&&o?{name:n,items:o}:null}),[n,o]);return r.createElement(i.Provider,{value:a},t)}function s(){var e=(0,r.useContext)(i);if(e===a)throw new o.i6("DocsSidebarProvider");return e}},3163:function(e,t,n){"use strict";n.d(t,{M:function(){return d},e:function(){return f}});var r=n(7294),o=n(3102),a=n(7524),i=n(1980),l=n(6668),s=n(9688),u=r.createContext(void 0);function c(){var e,t=(e=(0,o.HY)(),0===(0,l.L)().navbar.items.length&&!e.component),n=(0,a.i)(),s=!t&&"mobile"===n,u=(0,r.useState)(!1),c=u[0],d=u[1];(0,i.Rb)((function(){if(c)return d(!1),!1}));var f=(0,r.useCallback)((function(){d((function(e){return!e}))}),[]);return(0,r.useEffect)((function(){"desktop"===n&&d(!1)}),[n]),(0,r.useMemo)((function(){return{disabled:t,shouldRender:s,toggle:f,shown:c}}),[t,s,f,c])}function d(e){var t=e.children,n=c();return r.createElement(u.Provider,{value:n},t)}function f(){var e=r.useContext(u);if(void 0===e)throw new s.i6("NavbarMobileSidebarProvider");return e}},3102:function(e,t,n){"use strict";n.d(t,{HY:function(){return l},Zo:function(){return s},n2:function(){return i}});var r=n(7294),o=n(9688),a=r.createContext(null);function i(e){var t=e.children,n=(0,r.useState)({component:null,props:null});return r.createElement(a.Provider,{value:n},t)}function l(){var e=(0,r.useContext)(a);if(!e)throw new o.i6("NavbarSecondaryMenuContentProvider");return e[0]}function s(e){var t=e.component,n=e.props,i=(0,r.useContext)(a);if(!i)throw new o.i6("NavbarSecondaryMenuContentProvider");var l=i[1],s=(0,o.Ql)(n);return(0,r.useEffect)((function(){l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((function(){return function(){return l({component:null,props:null})}}),[l]),null}},9727:function(e,t,n){"use strict";n.d(t,{h:function(){return o},t:function(){return a}});var r=n(7294),o="navigation-with-keyboard";function a(){(0,r.useEffect)((function(){function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(o),"mousedown"===e.type&&document.body.classList.remove(o)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),function(){document.body.classList.remove(o),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7524:function(e,t,n){"use strict";n.d(t,{i:function(){return u}});var r=n(7294),o=n(412),a={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function l(){return o.Z.canUseDOM?window.innerWidth>i?a.desktop:a.mobile:a.ssr}var s=!1;function u(){var e=(0,r.useState)((function(){return s?"ssr":l()})),t=e[0],n=e[1];return(0,r.useEffect)((function(){function e(){n(l())}var t=s?window.setTimeout(e,1e3):void 0;return window.addEventListener("resize",e),function(){window.removeEventListener("resize",e),clearTimeout(t)}}),[]),t}},5281:function(e,t,n){"use strict";n.d(t,{k:function(){return r}});var r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",admonitionType:function(e){return"theme-admonition-"+e}},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:function(e){return"theme-doc-sidebar-item-category-level-"+e},docSidebarItemLinkLevel:function(e){return"theme-doc-sidebar-item-link-level-"+e}},blog:{}}},1442:function(e,t,n){"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{n:function(){return r}})},3791:function(e,t,n){"use strict";function r(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n=e.length?{done:!0}:{done:!1,value:e[o++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}n.d(t,{Wl:function(){return m},_F:function(){return v},cE:function(){return p},hI:function(){return S},lO:function(){return w},vY:function(){return E},oz:function(){return k},s1:function(){return y}});var a=n(7294),i=n(6550),l=n(8790),s=n(143),u=n(373),c=n(1116),d=n(7392),f=n(8596),p=!!s._r;function m(e){if(e.href)return e.href;for(var t,n=o(e.items);!(t=n()).done;){var r=t.value;if("link"===r.type)return r.href;if("category"===r.type){var a=m(r);if(a)return a}}}var g=function(e,t){return void 0!==e&&(0,f.Mg)(e,t)},h=function(e,t){return e.some((function(e){return v(e,t)}))};function v(e,t){return"link"===e.type?g(e.href,t):"category"===e.type&&(g(e.href,t)||h(e.items,t))}function b(e){var t=e.sidebarItems,n=e.pathname,r=e.onlyCategories,a=void 0!==r&&r,i=[];return function e(t){for(var r,l=o(t);!(r=l()).done;){var s=r.value;if("category"===s.type&&((0,f.Mg)(s.href,n)||e(s.items))||"link"===s.type&&(0,f.Mg)(s.href,n))return a&&"category"!==s.type||i.unshift(s),!0}return!1}(t),i}function y(){var e,t=(0,c.V)(),n=(0,i.TH)().pathname;return!1!==(null==(e=(0,s.gA)())?void 0:e.pluginData.breadcrumbs)&&t?b({sidebarItems:t.items,pathname:n}):null}function w(e){var t=(0,s.Iw)(e).activeVersion,n=(0,u.J)(e).preferredVersion,r=(0,s.yW)(e);return(0,a.useMemo)((function(){return(0,d.j)([t,n,r].filter(Boolean))}),[t,n,r])}function k(e,t){var n=w(t);return(0,a.useMemo)((function(){var t=n.flatMap((function(e){return e.sidebars?Object.entries(e.sidebars):[]})),r=t.find((function(t){return t[0]===e}));if(!r)throw new Error("Can't find any sidebar with id \""+e+'" in version'+(n.length>1?"s":"")+" "+n.map((function(e){return e.name})).join(", ")+'".\nAvailable sidebar ids are:\n- '+t.map((function(e){return e[0]})).join("\n- "));return r[1]}),[e,n])}function E(e,t){var n=w(t);return(0,a.useMemo)((function(){var t=n.flatMap((function(e){return e.docs})),r=t.find((function(t){return t.id===e}));if(!r){if(n.flatMap((function(e){return e.draftIds})).includes(e))return null;throw new Error("Couldn't find any doc with id \""+e+'" in version'+(n.length>1?"s":"")+' "'+n.map((function(e){return e.name})).join(", ")+'".\nAvailable doc ids are:\n- '+(0,d.j)(t.map((function(e){return e.id}))).join("\n- "))}return r}),[e,n])}function S(e){var t=e.route,n=e.versionMetadata,r=(0,i.TH)(),o=t.routes,a=o.find((function(e){return(0,i.LX)(r.pathname,e)}));if(!a)return null;var s=a.sidebar,u=s?n.docsSidebars[s]:void 0;return{docElement:(0,l.H)(o),sidebarName:s,sidebarItems:u}}},1980:function(e,t,n){"use strict";n.d(t,{Rb:function(){return l},_X:function(){return s}});var r=n(7294),o=n(6550),a=n(1688),i=n(9688);function l(e){!function(e){var t=(0,o.k6)(),n=(0,i.zX)(e);(0,r.useEffect)((function(){return t.block((function(e,t){return n(e,t)}))}),[t,n])}((function(t,n){if("POP"===n)return e(t,n)}))}function s(e){return t=function(t){return null===e?null:new URLSearchParams(t.location.search).get(e)},n=(0,o.k6)(),(0,a.useSyncExternalStore)(n.listen,(function(){return t(n)}),(function(){return t(n)}));var t,n}},7392:function(e,t,n){"use strict";function r(e,t){return void 0===t&&(t=function(e,t){return e===t}),e.filter((function(n,r){return e.findIndex((function(e){return t(e,n)}))!==r}))}function o(e){return Array.from(new Set(e))}n.d(t,{j:function(){return o},l:function(){return r}})},1944:function(e,t,n){"use strict";n.d(t,{FG:function(){return f},d:function(){return c},VC:function(){return p}});var r=n(7294),o=n(6010),a=n(5742),i=n(226);function l(){var e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(4996),u=n(2263);function c(e){var t=e.title,n=e.description,o=e.keywords,i=e.image,l=e.children,c=function(e){var t=(0,u.Z)().siteConfig,n=t.title,r=t.titleDelimiter;return null!=e&&e.trim().length?e.trim()+" "+r+" "+n:n}(t),d=(0,s.C)().withBaseUrl,f=i?d(i,{absolute:!0}):void 0;return r.createElement(a.Z,null,t&&r.createElement("title",null,c),t&&r.createElement("meta",{property:"og:title",content:c}),n&&r.createElement("meta",{name:"description",content:n}),n&&r.createElement("meta",{property:"og:description",content:n}),o&&r.createElement("meta",{name:"keywords",content:Array.isArray(o)?o.join(","):o}),f&&r.createElement("meta",{property:"og:image",content:f}),f&&r.createElement("meta",{name:"twitter:image",content:f}),l)}var d=r.createContext(void 0);function f(e){var t=e.className,n=e.children,i=r.useContext(d),l=(0,o.Z)(i,t);return r.createElement(d.Provider,{value:l},r.createElement(a.Z,null,r.createElement("html",{className:l})),n)}function p(e){var t=e.children,n=l(),a="plugin-"+n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,""),i="plugin-id-"+n.plugin.id;return r.createElement(f,{className:(0,o.Z)(a,i)},t)}},9688:function(e,t,n){"use strict";n.d(t,{i6:function(){return p},Qc:function(){return g},zX:function(){return d},D9:function(){return f},Ql:function(){return m}});var r=n(7099),o=n(4578);function a(e){return a=Object.setPrototypeOf?Object.getPrototypeOf.bind():function(e){return e.__proto__||Object.getPrototypeOf(e)},a(e)}var i=n(9611);function l(e,t,n){return l=function(){if("undefined"==typeof Reflect||!Reflect.construct)return!1;if(Reflect.construct.sham)return!1;if("function"==typeof Proxy)return!0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],(function(){}))),!0}catch(e){return!1}}()?Reflect.construct.bind():function(e,t,n){var r=[null];r.push.apply(r,t);var o=new(Function.bind.apply(e,r));return n&&(0,i.Z)(o,n.prototype),o},l.apply(null,arguments)}function s(e){var t="function"==typeof Map?new Map:void 0;return s=function(e){if(null===e||(n=e,-1===Function.toString.call(n).indexOf("[native code]")))return e;var n;if("function"!=typeof e)throw new TypeError("Super expression must either be null or a function");if(void 0!==t){if(t.has(e))return t.get(e);t.set(e,r)}function r(){return l(e,arguments,a(this).constructor)}return r.prototype=Object.create(e.prototype,{constructor:{value:r,enumerable:!1,writable:!0,configurable:!0}}),(0,i.Z)(r,e)},s(e)}var u=n(7294),c=n(412).Z.canUseDOM?u.useLayoutEffect:u.useEffect;function d(e){var t=(0,u.useRef)(e);return c((function(){t.current=e}),[e]),(0,u.useCallback)((function(){return t.current.apply(t,arguments)}),[])}function f(e){var t=(0,u.useRef)();return c((function(){t.current=e})),t.current}var p=function(e){function t(t,n){var o,a,i;return(i=e.call(this)||this).name="ReactContextError",i.message="Hook "+(null!=(o=null==(a=i.stack)||null==(a=a.split("\n")[1])||null==(a=a.match((0,r.Z)(/at (?:\w+\.)?(\w+)/,{name:1})))?void 0:a.groups.name)?o:"")+" is called outside the <"+t+">. "+(null!=n?n:""),i}return(0,o.Z)(t,e),t}(s(Error));function m(e){var t=Object.entries(e);return t.sort((function(e,t){return e[0].localeCompare(t[0])})),(0,u.useMemo)((function(){return e}),t.flat())}function g(e){return function(t){var n=t.children;return u.createElement(u.Fragment,null,e.reduceRight((function(e,t){return u.createElement(t,null,e)}),n))}}},8596:function(e,t,n){"use strict";n.d(t,{Mg:function(){return i},Ns:function(){return l}});var r=n(7294),o=n(723),a=n(2263);function i(e,t){var n=function(e){var t;return null==(t=!e||e.endsWith("/")?e:e+"/")?void 0:t.toLowerCase()};return n(e)===n(t)}function l(){var e=(0,a.Z)().siteConfig.baseUrl;return(0,r.useMemo)((function(){return function(e){var t=e.baseUrl;function n(e){return e.path===t&&!0===e.exact}function r(e){return e.path===t&&!e.exact}return function e(t){if(0!==t.length)return t.find(n)||e(t.filter(r).flatMap((function(e){var t;return null!=(t=e.routes)?t:[]})))}(e.routes)}({routes:o.Z,baseUrl:e})}),[e])}},2466:function(e,t,n){"use strict";n.d(t,{Ct:function(){return p},OC:function(){return s},RF:function(){return d},o5:function(){return f}});var r=n(7294),o=n(412),a=n(2389),i=n(9688);var l=r.createContext(void 0);function s(e){var t,n=e.children,o=(t=(0,r.useRef)(!0),(0,r.useMemo)((function(){return{scrollEventsEnabledRef:t,enableScrollEvents:function(){t.current=!0},disableScrollEvents:function(){t.current=!1}}}),[]));return r.createElement(l.Provider,{value:o},n)}function u(){var e=(0,r.useContext)(l);if(null==e)throw new i.i6("ScrollControllerProvider");return e}var c=function(){return o.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null};function d(e,t){void 0===t&&(t=[]);var n=u().scrollEventsEnabledRef,o=(0,r.useRef)(c()),a=(0,i.zX)(e);(0,r.useEffect)((function(){var e=function(){if(n.current){var e=c();a(e,o.current),o.current=e}},t={passive:!0};return e(),window.addEventListener("scroll",e,t),function(){return window.removeEventListener("scroll",e,t)}}),[a,n].concat(t))}function f(){var e,t,n,o=u(),a=(e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((function(t){e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((function(){var t=e.current,n=t.elem,r=t.top;if(!n)return{restored:!1};var o=n.getBoundingClientRect().top-r;return o&&window.scrollBy({left:0,top:o}),e.current={elem:null,top:0},{restored:0!==o}}),[]),(0,r.useMemo)((function(){return{save:t,restore:n}}),[n,t])),i=(0,r.useRef)(void 0),l=(0,r.useCallback)((function(e){a.save(e),o.disableScrollEvents(),i.current=function(){var e=a.restore().restored;if(i.current=void 0,e){window.addEventListener("scroll",(function e(){o.enableScrollEvents(),window.removeEventListener("scroll",e)}))}else o.enableScrollEvents()}}),[o,a]);return(0,r.useLayoutEffect)((function(){queueMicrotask((function(){return null==i.current?void 0:i.current()}))})),{blockElementScrollPositionUntilNextRender:l}}function p(){var e=(0,r.useRef)(null),t=(0,a.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:function(n){e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),function(){}}(n):function(e){var t=null,n=document.documentElement.scrollTop>e;return function r(){var o=document.documentElement.scrollTop;(n&&o>e||!n&&o=0;f--){var p=i[f];"."===p?a(i,f):".."===p?(a(i,f),d++):d&&(a(i,f),d--)}if(!u)for(;d--;d)i.unshift("..");!u||""===i[0]||i[0]&&o(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};function l(e){return e.valueOf?e.valueOf():Object.prototype.valueOf.call(e)}var s=function e(t,n){if(t===n)return!0;if(null==t||null==n)return!1;if(Array.isArray(t))return Array.isArray(n)&&t.length===n.length&&t.every((function(t,r){return e(t,n[r])}));if("object"==typeof t||"object"==typeof n){var r=l(t),o=l(n);return r!==t||o!==n?e(r,o):Object.keys(Object.assign({},t,n)).every((function(r){return e(t[r],n[r])}))}return!1},u=n(8776);function c(e){return"/"===e.charAt(0)?e:"/"+e}function d(e){return"/"===e.charAt(0)?e.substr(1):e}function f(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function p(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function m(e){var t=e.pathname,n=e.search,r=e.hash,o=t||"/";return n&&"?"!==n&&(o+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(o+="#"===r.charAt(0)?r:"#"+r),o}function g(e,t,n,o){var a;"string"==typeof e?(a=function(e){var t=e||"/",n="",r="",o=t.indexOf("#");-1!==o&&(r=t.substr(o),t=t.substr(0,o));var a=t.indexOf("?");return-1!==a&&(n=t.substr(a),t=t.substr(0,a)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),a.state=t):(void 0===(a=(0,r.Z)({},e)).pathname&&(a.pathname=""),a.search?"?"!==a.search.charAt(0)&&(a.search="?"+a.search):a.search="",a.hash?"#"!==a.hash.charAt(0)&&(a.hash="#"+a.hash):a.hash="",void 0!==t&&void 0===a.state&&(a.state=t));try{a.pathname=decodeURI(a.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+a.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(a.key=n),o?a.pathname?"/"!==a.pathname.charAt(0)&&(a.pathname=i(a.pathname,o.pathname)):a.pathname=o.pathname:a.pathname||(a.pathname="/"),a}function h(e,t){return e.pathname===t.pathname&&e.search===t.search&&e.hash===t.hash&&e.key===t.key&&s(e.state,t.state)}function v(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,o){if(null!=e){var a="function"==typeof e?e(t,n):e;"string"==typeof a?"function"==typeof r?r(a,o):o(!0):o(!1!==a)}else o(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,o):n.push(o),d({action:r,location:o,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",o=g(e,t,f(),w.location);c.confirmTransitionTo(o,r,n,(function(e){e&&(w.entries[w.index]=o,d({action:r,location:o}))}))},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=w.index+e;return t>=0&&t
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}function i(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var a=n.render(!t),u=a.querySelector(r.barSelector),c=r.speed,d=r.easing;return a.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(u,i(e,c,d)),1===e?(s(a,{transition:"none",opacity:1}),a.offsetWidth,setTimeout((function(){s(a,{transition:"all "+c+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),c)}),c)):setTimeout(t,c)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");c(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),l=e?"-100":a(n.status||0),u=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&p(o),u!=document.body&&c(u,"nprogress-custom-parent"),u.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&p(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}function o(e){return e=n(e),t[e]||(t[e]=r(e))}function a(e,t,n){t=o(t),e.style[t]=n}return function(e,t){var n,r,o=arguments;if(2==o.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&a(e,n,r);else a(e,o[1],o[2])}}();function u(e,t){return("string"==typeof e?e:f(e)).indexOf(" "+t+" ")>=0}function c(e,t){var n=f(e),r=n+t;u(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=f(e);u(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function f(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function p(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(o="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=o)},7418:function(e){"use strict";var t=Object.getOwnPropertySymbols,n=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(o){return!1}}()?Object.assign:function(e,o){for(var a,i,l=function(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}(e),s=1;s=d.reach);S+=E.value.length,E=E.next){var x=E.value;if(t.length>e.length)return;if(!(x instanceof o)){var _,C=1;if(b){if(!(_=a(k,S,e,v))||_.index>=e.length)break;var T=_.index,L=_.index+_[0].length,A=S;for(A+=E.value.length;T>=A;)A+=(E=E.next).value.length;if(S=A-=E.value.length,E.value instanceof o)continue;for(var N=E;N!==t.tail&&(Ad.reach&&(d.reach=I);var D=E.prev;if(R&&(D=s(t,D,R),S+=R.length),u(t,D,C),E=s(t,D,new o(f,h?r.tokenize(O,h):O,y,O)),P&&s(t,E,P),C>1){var M={cause:f+","+m,reach:I};i(e,t,n,E.prev,S,M),d&&M.reach>d.reach&&(d.reach=M.reach)}}}}}}function l(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function s(e,t,n){var r=t.next,o={value:n,prev:t,next:r};return t.next=o,r.prev=o,e.length++,o}function u(e,t,n){for(var r=t.next,o=0;o"+a.content+""},r}(),r=n;n.default=n,r.languages.markup={comment:{pattern://,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern://i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},r.languages.markup.tag.inside["attr-value"].inside.entity=r.languages.markup.entity,r.languages.markup.doctype.inside["internal-subset"].inside=r.languages.markup,r.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(r.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^$)/i,lookbehind:!0,inside:r.languages[t]},n.cdata=/^$/i;var o={"included-cdata":{pattern://i,inside:n}};o["language-"+t]={pattern:/[\s\S]+/,inside:r.languages[t]};var a={};a[e]={pattern:RegExp(/(<__[^>]*>)(?:))*\]\]>|(?!)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:o},r.languages.insertBefore("markup","cdata",a)}}),Object.defineProperty(r.languages.markup.tag,"addAttribute",{value:function(e,t){r.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:r.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),r.languages.html=r.languages.markup,r.languages.mathml=r.languages.markup,r.languages.svg=r.languages.markup,r.languages.xml=r.languages.extend("markup",{}),r.languages.ssml=r.languages.xml,r.languages.atom=r.languages.xml,r.languages.rss=r.languages.xml,function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:r},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:r.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var o=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],a=r.variable[1].inside,i=0;i]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},r.languages.c=r.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),r.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),r.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},r.languages.c.string],char:r.languages.c.char,comment:r.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:r.languages.c}}}}),r.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete r.languages.c.boolean,function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,n=/\b(?!)\w+(?:\s*\.\s*\w+)*\b/.source.replace(//g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!)\w+/.source.replace(//g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/(?:\s*:\s*)?|:\s*/.source.replace(//g,(function(){return n}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(r),function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),n.tag.addAttribute("style","css"))}(r),function(e){var t,n=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css.selector={pattern:e.languages.css.selector.pattern,lookbehind:!0,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+n.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[n,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}});var r={pattern:/(\b\d+)(?:%|[a-z]+(?![\w-]))/,lookbehind:!0},o={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0};e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#[\da-f]{3,8}\b/i,alias:"color"},color:[{pattern:/(^|[^\w-])(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)(?![\w-])/i,lookbehind:!0},{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:r,number:o,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:r,number:o})}(r),r.languages.javascript=r.languages.extend("clike",{"class-name":[r.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),r.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,r.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:r.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:r.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:r.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:r.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:r.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),r.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:r.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),r.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),r.languages.markup&&(r.languages.markup.tag.addInlined("script","javascript"),r.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),r.languages.js=r.languages.javascript,function(e){var t=/#(?!\{).+/,n={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:n}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:n}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:e.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:n}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(r),function(e){var t=/[*&][^\s[\]{},]+/,n=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,r="(?:"+n.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+n.source+")?)",o=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-])(?:[ \t]*(?:(?![#:])|:))*/.source.replace(//g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),a=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function i(e,t){t=(t||"").replace(/m/g,"")+"m";var n=/([:\-,[{]\s*(?:\s<>[ \t]+)?)(?:<>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return e}));return RegExp(n,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<>/g,(function(){return r}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<>[ \t]+)?)<>(?=\s*:\s)/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return"(?:"+o+"|"+a+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:i(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:i(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:i(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:i(a),lookbehind:!0,greedy:!0},number:{pattern:i(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:n,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(r),function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?![\r\n]))/.source;function n(e){return e=e.replace(//g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var r=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,o=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return r})),a=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source;e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"front-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+o+a+"(?:"+o+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+o+a+")(?:"+o+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(r),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+o+")"+a+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+o+"$"),inside:{"table-header":{pattern:RegExp(r),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:n(/\b__(?:(?!_)|_(?:(?!_))+_)+__\b|\*\*(?:(?!\*)|\*(?:(?!\*))+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:n(/\b_(?:(?!_)|__(?:(?!_))+__)+_\b|\*(?:(?!\*)|\*\*(?:(?!\*))+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:n(/(~~?)(?:(?!~))+\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},"code-snippet":{pattern:/(^|[^\\`])(?:``[^`\r\n]+(?:`[^`\r\n]+)*``(?!`)|`[^`\r\n]+`(?!`))/,lookbehind:!0,greedy:!0,alias:["code","keyword"]},url:{pattern:n(/!?\[(?:(?!\]))+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\]))+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike","code-snippet"].forEach((function(n){t!==n&&(e.languages.markdown[t].inside.content.inside[n]=e.languages.markdown[n])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var n=0,r=t.length;n",quot:'"'},s=String.fromCodePoint||String.fromCharCode;e.languages.md=e.languages.markdown}(r),r.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:r.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:false|true)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/\b[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"atom-input":{pattern:/\b[A-Z]\w*Input\b/,alias:"class-name"},scalar:/\b(?:Boolean|Float|ID|Int|String)\b/,constant:/\b[A-Z][A-Z_\d]*\b/,"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*|:\s*|\[)[A-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-mutation":{pattern:/(\bmutation\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-query":{pattern:/(\bquery\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,"property-query":/\w+(?=\s*\()/,object:/\w+(?=\s*\{)/,punctuation:/[!(){}\[\]:=,]/,property:/\w+/},r.hooks.add("after-tokenize",(function(e){if("graphql"===e.language)for(var t=e.tokens.filter((function(e){return"string"!=typeof e&&"comment"!==e.type&&"scalar"!==e.type})),n=0;n0)){var l=f(/^\{$/,/^\}$/);if(-1===l)continue;for(var s=n;s=0&&p(u,"variable-input")}}}}function c(e){return t[n+e]}function d(e,t){t=t||0;for(var n=0;n?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t=e.languages.javascript["template-string"],n=t.pattern.source,r=t.inside.interpolation,o=r.inside["interpolation-punctuation"],a=r.pattern.source;function i(t,r){if(e.languages[t])return{pattern:RegExp("((?:"+r+")\\s*)"+n),lookbehind:!0,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},"embedded-code":{pattern:/[\s\S]+/,alias:t}}}}function l(e,t){return"___"+t.toUpperCase()+"_"+e+"___"}function s(t,n,r){var o={code:t,grammar:n,language:r};return e.hooks.run("before-tokenize",o),o.tokens=e.tokenize(o.code,o.grammar),e.hooks.run("after-tokenize",o),o.tokens}function u(t){var n={};n["interpolation-punctuation"]=o;var a=e.tokenize(t,n);if(3===a.length){var i=[1,1];i.push.apply(i,s(a[1],e.languages.javascript,"javascript")),a.splice.apply(a,i)}return new e.Token("interpolation",a,r.alias,t)}function c(t,n,r){var o=e.tokenize(t,{interpolation:{pattern:RegExp(a),lookbehind:!0}}),i=0,c={},d=s(o.map((function(e){if("string"==typeof e)return e;for(var n,o=e.content;-1!==t.indexOf(n=l(i++,r)););return c[n]=o,n})).join(""),n,r),f=Object.keys(c);return i=0,function e(t){for(var n=0;n=f.length)return;var r=t[n];if("string"==typeof r||"string"==typeof r.content){var o=f[i],a="string"==typeof r?r:r.content,l=a.indexOf(o);if(-1!==l){++i;var s=a.substring(0,l),d=u(c[o]),p=a.substring(l+o.length),m=[];if(s&&m.push(s),m.push(d),p){var g=[p];e(g),m.push.apply(m,g)}"string"==typeof r?(t.splice.apply(t,[n,1].concat(m)),n+=m.length-1):r.content=m}}else{var h=r.content;Array.isArray(h)?e(h):e([h])}}}(d),new e.Token(r,d,"language-"+r,t)}e.languages.javascript["template-string"]=[i("css",/\b(?:styled(?:\([^)]*\))?(?:\s*\.\s*\w+(?:\([^)]*\))*)*|css(?:\s*\.\s*(?:global|resolve))?|createGlobalStyle|keyframes)/.source),i("html",/\bhtml|\.\s*(?:inner|outer)HTML\s*\+?=/.source),i("svg",/\bsvg/.source),i("markdown",/\b(?:markdown|md)/.source),i("graphql",/\b(?:gql|graphql(?:\s*\.\s*experimental)?)/.source),i("sql",/\bsql/.source),t].filter(Boolean);var d={javascript:!0,js:!0,typescript:!0,ts:!0,jsx:!0,tsx:!0};function f(e){return"string"==typeof e?e:Array.isArray(e)?e.map(f).join(""):f(e.content)}e.hooks.add("after-tokenize",(function(t){t.language in d&&function t(n){for(var r=0,o=n.length;r]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},builtin:/\b(?:Array|Function|Promise|any|boolean|console|never|number|string|symbol|unknown)\b/}),e.languages.typescript.keyword.push(/\b(?:abstract|declare|is|keyof|readonly|require)\b/,/\b(?:asserts|infer|interface|module|namespace|type)\b(?=\s*(?:[{_$a-zA-Z\xA0-\uFFFF]|$))/,/\btype\b(?=\s*(?:[\{*]|$))/),delete e.languages.typescript.parameter,delete e.languages.typescript["literal-property"];var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{decorator:{pattern:/@[$\w\xA0-\uFFFF]+/,inside:{at:{pattern:/^@/,alias:"operator"},function:/^[\s\S]+/}},"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(r),function(e){function t(e,t){return RegExp(e.replace(//g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:Float(?:32|64)|(?:Int|Uint)(?:8|16|32)|Uint8Clamped)?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|(?:Weak)?(?:Map|Set)|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:(?:\s*,\s*(?:\*\s*as\s+|\{[^{}]*\}))?|\*\s*as\s+|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|finally|for|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|(?:local|session)Storage|location|navigator|performance|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var n=["function","function-variable","method","method-variable","property-access"],r=0;r*\.{3}(?:[^{}]|)*\})/.source;function a(e,t){return e=e.replace(//g,(function(){return n})).replace(//g,(function(){return r})).replace(//g,(function(){return o})),RegExp(e,t)}o=a(o).source,e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=a(/<\/?(?:[\w.:-]+(?:+(?:[\w.:$-]+(?:=(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s{'"/>=]+|))?|))**\/?)?>/.source),e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s'">]+)/,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.jsx.tag.inside.comment=t.comment,e.languages.insertBefore("inside","attr-name",{spread:{pattern:a(//.source),inside:e.languages.jsx}},e.languages.jsx.tag),e.languages.insertBefore("inside","special-attr",{script:{pattern:a(/=/.source),alias:"language-javascript",inside:{"script-punctuation":{pattern:/^=(?=\{)/,alias:"punctuation"},rest:e.languages.jsx}}},e.languages.jsx.tag);var i=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(i).join(""):""},l=function(t){for(var n=[],r=0;r0&&n[n.length-1].tagName===i(o.content[0].content[1])&&n.pop():"/>"===o.content[o.content.length-1].content||n.push({tagName:i(o.content[0].content[1]),openedBraces:0}):n.length>0&&"punctuation"===o.type&&"{"===o.content?n[n.length-1].openedBraces++:n.length>0&&n[n.length-1].openedBraces>0&&"punctuation"===o.type&&"}"===o.content?n[n.length-1].openedBraces--:a=!0),(a||"string"==typeof o)&&n.length>0&&0===n[n.length-1].openedBraces){var s=i(o);r0&&("string"==typeof t[r-1]||"plain-text"===t[r-1].type)&&(s=i(t[r-1])+s,t.splice(r-1,1),r--),t[r]=new e.Token("plain-text",s,null,s)}o.content&&"string"!=typeof o.content&&l(o.content)}};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||l(e.tokens)}))}(r),function(e){e.languages.diff={coord:[/^(?:\*{3}|-{3}|\+{3}).*$/m,/^@@.*@@$/m,/^\d.*$/m]};var t={"deleted-sign":"-","deleted-arrow":"<","inserted-sign":"+","inserted-arrow":">",unchanged:" ",diff:"!"};Object.keys(t).forEach((function(n){var r=t[n],o=[];/^\w+$/.test(n)||o.push(/\w+/.exec(n)[0]),"diff"===n&&o.push("bold"),e.languages.diff[n]={pattern:RegExp("^(?:["+r+"].*(?:\r\n?|\n|(?![\\s\\S])))+","m"),alias:o,inside:{line:{pattern:/(.)(?=[\s\S]).*(?:\r\n?|\n)?/,lookbehind:!0},prefix:{pattern:/[\s\S]/,alias:/\w+/.exec(n)[0]}}}})),Object.defineProperty(e.languages.diff,"PREFIXES",{value:t})}(r),r.languages.git={comment:/^#.*/m,deleted:/^[-\u2013].*/m,inserted:/^\+.*/m,string:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,command:{pattern:/^.*\$ git .*$/m,inside:{parameter:/\s--?\w+/}},coord:/^@@.*@@$/m,"commit-sha1":/^commit \w{40}$/m},r.languages.go=r.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),r.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete r.languages.go["class-name"],function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;s=a.length);s++){var u=l[s];if("string"==typeof u||u.content&&"string"==typeof u.content){var c=a[o],d=n.tokenStack[c],f="string"==typeof u?u:u.content,p=t(r,c),m=f.indexOf(p);if(m>-1){++o;var g=f.substring(0,m),h=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),v=f.substring(m+p.length),b=[];g&&b.push.apply(b,i([g])),b.push(h),v&&b.push.apply(b,i([v])),"string"==typeof u?l.splice.apply(l,[s,1].concat(b)):u.content=b}}else u.content&&i(u.content)}return l}(n.tokens)}}}})}(r),function(e){e.languages.handlebars={comment:/\{\{![\s\S]*?\}\}/,delimiter:{pattern:/^\{\{\{?|\}\}\}?$/,alias:"punctuation"},string:/(["'])(?:\\.|(?!\1)[^\\\r\n])*\1/,number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee][+-]?\d+)?/,boolean:/\b(?:false|true)\b/,block:{pattern:/^(\s*(?:~\s*)?)[#\/]\S+?(?=\s*(?:~\s*)?$|\s)/,lookbehind:!0,alias:"keyword"},brackets:{pattern:/\[[^\]]+\]/,inside:{punctuation:/\[|\]/,variable:/[\s\S]+/}},punctuation:/[!"#%&':()*+,.\/;<=>@\[\\\]^`{|}~]/,variable:/[^!"#%&'()*+,\/;<=>@\[\\\]^`{|}~\s]+/},e.hooks.add("before-tokenize",(function(t){e.languages["markup-templating"].buildPlaceholders(t,"handlebars",/\{\{\{[\s\S]+?\}\}\}|\{\{[\s\S]+?\}\}/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"handlebars")})),e.languages.hbs=e.languages.handlebars}(r),r.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},r.languages.webmanifest=r.languages.json,r.languages.less=r.languages.extend("css",{comment:[/\/\*[\s\S]*?\*\//,{pattern:/(^|[^\\])\/\/.*/,lookbehind:!0}],atrule:{pattern:/@[\w-](?:\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{punctuation:/[:()]/}},selector:{pattern:/(?:@\{[\w-]+\}|[^{};\s@])(?:@\{[\w-]+\}|\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};@\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{variable:/@+[\w-]+/}},property:/(?:@\{[\w-]+\}|[\w-])+(?:\+_?)?(?=\s*:)/,operator:/[+\-*\/]/}),r.languages.insertBefore("less","property",{variable:[{pattern:/@[\w-]+\s*:/,inside:{punctuation:/:/}},/@@?[\w-]+/],"mixin-usage":{pattern:/([{;]\s*)[.#](?!\d)[\w-].*?(?=[(;])/,lookbehind:!0,alias:"function"}}),r.languages.makefile={comment:{pattern:/(^|[^\\])#(?:\\(?:\r\n|[\s\S])|[^\\\r\n])*/,lookbehind:!0},string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"builtin-target":{pattern:/\.[A-Z][^:#=\s]+(?=\s*:(?!=))/,alias:"builtin"},target:{pattern:/^(?:[^:=\s]|[ \t]+(?![\s:]))+(?=\s*:(?!=))/m,alias:"symbol",inside:{variable:/\$+(?:(?!\$)[^(){}:#=\s]+|(?=[({]))/}},variable:/\$+(?:(?!\$)[^(){}:#=\s]+|\([@*%<^+?][DF]\)|(?=[({]))/,keyword:/-include\b|\b(?:define|else|endef|endif|export|ifn?def|ifn?eq|include|override|private|sinclude|undefine|unexport|vpath)\b/,function:{pattern:/(\()(?:abspath|addsuffix|and|basename|call|dir|error|eval|file|filter(?:-out)?|findstring|firstword|flavor|foreach|guile|if|info|join|lastword|load|notdir|or|origin|patsubst|realpath|shell|sort|strip|subst|suffix|value|warning|wildcard|word(?:list|s)?)(?=[ \t])/,lookbehind:!0},operator:/(?:::|[?:+!])?=|[|@]/,punctuation:/[:;(){}]/},r.languages.objectivec=r.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete r.languages.objectivec["class-name"],r.languages.objc=r.languages.objectivec,r.languages.ocaml={comment:{pattern:/\(\*[\s\S]*?\*\)/,greedy:!0},char:{pattern:/'(?:[^\\\r\n']|\\(?:.|[ox]?[0-9a-f]{1,3}))'/i,greedy:!0},string:[{pattern:/"(?:\\(?:[\s\S]|\r\n)|[^\\\r\n"])*"/,greedy:!0},{pattern:/\{([a-z_]*)\|[\s\S]*?\|\1\}/,greedy:!0}],number:[/\b(?:0b[01][01_]*|0o[0-7][0-7_]*)\b/i,/\b0x[a-f0-9][a-f0-9_]*(?:\.[a-f0-9_]*)?(?:p[+-]?\d[\d_]*)?(?!\w)/i,/\b\d[\d_]*(?:\.[\d_]*)?(?:e[+-]?\d[\d_]*)?(?!\w)/i],directive:{pattern:/\B#\w+/,alias:"property"},label:{pattern:/\B~\w+/,alias:"property"},"type-variable":{pattern:/\B'\w+/,alias:"function"},variant:{pattern:/`\w+/,alias:"symbol"},keyword:/\b(?:as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|match|method|module|mutable|new|nonrec|object|of|open|private|rec|sig|struct|then|to|try|type|val|value|virtual|when|where|while|with)\b/,boolean:/\b(?:false|true)\b/,"operator-like-punctuation":{pattern:/\[[<>|]|[>|]\]|\{<|>\}/,alias:"punctuation"},operator:/\.[.~]|:[=>]|[=<>@^|&+\-*\/$%!?~][!$%&*+\-.\/:<=>?@^|~]*|\b(?:and|asr|land|lor|lsl|lsr|lxor|mod|or)\b/,punctuation:/;;|::|[(){}\[\].,:;#]|\b_\b/},r.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},r.languages.python["string-interpolation"].inside.interpolation.inside.rest=r.languages.python,r.languages.py=r.languages.python,r.languages.reason=r.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:asr|land|lor|lsl|lsr|lxor|mod)\b/}),r.languages.insertBefore("reason","class-name",{char:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,greedy:!0},constructor:/\b[A-Z]\w*\b(?!\s*\.)/,label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete r.languages.reason.function,function(e){e.languages.sass=e.languages.extend("css",{comment:{pattern:/^([ \t]*)\/[\/*].*(?:(?:\r?\n|\r)\1[ \t].+)*/m,lookbehind:!0,greedy:!0}}),e.languages.insertBefore("sass","atrule",{"atrule-line":{pattern:/^(?:[ \t]*)[@+=].+/m,greedy:!0,inside:{atrule:/(?:@[\w-]+|[+=])/}}}),delete e.languages.sass.atrule;var t=/\$[-\w]+|#\{\$[-\w]+\}/,n=[/[+*\/%]|[=!]=|<=?|>=?|\b(?:and|not|or)\b/,{pattern:/(\s)-(?=\s)/,lookbehind:!0}];e.languages.insertBefore("sass","property",{"variable-line":{pattern:/^[ \t]*\$.+/m,greedy:!0,inside:{punctuation:/:/,variable:t,operator:n}},"property-line":{pattern:/^[ \t]*(?:[^:\s]+ *:.*|:[^:\s].*)/m,greedy:!0,inside:{property:[/[^:\s]+(?=\s*:)/,{pattern:/(:)[^:\s]+/,lookbehind:!0}],punctuation:/:/,variable:t,operator:n,important:e.languages.sass.important}}}),delete e.languages.sass.property,delete e.languages.sass.important,e.languages.insertBefore("sass","punctuation",{selector:{pattern:/^([ \t]*)\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*(?:,(?:\r?\n|\r)\1[ \t]+\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*)*/m,lookbehind:!0,greedy:!0}})}(r),r.languages.scss=r.languages.extend("css",{comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},atrule:{pattern:/@[\w-](?:\([^()]+\)|[^()\s]|\s+(?!\s))*?(?=\s+[{;])/,inside:{rule:/@[\w-]+/}},url:/(?:[-a-z]+-)?url(?=\()/i,selector:{pattern:/(?=\S)[^@;{}()]?(?:[^@;{}()\s]|\s+(?!\s)|#\{\$[-\w]+\})+(?=\s*\{(?:\}|\s|[^}][^:{}]*[:{][^}]))/,inside:{parent:{pattern:/&/,alias:"important"},placeholder:/%[-\w]+/,variable:/\$[-\w]+|#\{\$[-\w]+\}/}},property:{pattern:/(?:[-\w]|\$[-\w]|#\{\$[-\w]+\})+(?=\s*:)/,inside:{variable:/\$[-\w]+|#\{\$[-\w]+\}/}}}),r.languages.insertBefore("scss","atrule",{keyword:[/@(?:content|debug|each|else(?: if)?|extend|for|forward|function|if|import|include|mixin|return|use|warn|while)\b/i,{pattern:/( )(?:from|through)(?= )/,lookbehind:!0}]}),r.languages.insertBefore("scss","important",{variable:/\$[-\w]+|#\{\$[-\w]+\}/}),r.languages.insertBefore("scss","function",{"module-modifier":{pattern:/\b(?:as|hide|show|with)\b/i,alias:"keyword"},placeholder:{pattern:/%[-\w]+/,alias:"selector"},statement:{pattern:/\B!(?:default|optional)\b/i,alias:"keyword"},boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"},operator:{pattern:/(\s)(?:[-+*\/%]|[=!]=|<=?|>=?|and|not|or)(?=\s)/,lookbehind:!0}}),r.languages.scss.atrule.inside.rest=r.languages.scss,function(e){var t={pattern:/(\b\d+)(?:%|[a-z]+)/,lookbehind:!0},n={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0},r={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},url:{pattern:/\burl\((["']?).*?\1\)/i,greedy:!0},string:{pattern:/("|')(?:(?!\1)[^\\\r\n]|\\(?:\r\n|[\s\S]))*\1/,greedy:!0},interpolation:null,func:null,important:/\B!(?:important|optional)\b/i,keyword:{pattern:/(^|\s+)(?:(?:else|for|if|return|unless)(?=\s|$)|@[\w-]+)/,lookbehind:!0},hexcode:/#[\da-f]{3,6}/i,color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:n,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,boolean:/\b(?:false|true)\b/,operator:[/~|[+!\/%<>?=]=?|[-:]=|\*[*=]?|\.{2,3}|&&|\|\||\B-\B|\b(?:and|in|is(?: a| defined| not|nt)?|not|or)\b/],number:n,punctuation:/[{}()\[\];:,]/};r.interpolation={pattern:/\{[^\r\n}:]+\}/,alias:"variable",inside:{delimiter:{pattern:/^\{|\}$/,alias:"punctuation"},rest:r}},r.func={pattern:/[\w-]+\([^)]*\).*/,inside:{function:/^[^(]+/,rest:r}},e.languages.stylus={"atrule-declaration":{pattern:/(^[ \t]*)@.+/m,lookbehind:!0,inside:{atrule:/^@[\w-]+/,rest:r}},"variable-declaration":{pattern:/(^[ \t]*)[\w$-]+\s*.?=[ \t]*(?:\{[^{}]*\}|\S.*|$)/m,lookbehind:!0,inside:{variable:/^\S+/,rest:r}},statement:{pattern:/(^[ \t]*)(?:else|for|if|return|unless)[ \t].+/m,lookbehind:!0,inside:{keyword:/^\S+/,rest:r}},"property-declaration":{pattern:/((?:^|\{)([ \t]*))(?:[\w-]|\{[^}\r\n]+\})+(?:\s*:\s*|[ \t]+)(?!\s)[^{\r\n]*(?:;|[^{\r\n,]$(?!(?:\r?\n|\r)(?:\{|\2[ \t])))/m,lookbehind:!0,inside:{property:{pattern:/^[^\s:]+/,inside:{interpolation:r.interpolation}},rest:r}},selector:{pattern:/(^[ \t]*)(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)(?:(?:\r?\n|\r)(?:\1(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)))*(?:,$|\{|(?=(?:\r?\n|\r)(?:\{|\1[ \t])))/m,lookbehind:!0,inside:{interpolation:r.interpolation,comment:r.comment,punctuation:/[{},]/}},func:r.func,string:r.string,comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0,greedy:!0},interpolation:r.interpolation,punctuation:/[{}()\[\];:.]/}}(r),function(e){var t=e.util.clone(e.languages.typescript);e.languages.tsx=e.languages.extend("jsx",t),delete e.languages.tsx.parameter,delete e.languages.tsx["literal-property"];var n=e.languages.tsx.tag;n.pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+n.pattern.source+")",n.pattern.flags),n.lookbehind=!0}(r),r.languages.wasm={comment:[/\(;[\s\S]*?;\)/,{pattern:/;;.*/,greedy:!0}],string:{pattern:/"(?:\\[\s\S]|[^"\\])*"/,greedy:!0},keyword:[{pattern:/\b(?:align|offset)=/,inside:{operator:/=/}},{pattern:/\b(?:(?:f32|f64|i32|i64)(?:\.(?:abs|add|and|ceil|clz|const|convert_[su]\/i(?:32|64)|copysign|ctz|demote\/f64|div(?:_[su])?|eqz?|extend_[su]\/i32|floor|ge(?:_[su])?|gt(?:_[su])?|le(?:_[su])?|load(?:(?:8|16|32)_[su])?|lt(?:_[su])?|max|min|mul|neg?|nearest|or|popcnt|promote\/f32|reinterpret\/[fi](?:32|64)|rem_[su]|rot[lr]|shl|shr_[su]|sqrt|store(?:8|16|32)?|sub|trunc(?:_[su]\/f(?:32|64))?|wrap\/i64|xor))?|memory\.(?:grow|size))\b/,inside:{punctuation:/\./}},/\b(?:anyfunc|block|br(?:_if|_table)?|call(?:_indirect)?|data|drop|elem|else|end|export|func|get_(?:global|local)|global|if|import|local|loop|memory|module|mut|nop|offset|param|result|return|select|set_(?:global|local)|start|table|tee_local|then|type|unreachable)\b/],variable:/\$[\w!#$%&'*+\-./:<=>?@\\^`|~]+/,number:/[+-]?\b(?:\d(?:_?\d)*(?:\.\d(?:_?\d)*)?(?:[eE][+-]?\d(?:_?\d)*)?|0x[\da-fA-F](?:_?[\da-fA-F])*(?:\.[\da-fA-F](?:_?[\da-fA-D])*)?(?:[pP][+-]?\d(?:_?\d)*)?)\b|\binf\b|\bnan(?::0x[\da-fA-F](?:_?[\da-fA-D])*)?\b/,punctuation:/[()]/},t.Z=r},9901:function(e){e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:function(e,t,n){const r=n(9901),o=n(9642),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),a.add(e)}))}i.silent=!1,e.exports=i},6726:function(e,t,n){var r={"./":2885};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=6726},6500:function(e,t,n){var r={"./":2885};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=6500},9642:function(e){"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function u(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var i in o(t,a),l[t]=!0,n[t])l[i]=!0}t(s.require,u),t(s.optional,u),t(s.modify,u)}n[r]=l,a.pop()}}return function(e){var t=n[e];return t||(o(e,r),t=n[e]),t}}function o(e){for(var t in e)return!0;return!1}return function(a,i,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var o in r)if("meta"!=o){var a=r[o];t[o]="string"==typeof a?{title:a}:a}}return t}(a),u=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var o in n={},e){var a=e[o];t(a&&a.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+o+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+o+" because it is a component.");n[t]=o}))}return n[r]||r}}(s);i=i.map(u),l=(l||[]).map(u);var c=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(c[t]=!0,e(t))}))}));for(var f,p=r(s),m=c;o(m);){for(var g in f={},m){var h=s[g];t(h&&h.modify,(function(e){e in d&&(f[e]=!0)}))}for(var v in d)if(!(v in c))for(var b in p(v))if(b in c){f[v]=!0;break}for(var y in m=f)c[y]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,o){var a=o?o.series:void 0,i=o?o.parallel:e,l={},s={};function u(e){if(e in l)return l[e];s[e]=!0;var o,c=[];for(var d in t(e))d in n&&c.push(d);if(0===c.length)o=r(e);else{var f=i(c.map((function(e){var t=u(e);return delete s[e],t})));a?o=a(f,(function(){return r(e)})):r(e)}return l[e]=o}for(var c in n)u(c);var d=[];for(var f in s)d.push(l[f]);return i(d)}(p,c,t,n)}};return w}}();e.exports=t},2703:function(e,t,n){"use strict";var r=n(414);function o(){}function a(){}a.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,a,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:a,resetWarningCache:o};return n.PropTypes=n,n}},5697:function(e,t,n){e.exports=n(2703)()},414:function(e){"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:function(e,t,n){"use strict";var r=n(7294),o=n(7418),a=n(3840);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n