From 070c806b86954d6e0c6b347f91bf20909211fe43 Mon Sep 17 00:00:00 2001 From: "meili-bors[bot]" Date: Mon, 28 Oct 2024 13:55:03 +0000 Subject: [PATCH] deploy: e224f5cbbfd0095e85dad44c394dfae181e1bbb1 --- .nojekyll | 1 + assets/custom.css | 556 +++++++ assets/highlight.css | 134 ++ assets/icons.js | 18 + assets/icons.svg | 1 + assets/main.js | 60 + assets/navigation.js | 1 + assets/search.js | 1 + assets/style.css | 1448 +++++++++++++++++++ classes/EnqueuedTask.html | 7 + classes/Index.html | 344 +++++ classes/MeiliSearch-1.html | 131 ++ classes/MeiliSearchApiError.html | 13 + classes/MeiliSearchError.html | 12 + classes/MeiliSearchRequestError.html | 12 + classes/MeiliSearchTimeOutError.html | 12 + classes/Task.html | 13 + classes/TaskClient.html | 28 + functions/versionErrorHintMessage.html | 1 + hierarchy.html | 1 + index.html | 445 ++++++ interfaces/FetchError.html | 8 + modules.html | 123 ++ types/CancelTasksQuery.html | 1 + types/CategoriesDistribution.html | 1 + types/Config.html | 1 + types/ContentType.html | 1 + types/Crop.html | 1 + types/DeleteTasksQuery.html | 1 + types/Dictionary.html | 1 + types/DisplayedAttributes.html | 1 + types/DistinctAttribute.html | 1 + types/Distribution.html | 1 + types/DocumentOptions.html | 1 + types/DocumentQuery.html | 1 + types/DocumentsDeletionQuery.html | 1 + types/DocumentsIds.html | 1 + types/DocumentsQuery.html | 1 + types/Embedder.html | 1 + types/Embedders.html | 1 + types/EnqueuedTaskObject.html | 1 + types/ErrorStatusCode.html | 1 + types/Facet.html | 1 + types/FacetDistribution.html | 1 + types/FacetHit.html | 1 + types/FacetOrder.html | 1 + types/FacetStat.html | 1 + types/FacetStats.html | 1 + types/Faceting.html | 1 + types/FacetsByIndex.html | 1 + types/FederatedMultiSearchParams.html | 1 + types/FederationDetails.html | 1 + types/FederationOptions.html | 1 + types/FieldDistribution.html | 1 + types/Filter.html | 1 + types/FilterableAttributes.html | 1 + types/Health.html | 1 + types/Highlight.html | 1 + types/Hit.html | 1 + types/Hits.html | 1 + types/HuggingFaceEmbedder.html | 1 + types/HybridSearch.html | 1 + types/IndexObject.html | 1 + types/IndexOptions.html | 1 + types/IndexStats.html | 1 + types/IndexesQuery.html | 1 + types/IndexesResults.html | 1 + types/Key.html | 1 + types/KeyCreation.html | 1 + types/KeyUpdate.html | 1 + types/KeysQuery.html | 1 + types/KeysResults.html | 1 + types/Locale.html | 1 + types/LocalizedAttribute.html | 1 + types/LocalizedAttributes.html | 1 + types/MatchesPosition.html | 1 + types/MatchingStrategies.html | 1 + types/MeiliSearchErrorResponse.html | 1 + types/MergeFacets.html | 1 + types/MultiSearchFederation.html | 1 + types/MultiSearchParams.html | 1 + types/MultiSearchQuery.html | 1 + types/MultiSearchQueryWithFederation.html | 1 + types/MultiSearchResponse.html | 1 + types/MultiSearchResult.html | 1 + types/NonSeparatorTokens.html | 1 + types/OllamaEmbedder.html | 1 + types/OpenAiEmbedder.html | 1 + types/Pagination.html | 1 + types/PaginationSettings.html | 1 + types/ProximityPrecision.html | 1 + types/Query.html | 1 + types/RankingRules.html | 1 + types/RankingScoreDetails.html | 1 + types/RawDocumentAdditionOptions.html | 1 + types/ResourceQuery.html | 1 + types/ResourceResults.html | 1 + types/RestEmbedder.html | 1 + types/SearchCutoffMs.html | 1 + types/SearchForFacetValuesParams.html | 1 + types/SearchForFacetValuesResponse.html | 1 + types/SearchParams.html | 1 + types/SearchRequestGET.html | 1 + types/SearchResponse.html | 1 + types/SearchSimilarDocumentsParams.html | 1 + types/SearchableAttributes.html | 1 + types/SeparatorTokens.html | 1 + types/Settings.html | 1 + types/SortableAttributes.html | 1 + types/Stats.html | 1 + types/StopWords.html | 1 + types/SwapIndexesParams.html | 1 + types/Synonyms.html | 1 + types/TaskObject.html | 1 + types/TaskStatus.html | 1 + types/TaskTypes.html | 1 + types/TasksQuery.html | 1 + types/TasksResults.html | 1 + types/TasksResultsObject.html | 1 + types/TokenIndexRules.html | 1 + types/TokenOptions.html | 1 + types/TokenSearchRules.html | 1 + types/TypoTolerance.html | 1 + types/UpdateDocumentsByFunctionOptions.html | 1 + types/UserProvidedEmbedder.html | 1 + types/Version.html | 1 + types/WaitOptions.html | 1 + variables/ContentTypeEnum.html | 1 + variables/ErrorStatusCode-1.html | 118 ++ variables/MatchingStrategies-1.html | 1 + variables/TaskStatus-1.html | 1 + variables/TaskTypes-1.html | 1 + 132 files changed, 3596 insertions(+) create mode 100644 .nojekyll create mode 100644 assets/custom.css create mode 100644 assets/highlight.css create mode 100644 assets/icons.js create mode 100644 assets/icons.svg create mode 100644 assets/main.js create mode 100644 assets/navigation.js create mode 100644 assets/search.js create mode 100644 assets/style.css create mode 100644 classes/EnqueuedTask.html create mode 100644 classes/Index.html create mode 100644 classes/MeiliSearch-1.html create mode 100644 classes/MeiliSearchApiError.html create mode 100644 classes/MeiliSearchError.html create mode 100644 classes/MeiliSearchRequestError.html create mode 100644 classes/MeiliSearchTimeOutError.html create mode 100644 classes/Task.html create mode 100644 classes/TaskClient.html create mode 100644 functions/versionErrorHintMessage.html create mode 100644 hierarchy.html create mode 100644 index.html create mode 100644 interfaces/FetchError.html create mode 100644 modules.html create mode 100644 types/CancelTasksQuery.html create mode 100644 types/CategoriesDistribution.html create mode 100644 types/Config.html create mode 100644 types/ContentType.html create mode 100644 types/Crop.html create mode 100644 types/DeleteTasksQuery.html create mode 100644 types/Dictionary.html create mode 100644 types/DisplayedAttributes.html create mode 100644 types/DistinctAttribute.html create mode 100644 types/Distribution.html create mode 100644 types/DocumentOptions.html create mode 100644 types/DocumentQuery.html create mode 100644 types/DocumentsDeletionQuery.html create mode 100644 types/DocumentsIds.html create mode 100644 types/DocumentsQuery.html create mode 100644 types/Embedder.html create mode 100644 types/Embedders.html create mode 100644 types/EnqueuedTaskObject.html create mode 100644 types/ErrorStatusCode.html create mode 100644 types/Facet.html create mode 100644 types/FacetDistribution.html create mode 100644 types/FacetHit.html create mode 100644 types/FacetOrder.html create mode 100644 types/FacetStat.html create mode 100644 types/FacetStats.html create mode 100644 types/Faceting.html create mode 100644 types/FacetsByIndex.html create mode 100644 types/FederatedMultiSearchParams.html create mode 100644 types/FederationDetails.html create mode 100644 types/FederationOptions.html create mode 100644 types/FieldDistribution.html create mode 100644 types/Filter.html create mode 100644 types/FilterableAttributes.html create mode 100644 types/Health.html create mode 100644 types/Highlight.html create mode 100644 types/Hit.html create mode 100644 types/Hits.html create mode 100644 types/HuggingFaceEmbedder.html create mode 100644 types/HybridSearch.html create mode 100644 types/IndexObject.html create mode 100644 types/IndexOptions.html create mode 100644 types/IndexStats.html create mode 100644 types/IndexesQuery.html create mode 100644 types/IndexesResults.html create mode 100644 types/Key.html create mode 100644 types/KeyCreation.html create mode 100644 types/KeyUpdate.html create mode 100644 types/KeysQuery.html create mode 100644 types/KeysResults.html create mode 100644 types/Locale.html create mode 100644 types/LocalizedAttribute.html create mode 100644 types/LocalizedAttributes.html create mode 100644 types/MatchesPosition.html create mode 100644 types/MatchingStrategies.html create mode 100644 types/MeiliSearchErrorResponse.html create mode 100644 types/MergeFacets.html create mode 100644 types/MultiSearchFederation.html create mode 100644 types/MultiSearchParams.html create mode 100644 types/MultiSearchQuery.html create mode 100644 types/MultiSearchQueryWithFederation.html create mode 100644 types/MultiSearchResponse.html create mode 100644 types/MultiSearchResult.html create mode 100644 types/NonSeparatorTokens.html create mode 100644 types/OllamaEmbedder.html create mode 100644 types/OpenAiEmbedder.html create mode 100644 types/Pagination.html create mode 100644 types/PaginationSettings.html create mode 100644 types/ProximityPrecision.html create mode 100644 types/Query.html create mode 100644 types/RankingRules.html create mode 100644 types/RankingScoreDetails.html create mode 100644 types/RawDocumentAdditionOptions.html create mode 100644 types/ResourceQuery.html create mode 100644 types/ResourceResults.html create mode 100644 types/RestEmbedder.html create mode 100644 types/SearchCutoffMs.html create mode 100644 types/SearchForFacetValuesParams.html create mode 100644 types/SearchForFacetValuesResponse.html create mode 100644 types/SearchParams.html create mode 100644 types/SearchRequestGET.html create mode 100644 types/SearchResponse.html create mode 100644 types/SearchSimilarDocumentsParams.html create mode 100644 types/SearchableAttributes.html create mode 100644 types/SeparatorTokens.html create mode 100644 types/Settings.html create mode 100644 types/SortableAttributes.html create mode 100644 types/Stats.html create mode 100644 types/StopWords.html create mode 100644 types/SwapIndexesParams.html create mode 100644 types/Synonyms.html create mode 100644 types/TaskObject.html create mode 100644 types/TaskStatus.html create mode 100644 types/TaskTypes.html create mode 100644 types/TasksQuery.html create mode 100644 types/TasksResults.html create mode 100644 types/TasksResultsObject.html create mode 100644 types/TokenIndexRules.html create mode 100644 types/TokenOptions.html create mode 100644 types/TokenSearchRules.html create mode 100644 types/TypoTolerance.html create mode 100644 types/UpdateDocumentsByFunctionOptions.html create mode 100644 types/UserProvidedEmbedder.html create mode 100644 types/Version.html create mode 100644 types/WaitOptions.html create mode 100644 variables/ContentTypeEnum.html create mode 100644 variables/ErrorStatusCode-1.html create mode 100644 variables/MatchingStrategies-1.html create mode 100644 variables/TaskStatus-1.html create mode 100644 variables/TaskTypes-1.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/custom.css b/assets/custom.css new file mode 100644 index 000000000..2b190e6de --- /dev/null +++ b/assets/custom.css @@ -0,0 +1,556 @@ +:root { + --font-family-code: "JetBrains Mono", Menlo, Consolas, Monaco, Liberation Mono, + Lucida Console, monospace; + --font-family-system: Inter, Roboto, "Helvetica Neue", "Arial Nova", + "Nimbus Sans", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", + "Segoe UI Symbol"; + --shadow-overlay: 0px 10px 15px rgba(32, 37, 46, 0.15), + 0px 3px 5px rgba(23, 26, 33, 0.21); +} + +body { + font-size: 15px; + font-family: var(--font-family-system); +} + +:root { + --color-active-menu-item: linear-gradient( + 90deg, + hsla(0, 0%, 100%, 0.08), + hsla(0, 0%, 100%, 0.039) + ); + + --color-title: #ff5caa; + --color-text: white; + --color-icon-background: #0006; + + --color-ts-project: #2548b6; + + --color-ts-enum: #0585ae; + --color-ts-enum-background: transparent; + + --color-ts-namespace: #1305ae; + --color-ts-namespace-background: transparent; + + --color-ts-variable: #78059e; + --color-ts-variable-background: transparent; + + --color-ts-type-parameter: #51e1d3; + --color-ts-type-keyword: #ff7b72; + + --color-ts-function: #6639ba; + --color-ts-function-background: transparent; + + --color-ts-class: #f8c555; + --color-ts-class-background: transparent; + + --color-ts-interface: #0483cc; + --color-ts-interface-background: transparent; + + --color-ts-type-alias: #ae05a7; + --color-ts-type-alias-background: transparent; + + --color-accent: #6639ba; + --code-background: linear-gradient( + 90deg, + hsla(0, 0%, 100%, 0.08), + hsla(0, 0%, 100%, 0.039) + ); + --color-background: linear-gradient( + 180deg, + #14002d -5px, + #1c0040 1000px, + #0e0021 + ); + --color-background-secondary: linear-gradient( + 150.53deg, + rgba(255, 92, 178, 0.25) -2px, + rgba(107, 86, 220, 0.073) 300px, + rgba(20, 0, 45, 0) 800px + ), + linear-gradient(180deg, #14002d -5px, #1c0040 1000px, #0e0021); + --color-background-nav-mobile: #1c0040; + + /* Highlight Colors */ + --hl-0: #d2a8ff; + --hl-1: #ff7b72; + --hl-2: #51e1d3; + --hl-3: #ff7b72; + --hl-4: #f8c555; + --hl-5: #ff7b72; + --hl-6: #d2a8ff; + + --color-text-aside: rgb(255, 92, 178); + --color-link: rgb(255, 92, 178); + --color-separator: transparent; + --color-background-search-results: linear-gradient( + 150.53deg, + rgba(255, 92, 178, 0.25) -0.45%, + rgba(107, 86, 220, 0.073) 13.45%, + rgba(20, 0, 45, 0) 30.7% + ), + linear-gradient(180deg, #1d0042 -0.71%, #1d0042 81.38%, #1c0040); + + --primary-bg-color-transparent: #f7f9fad9; +} + +*::selection { + background: var(--color-accent); + color: white; +} + +pre { + border: none; + padding: 0; +} + +pre + pre { + margin-top: 0.5rem; +} + +pre code { + display: block; + padding: 1rem; +} + +pre > button { + border-radius: 4px; + border: none; + background: var(--color-background); + padding: 4px 8px; + cursor: pointer; +} + +hr { + display: block; + height: 1px; + border: 0; + border-top: 1px solid var(--color-separator); + margin: 1em 0; + padding: 0; +} + +*::-webkit-scrollbar { + display: none; +} + +h4 { + margin: 1.2rem 0; +} + +.container { + --color-background: var(--color-background-nav-mobile); + background: var(--color-background); +} + +@media screen and (max-width: 769px) { + .container { + background: var(--color-background); + } +} + +.container-main { + min-height: calc(100vh - 4rem); +} + +@media (min-width: 770px) { + #docs-header { + height: 61px; + background: var(--primary-bg-color-transparent); + } +} + +@media (max-width: 480px) { + #docs-header { + height: 95px; + } +} + +.container-main .col-content { + padding: 0 2rem; + margin-top: 2rem; +} + +@media (min-width: 770px) { + .container-main { + margin: 0; + } +} + +a.tsd-index-link { + font-size: 0.9rem; +} + +.tsd-navigation { + font-size: 14px; + padding-top: 1rem; +} + +.tsd-nested-navigation { + margin-left: 0; +} + +.tsd-index-content > :not(:first-child) { + padding: 0 1rem; +} + +/* Hide visibility selector and themer */ +.tsd-theme-toggle { + display: none; +} + +.tsd-navigation .tsd-kind-icon { + height: 1.5rem; + width: 1.5rem; + min-height: 20px; + min-width: 20px; + margin-right: 0.4rem; +} + +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: block; +} + +.container .site-menu { + height: 100%; + border-right: 1px solid var(--color-separator); + overflow: auto; +} + +.container .site-menu > div { + height: 100%; +} + +@media (min-width: 770px) and (max-width: 1399px) { + .site-menu { + margin-top: 0; + } +} + +.page-menu { + border-left: 1px solid var(--color-separator); + background-image: var(--sidebar-background); +} + +.tsd-signature, +.tsd-kind-parameter, +.tsd-kind-property, +.tsd-parameter h5, +.tsd-signature-type, +.tsd-signature-symbol, +code, +pre { + font-family: var(--font-family-code); +} + +.tsd-kind-icon ~ span { + font-family: var(--font-family-system); +} + +#tsd-search .results span.parent { + color: var(--color-text); +} + +.tsd-navigation .tsd-accordion-summary, +.tsd-accordion-summary > * { + display: flex; + align-items: center; +} + +.tsd-signatures .tsd-signature, +.tsd-signature { + border: none; + border-radius: 10px; + background: var(--code-background); +} + +.tsd-signature { + padding: 1rem; +} + +.tsd-signature-keyword { + color: var(--color-ts-type-keyword); +} + +.tsd-signature-type { + color: var(--color-ts-type-parameter); +} + +.tsd-signature-type.tsd-kind-class { + color: var(--color-ts-class); +} + +.tsd-signature-type.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +.tsd-signature-type.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} + +.tsd-signature-type.tsd-kind-type-interface { + color: var(--color-ts-interface); +} + +.tsd-signature-type.tsd-kind-type-enum { + color: var(--color-ts-enum); +} + +a.tsd-signature-type { + text-decoration: underline; + text-decoration-thickness: from-font; + font-style: normal; +} + +a.tsd-signature-type:hover { + text-decoration: none; +} + +.tsd-returns-title, +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5, +.tsd-parameters h5 { + font-size: 0.9rem; +} + +.tsd-parameters h5 { + margin: 0.5rem 0; +} + +.tsd-accordion-details { + margin: 0 1rem; +} + +.tsd-accordion-details .tsd-index-heading { + display: flex; + align-items: center; + text-transform: uppercase; + font-size: 0.9rem; + letter-spacing: 0.3px; +} + +.tsd-index-heading svg { + margin-right: 5px; +} + +ul.tsd-hierarchy li { + margin-top: 0.4rem; +} + +.tsd-panel.tsd-member { + margin-bottom: 2rem; +} + +.tsd-panel h4 { + font-weight: 600; +} + +.tsd-panel-group { + margin: 2.5rem 0; +} + +code.tsd-tag { + border: none; + margin-bottom: -5px; + font-size: 75%; +} + +.site-menu .tsd-navigation { + overflow-y: auto; + height: calc(100% - 65px); +} + +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; +} + +#tsd-search { + position: sticky; + top: 0; + z-index: 1; +} + +@media (min-width: 770px) { + #tsd-search { + padding: 1rem 1rem 1rem 0; + } +} + +#tsd-search.has-focus { + background: none; +} + +#tsd-search input { + box-shadow: none; + font-size: var(--font-size-regular); + border: 1.5px solid var(--separator-color); + font-weight: 400; + cursor: text; + padding: 0.4rem 1rem; + width: 100%; +} + +#tsd-search .results li:nth-child(even), +#tsd-search .results li { + font-size: 0.8rem; + background-color: unset; + padding: 0.1rem 0.4rem; +} + +#tsd-search .results li a { + color: inherit; + text-decoration: none; +} + +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background: var(--color-separator); +} + +#tsd-search .results li:not(:last-of-type) { + border-bottom: 0.5px solid var(--color-separator); +} + +#tsd-search .results li:not(:last-of-type) { + border-bottom: 0.5px solid var(--color-separator); +} + +#tsd-search .results { + max-width: 800px; + overflow: hidden; + background: var(--color-background-search-results); + top: 50px; + padding: 1rem; + border-radius: 8px; +} + +@media (min-width: 770px) { + #tsd-search .results { + min-width: 380px; + } +} + +#tsd-search .results .no-results { + padding: 1rem; +} + +.tsd-page-navigation { + font-size: 14px; +} + +.tsd-page-navigation h3 { + margin-bottom: 1rem; +} + +.tsd-internal-warning-banner { + border-radius: 10px; + background: var(--code-background); + margin-bottom: 1rem; + padding: 1rem; +} + +#tsd-search { + transition: background-color 0.1s; +} + +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.1s; +} + +#tsd-search .title { + top: 0; + color: var(--color-title); +} + +@media screen and (min-width: 770px) { + #tsd-search .title { + top: -15px; + } +} + +#tsd-search input:focus { + border: 1.5px solid var(--selected-stroke-color); +} + +.tsd-navigation a.current { + font-weight: 600; + border-radius: 5px; +} + +.tsd-page-toolbar { + background: var(--color-background-secondary); + backdrop-filter: blur(10px); + transition: transform 0.1s ease-in-out; + border-bottom: 1px solid white; +} + +#tsd-search-field { + font-family: var(--font-family-code); + font-size: 1rem; +} + +/* Remove nested padding */ +ul > li:only-child > ul:only-child { + padding: 0; +} + +.tsd-page-navigation ul { + padding-left: 1rem; +} + +.tsd-kind-icon-custom { + background: #ecdceb; + padding: 0 5px; + border-radius: 3px; + font-family: var(--font-family-code); + font-weight: bold; + color: #9f0499; + line-height: 1.4; + margin-right: 2px; +} + +[id^="icon-"] rect { + rx: 8px; +} + +[id^="icon-"] path { + stroke-width: 0.5px; +} + +#icon-chevronDown path { + fill: #4b4e5c; + stroke: white; + stroke-width: 1.5px; +} + +.tsd-breadcrumb { + font-family: var(--font-family-code); + font-size: 14px; +} + +.tsd-breadcrumb li:after { + color: white; +} + +.container { + padding: 0 1rem; +} + +@media (min-width: 770px) { + .tsd-filter-visibility { + padding-left: 1.5rem; + } +} + +#icon-chevronDown path { + fill: #fff; + stroke: none; + stroke-width: 1.5px; +} diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 000000000..e09ba8e92 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,134 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #800000; + --dark-hl-7: #808080; + --light-hl-8: #800000; + --dark-hl-8: #569CD6; + --light-hl-9: #000000FF; + --dark-hl-9: #D4D4D4; + --light-hl-10: #E50000; + --dark-hl-10: #9CDCFE; + --light-hl-11: #0000FF; + --dark-hl-11: #CE9178; + --light-hl-12: #008000; + --dark-hl-12: #6A9955; + --light-hl-13: #098658; + --dark-hl-13: #B5CEA8; + --light-hl-14: #0451A5; + --dark-hl-14: #9CDCFE; + --light-hl-15: #267F99; + --dark-hl-15: #4EC9B0; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +.hl-14 { color: var(--hl-14); } +.hl-15 { color: var(--hl-15); } +pre, code { background: var(--code-background); } diff --git a/assets/icons.js b/assets/icons.js new file mode 100644 index 000000000..e88e8ca77 --- /dev/null +++ b/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `""`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/assets/icons.svg b/assets/icons.svg new file mode 100644 index 000000000..e371b8b5d --- /dev/null +++ b/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 000000000..21a5d74d2 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; +"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 000000000..680a8f64d --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52a23LbNhCGX6Wj3rp17Dhp4jvHhzqTunYl1b7I+AImVxRqCGAA0LHa6bt3SEkkSCy4q97i//fD+UCAX/+ZeHj1k9PJFBZgQWfgJgeTbClVbkFPTr+2hhwWolJ+cjAphV9OTicrk1cK3M9Lv1I/duqz1Pnk9OTo48nbNyf/HrTxNyCVdCBstkww+o4+5zEgnSvhXLKcl/pbBRXkc+Geu4yyTcxhqDa5tjkdHX8I8visc3iNw5vksbimDrNBLXfRgfjTEZNyVspLa40dpe1MTCYN3Ic2hW8VOE9DQyOTPZcruK0Y7NA4xsZHBTUaav1cSdAej91oMeGxN6I82IVIT7Ar8FHXyDbosJP7+Ry/e9/LZ74u4YczJUV6ipwLnYGqC+7+qMCuu/z8ugR3ONQHGb75+MvRu+NwQgoPhbES3IV03sqnykujYyrmItlGL2QRsZpURqwH7esWQQA7iaRYU0bh1pRU3AUo8JBu5aFO8mRWN5hASK1CM1ypxBryM7/pgWaMDGCRhUH1Ume+jUCYfQOHmBpH+4yeC5NVK9D+tqzdcV37MpeGd2cockmuGQTS6FFk38Vmf86TFa41Nme8bKwyXa6eIM/BDim7dG58VKFWIAnBxn/79BdkPkJFDpJZr8YzL3zlzk0ejfqBTNGuRAZRoZpEVuTYlIkMLOK1xItzLXklkjpat3fprPhbi4yYTmEx3Kf14CgXYHYii1R3JEqpBTYhGsCdQjIgBys85DeV8ttjz52wYhUzk05mHtLoC/BCqhS6M/CJiTU4MpBECSofHe1DA01UHhlpTSovVjwpSG+pmIfiXoNQfjkkbVLJWFkslSyW0XhtBZqAxHKiorrXaWRcVRRSF/VUSG0UiIWkrp+szIffYltcoFGcZokAfBcMNSZnCq5ScTv1VRYL38YCiUfBp2WosTjo6tYpFOMLRI37Bcg2/QLrcwsCWwUCiUHBu7cVOIRExwYSg/JnmYv4/NwKFOE3kwkVhW9SWbHy7+Dgj3J6jv2ZUfsgFop6I3y2BHdnnMR6fiCzaFIXM1/vmYWMixg7SObgKmUKrjTaRS2a8tF8W8DmDBMjW4mkdMeDbheOeJhpDzJ+RNn7ZBIEoFN1qO/Le5Ce1wiIe4+8kgMhtuxH7V3NYsxKkfvB70bPoBRWeGPn5hniXSF2UMxbpcRKpLb1vkqyStBnMsnqqRTrThRSo33dKXzGDHz9WRO1V+wgmda8ypX06zsLmXRY+SIHxUQnDGuWTIV+lrqY1pf0Q0CoMTmzzFhIfFkgFpr6fXcNcZbncuQjI+0k8wBnKpsB2oY9kUtKnBMGMoPmUzMh1CjOZn0Y/37BPDzueeXNYnGTIO5UHuvK2GZbuxeqAodvK2nn/8kjtViPeXn5jJV+n/Jun1R+vZzjrE7n8sZqvF8dZ3IllbDtReFYnXEvnc/oZrXnTpVaw7kr98xYT8yjyEEysY8q1vfUzJvywdj4CrgVSMJ3UW6/ShNdNzSQxLU2eo2AtulUfPruln9nm36P4b/ENM7EMh5q+3DS9eo7OMzNnTPG2igcRv0yhiIagSTUM64ZG+jRYSCzaImdPdRYnO1SlixWoJO8dWnmRoGt30sjWChSpM3Xfbv8fVpfVTobOc9QfjI/B/bOmheZQ546RWAeinsPFjuybpOp6AchUy91gYRTwifwe2Flvc4m37+7x99LXa26vF52gYcDSz/Pt2Ghk49AHWxgGf770cON3UZ0xNg1CsUWhQ7WqSRksCr0GY2IIMKu2Y3TVNe8bEZK02LXUvsbcE4UQasudoDDhLWf/fv616HH/wBTPzfm5yQAAA==" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..699780a20 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8Wd3XIbOZK270Vz6tUKvyT7TG3L3YqxLY8kz2xvxwSDlkpSrSlSTVJuayb23r8ogEUCiRdVWcXSt0ftFoFEFpD4yycB/PtotfxzffTT7/8++lYubo9+EnL85mgxeyyOfjr6WJTz8qqYrW4ejt4cPa/mRz8d3cxn63Wx/s/gt/8Qxw+bx/nRm/rHo5+Ojv73TS3RCLmTeLNcrDer55vNcsWQ+Jc4eSD9zdHTbFUsNkTJfaHiROpdqZvlt2Kx5hS4S9mlLHmi93V2XyyK1WxTXBeL2WJzXcnjFIyz9f7im+XirrxnVrFPuS9rs779j3L9H+XioViVm+K2Y9kPm83TZfHHc7HecBSIkw+mxWa2/sZr8m3CQ0qOLKBc3BY/OCXXCQcr+b7YnHMLD9IOWf7l7M8uKgTJB6+FgtX8UerXqAm2GlGGwTS5WRWzTcFukzj5YFo8P9120SJOPpgWt8W86KBFnPw1tDi/O/tRrjcsC8HZBtNq/efsqYO9xskH0+Lxeb7hrzj+Eicfsvdec6ePIO3Q5XcofsjS/5yVm/fLFbsGSPrX0KOjGoOOn7PFTTFnV0acfOAxg61FnHxIu/xr8cLtFtukA5fOL3z4WZRZfJh44BmUqUGYeGAbZGoQJh5Mg4diNt+wJoZdyuFW9etfnUzW14eJh7T/q82Mt1gI0g5Z/t+L1bpcMje0QeqB++G758cnfkfcph5Yh6vF7Gn9sGRtcZMch+iixUSrk/1G16Vax0umx+Xt87xY+9LjBNBFI08mI2H2bpq3sftg8/JUrP/T/7HR1WONUXYnZTqtMual/GWXAPs5tlrk3AzLwL+Qk328TdVUwPFWjUw5s6cyHPOyJe3SHVDWzbwsFpvT+2IRdPNsiST1AeWuvP+lrdnrgmnyA0quvD9v3Xcw2jJM263MXoYZFLiV+B+CV3Koas4/VT4Wy2fGV+8Tdvtk2qc/z+7LxWwTDt++zP0Ph/ZtIqmtfwcaZSppeXe3Lmgd4VKOd2nbCmuxyHn5WDKLrJN2L5E2zmWxXj6vboq/PRcrOtZEvzU2UU7qZbF+nicjCvm1k2S39b94qj6Oig1/OtSgElltJhXplWngp1X5OFu9pIN6rrTjKEd7we3N7VN//Z/ihlpa8MswlbcXxas7r1Sm6p7LW14hxz5la0EtfbGlqdJi2S3FKd0v225P29poNx8H6Q8t2+/g+GWH6XuUDQ20WKPhKPyp+5hRrPFgFP/YKFftRX6cbW4eysX91aZiZ/dl4Lv8PluVs6/zakGeJGoBlo19iyG3raMBrTNWcPrhQ4+Cj302buEtlvjh9Oq6jxLbfANp8f7y7G9fzj69/a2PKmHm/vpQe24wPm/TQGiX/vK+nG+KFZHp/9hJDurE7b2XMcHshbRZvFch07R/tIk9/qNZcHtT/VreP8zL+wc6mu7+fmhVxILaqmOvTm7Pudmsyq/Pm2J9veTpvtuFZnK2KNK2S6vTfV4V1zO6Q8SapHmG0mG53nRXYpepsxaJc2S1fCKFV3862DFSy2h1i1TlMwynSU9kLtv0+UJbl0vLpw/F4j7w0GZKjVIeVN7H2epbMkbC8nYpu5RHm947494vV+9nN8Xm77P5c7H+PFvNHunQn0/YbQqocv+abEfrPx9qcpGcNrPb6ZJpju/VRzIKOK4TNhfT1vjL58RlBEurE3YtjdP0l8X6ablY069uSnpok7XKbmvGxu/IVPbdtpY4Vo6UOQ4FdFerxRSccLTI6aZeLWFw/Z5Wy5tivS4X99flY/GxdyUCOUPomqyVXr6uylsSg7GdY4OfDl4xUVmti6ZQr0xVF49fi9vbZELIlXUcpG8vtKWZ18XjbLEpby4rlx9XAZqpjxa0AT8sb2ZzWt3+j50mH19ew/TWY0LzGbfhnr+cXUO5+587yf5YrO4LZ/LJRmz/y6FmS0W17vUDpTKG8zj7sV0gFL7H8oo8RvlalWg3n/fFbRWJXC4X2L+b/H7wKgQKbF2OJGpmqvfPAmyeGss83mVhFs3wFewD1fa5aTujNAfba1Zoq+VClTtAk9aiW/gJzt88CENg1K5ICzvqo4lbU6x/fomjTbkK0dzD6fWYHyVbtYrzHqRTQwdBSzn6c7eJgWT+R7lh9UKQuG+5cBZNfh+wswcCO3T0rZo5R91zsQJezqZCj/d5mIWzJ6jitq1+8wkHmrJykplzF/qC3GiSM1eeJsdR/q5KtYwo2CyYirXZRxetEkdd5XVfVuLflWvv50orECc62JmXl9rq3sNatziJkCuku6upoZ6S37sNhRUKKdafl+sSjbnxr91iHGaLbxVjuVmuinfFZlbOkziHNMWhzZsT2da2SNncsnW5uuV+yW7dus3DLrxXoBRLizpgyvRQZ/sduSXeKt3gd1Pp2In4D91btbYl1pb7/aNvE+41paJeSd8fH4dUOZH2Klqvq3yHqepEvJ4dbF6eqCOoTcFtlv/bDlwpUVdSr8pxXzFg940U2vZe1VcxRqO9BXChm46hlNfQ8nH243oQRYmg19C1T0eNlfT99LVa/Gm1/FE5IpK4yxYdw3z/tx12p0ldZb2qav89A3bdVLVt/5UHqfgKJgc09Xb3qpruAHxHbcN8/7fGt9OkPUa+ob723zOg8aWqHddi+ivIbdD1dOWlTQdSvUHy/4+vqXbqL9Nq3fMKHwSEv9o39RkcgPa1mFfTs/gxu9ksinXX9XiY7/92aNhpUtdar6F0/z0DDg2patt5qdfoRaU17gyvh6jI41DUq+nbp6sAXf08OnTN5sEl9gMlvw8HLrv4gFI1M5Xvrgf6kpy4aCz1OMjELJ7n3c147pqVSfMOo5Pns8VtaDedFMsI6K1dGm+cRut2c8eCaKvqT91dutUxcOTKrf4+SPzgThArgNCpkxsdS+h0pgUc+3QthbRvoHllzfL4taGsbFMkg9Luh+5Nm6HL0W+9onMaohpZcYwNINQf8MkjRP/7AdKR6iDFgKi1U/glUjZjoit4UKql4ON9LrYCDPMti/ltExyivx88skCBrSNMomabrV+Vj+V8tnq3vHl+rI7RN0S74aTDxPM2yObF82a+I7eyoGsKrhbHDQuLRhnNgzGM2mHr1BK8c4BeKKqJrVZzcNMBWt2hc2FstXa5B9crE3zL1qw1GPcA3cJzLpfFZlUW3/v2xOOMrMF1Xj8s/2xY4bL1BXJeXVe8A+ut8l7c4JqvgmKuH1bF+mE57z085oQNoTWdwOoMOEqX/HroNIXEtc1MVMEsfsmc8W8ok3POn2ZPKjQ4R/52udgUi03lTjlbPD+CM8YkRacFapCXhgntf+kY9PJn/Xmnt7dlPlg7n7BTeTvjRLGZ8Y+95DaJHeSociqMa72NR5fvqgVnruul55h3yRlF8geA9bvqrr1yuWhsnCjRUNUJpHLrlWjdZa3TXnrbKicjgV/l59lWr37q1Ae+uJs7dtl/fnn/vLjJ9+i25Ic2LUt+WyO3flOuubfJDtDpOJDRT7k+y+9uGjYb54H63VRzyg+6bemk4F7EUBriuy2qqfV0t5pOXABpkm6TS7nelIubzWkGsSe/9/CVNX4BStKtjOVq01xCkqBrDT3NZy/VtUGZAkCKPtG5l9VtlJgjXe4uqmTXymb5hOIUd3/vJu1lsVy8pD6f7Z87yaoiqa6X82JVXQJNBEa/dbS0p9lqtlmuruNnTGoji37tJPnTctEsPE3Q0b7cqDBLVyW7HzrJ+1wH1XxeFTflGlxlmCToPGJkPJxDOjc7+zUzLk1yrmvWqvP+HNcsPz1GuVp2/eX944xbaJ24T6m0oS6eisVpeYYdTvGPhzYWkNbWXES7XOW5yxfZpR3v0nMKbaNfy9tizi+6Tj5AyfA23YaiW27V7VT27XbBcl08Ps1nyXqgQQuQcwh9ysdisQZr/CZNwjyD6JAd8hq1iHINoEdVMLt4n/gVLOLj7MfPL+kqqINlBBIG0O9rWc2Rf3uu7oj4V0Hdkg1qpRn7aZOEJTzf35eL+woxZ0ZfkOLQITgnsvXGEKBsl8G4pdy2ERll7z4stynRPDZ312FVfEcrqzY1gmxDadIyXLdpxB6ze2iWHzRbteKMnIfXVWYg61pnraNZd02bh7Q2BbnjGkuvxBO3LlafV8vv5W1xmxndUJKDPW45ma1eNqRvlwGureS2EQ7m77nmadWFsfLppU+2KzM0YvTlHjo1d5FWtbh9hKcZuFN+k+kc4U8Hn7CmslqPVod6dekEuZLajD/K13Vxmy20aWnboUS4zcoW2rLJ6lButntny2Z06y7lN68Z8lpwFwud6iI7tDTUBmNI6aDDirzD21L8CrzD27tkGIrZUPQu/cFlPxSz22LFNsF98sHtL7MOY9th6wKsg27N00pWJe500qxJ4sGbz2ePs5wHL/rxYA9eKq3Vgxdr18mDly2t1YMX5+zsL8kX3Ogv6VIq9t7lC27z3nUpG/os80W3+Cy7lNzmN8wrwfcbdtKnwWfXoAvLZ9dNj5z/skmLdv/lIW2T8+Dx26jdg9dFvxYPXl4ttgevRRs68GaGXNZgm5NFa3v39+5nWi7AWc79D93llQv6UED950EOP9VyWGefKl3yx5Ea74BFhXW4AHaXvYXnLVeb4M7on+lID7VAmbpqkX+r7qrYVFmohaUJDm3OjMS2hgWa5pv4ermZzcHJvuayj0lOriLt1ewDVN4+b5Z3d5l7yesfO/U8d9l0NWrlQm/SBIc2X0ZiW/MBTdtOEHyebTbFKpnzmhU4Rtm5KrWdUnFXe3fUZ5+pvxbtzd6uVNfrw+FoMNQY0Knnt/X3u/YQN9jbM/malWCsGJtC4aAiKNNBWqxbw9mQGjDXYXpwQveQJjjfoS3TEoKXaxuQ7SBNVvlQPagCSX9Yi+RC+mAzBIkPKzUT+gcL3ac9qMxNQ4ggLJhmOKj0O7wkxuPQPu1BZT7l3h2GpUapD+zlzWGTsIPTLAdpsGgLr4RKwFwHjjGZMMzM0BKkPqzl28I1sQWgXAfpUWS2qbD4MPEAs0x2cZ2dX4IcB5U/b12NQSVwtq6aBGfrrmfrb9UFF8/obdb9j8O8yZrIa1vFBdpl6vH69Oqv06svb9+enb07e9ehzOMkZ5sKLS3q5H2+vHh7dnV1/umXzqpEWYfQ5f3p+YceVbLLNoQOZ5/+9uXsSw8tgoxD6PH29NPbsz61EWTsrkdyAiHtbL6vB0Kauhnpt9XB1Fy3db8N12tDcZxO61XLtMi7i7dfPp59ur6anr57d359fvFpenE5/fL53en1Gb/84xYxLcq1WE0tfPru7MNZJbuHYmHeA7X58vHz9O3l2WlXTUi+w7Q4//Tu7L/6qJFkHEKPHg2TZBxAj7Or6dU/Tj931WKfbYi66Nx3SLbDdLg6u74+//TLVXc10pwHavLp9PPVrxfXfYwU5T1Mm2AC6aoMyDqALj26DM3XWQs0B8YT134K9CI6nembrb/Baw/2PxzqdiSSOLPfuvHUfH0JJKqBtKDjMHlbkW1hCexCnwcpb5NpZ1BgnfTAEtduEcUtNEh9YLk3lf9nXtwmUC5TcpT+wLK/FnfLVXG2+OO5eK42hjwNQK4D9ZjdbYpVVzXSTIPUxtVmttp0rYww0xB10VGJJM8gNfG+XJTrh65VEeUaoi66qpFmOlALdFtcpuzmu+HYJd6tlo+8Arcpu5eXvqlWDSvZSZH+3O34dXUZS5GVTX/uFqqyHQCq7Bdf/6e4oS2VJjh0Ws9IbJvegaa5yW+2/pbeD91c7PE+E7f4FiPMXFPdokbrPdWd9Vgjt0eLFrs8A+nQ2QqOO5pCm6c7Nze2aFG0T4+ddckuWFp0YSxcOLqgdTzs+MwOn4Qi/Dl7cjcsF5lLY+nv3Xcdl/AC4PCn3jKzNREn6CT/H7Mycxlh8MuhgyoV1TaahkrlOm35WFw8bxJGkynqOEzfWmjr4LkpVt9nc3bhUYYepScHuovZfPNAT2G6Px7aVIGU1pPaXosuI3sqvW003+ZorRLXa9Fd7fsfDq0aIqmtegKNcqj5+fFrsbq4293JxSrwGGVrU6HNotcuaRpkkFEhSn9g2Xct15RnVEDZumuSXlOVWtAgxsO3m0aTuZ1tZl9n6+Kq/FdrCcckcUNxbZuk2Xrjr49rLTNK2r/E0k/CrcXt03Uqq0+D1WVtpTW8jBMWutMwb3Pp4Zy/Fge7J2sRbdZWFZ53CzYLPX5u2ApUaVsiXIr1zap8Al2elhOn7Fue+09zQdskfUv4lm3JuoBvDQer2uXPbtBCjZaxT9W3HNz7aDltfa+9nOLHU7kq1snGh5YUputb1s2qmCGvGy0rTNe3rGc3ALaXFabrUBYYQN5WWsOOVP8ywIASiWIMLDulugwwqJC2gWaXp88AAAtsGwiYJTYOcbBg5lDHLD87YMCyGQMHs9zsAALLZQwkzHIbBhRYMmtgyZcNOiJcJu3+PkAnDAQxuuBWnU4dIi2htTtssxzQGUChzK6QKxs0DvRQ7/7eyW9S5cKunuCXThL/XqxAtO32r4caTiimzWxqRXIT6fLxsdxcPdA7REERx2HaxsLaJm8n513as/KFvmvagvBKffp2394ouwjoMHHHUqXZN9/7YnPzcLZaLfcHap37qIrsr15IrH9ttIi8fzsv6y+NRhGolRt7V6vFklNOnbBvQTfLW9b3bNN1KCZ5pK4o59tn11zS3Et1mWSHdtpGuW29OKt7plYfi/V6dt9HheN91m6qtHb6217qNLZ7T116tk4zKeqpy7xcfOujyzbfoboE0cYupQ9Qfhs21j5+jKQYJvIYC21FtERZVjRrPlq+UYnjnBSWai3t//HcHQeYboM1z7trhyQMoZmXd/rh8uz03W/Ts/86v7q+6ll1iZDh9Pt0cT19f/HlU99WDfMPo9XfTz+cvzugPZGEYevr9K07hPLzBxTGy620SMjwNXfx/v3V2fWBlbcTMrx+H84/nh+qXi1jSO2urnF0Nk+vOvcQGn2+PP94evnb9K9nv03PP70/uzz79Pas7xDcImy4/hEWNMjY1yhweLsMijvQOmNJQ2i6P8zz/vzsw7sr3wGml2enb3/tYROt4oacn3fnfQ6YoWMZQ7b9IdphGUNq9/bi03Ul+Pq3z/2HJiJkyLY9SL+MkFdpXW/nh7fwTs6raHnY1JiIeRUdD1xepHJeqb0/XJ9dDtHeWzmvMiL21DIv51Xq8u9nb68vLrdzxeFVSsUNsmI6/e3Dxem76fXFxfTD6eUv3QcjJGHINt/K793W+/yDaHX64f3F5cezd/31AhKG0OzTxfTq8+nbs+mHs/fX04tP03dnfz9/270983KG3TNcXJ5V3e+QjUMgYkjdLk8//bWynMsvH876z3xUyqAanv3ty9lV/7lkn/9Vxr1fzi6GGvNCUYPa39np5dtfp3/rb317Aa+g14FrBSrlFTQ8bMVFhLyCfp9Pe8xlWMYraPfr+fXV9PPZ5SBqUmGvoO/p9fXl+c9frs+uptcX08uz68vzs78frHhW6qt/wdvLC3S1wgHabyW+guaV5OmHs0+/XP96qMqxqFev5V/Pf/n1w/kvvx48TuTFvsI3XP168Y/px9Prt7+eXU0/X1ydZ6426PQFOaGvoP+BOzgq5TVq+OLyYJPYyniN+jt9e9bL9YqlvMrsse0A08+XZ9PrU3QpWMcZJBX4unpfXF0PrPhe4muNwR9PL/96eMeKRb2Crm6UqXYeV9eXp9dnv/R3yjcIfAW9vXvjUGV3Ul59dqsX2QfPDXmxQ3zDz6f994tx3iF5zAEQHYoYprWvzy4/nX7o0Z67jENa3enn84OY2j7/K2g1fXd29fby/PNBiyMs6zW0PX1bCe8/q6dyXkPL7RVuB2u5l/MaWp791+fzy7Or6Wn/RRwUNYSuteD+wwuSMEgtfvz45fr05w9nu4/vFamTkfI6GvbuNQ2SXkfT3j2nQdLraHpI72kW9jr6uhjEs3fD6BsJe6Ve5a58HEjfSNiQVOv0y/WvF5fn/+3DO389O313AM7MCBtC3y+ftm45Vy310quzplkxwzC5/5q+O70+/fn06mx6df7fZwcG+bTLG0JrdwNm/2kqyT7I6ry613d7YXjfsDksYzDtDtg30OyD7hD/cfp5+u7L5w/nb0+vz7bhbH2DhBkiB9f90KUnETLkWHmQfhkhQ+r38fTq+uyy11YNihiybd0wUcWH9W/ZSMTgun05PyC6LJQwuGZVYPKXq0MrLpAyuIaHMdhIxOC6vb+8+HiYalsJg2tWP70w/bm/awUIGnJE8d/vCEz/EY8IGWTNcnEx/Xj66bfpxeezTy70prt6WMYgrXwxPbu87ONC3mcc3Np2R2oOHEciOcPunA44NwRlvIZ2g+xCgahXqckhdqBA1LBEY/tCwrvzq88fTn9zZdQY4gCg0Sz1Vb7AAxO/bR/wE3JiX+Ub/DA9+DfkxL5OO1xcXg/fClDoq+g/TNhnVtzr1Pn1xefpPy4uD5hdsKzX0fa3Txeffvs4hK57Sa81Kl6ff3p7vTe7QcbEVOaraH/92+eL6fXFh7PLaoV6uOaJvNcZA6uIGfzCXddhby/pVTT9fPrL+afc0zsddY1kveL8OH375fri/fvpIL0vlfgqmn+4eHv64fy/B16bZKQOvvL/+ex9dUChfnHwEFyalze41qfvK0fUYEojca9V01fXp5d9191t4l6pnodSGUh7rVp+f/7p/OrX4ao5lvdK9TyY0kjcoFzwQPKel/MaWh7qlH8d5k6lH0DcG0W9RmzNYS5dKuU1NDzwaFIiZkgd3cIvisCefjr92H8FnJc3pJ0OpXW7vFeu6799Obvs71NvEPgKsbz19vzqbTUJXf96eXb168UBJxZbxQ76Decfzz+cXg7/Ea1ye35F8jBXnIHcRkfFPXR572b5rVi4Fxsun+fpg43xr4desIjEtV0jRxXMNPVdOd8UK355x7sMrGLbm8hl8Bf6ZWsy+Ll7I+FXg8KfBmmeLu8GRXplGmb2VKYPLuRKOt6lbi+wpe/nrqbOFt1+N3VL6XK8n6r2tzuePpWuf+7U2Mr+T5CmsQGN2BvEzXKx3qyebzYd5P4lzoQ/ESmeqWD3H3bh29QHl3oze153KLZOfnC5K3oVbWvRQY5epWNzuiz+eC7Wm1aTCtMNbVaJ7K6mFX1ET/NKleCaWK50XOGtNf0qVdy/bg+q1B61yazGa/8eXGtthumGrtREdte6jT6iZxWnSnBrOlO63Zf93V947lL8Wi42H8kd03fPC//kxH9mUjbWeNiybmWUfKb7a8vKRu+F+KdfGqT8ZZcCV47XortNhCUwLIAWE7V3+KgKkN/0kkqj3KdV+ThbvYRrJyA+StWjlPSVnmwrND2b01xDyes8qJ5an+ZpLONhs3najutNpcTJepRTPQy8biqhTsCTHXWHtevlTcJ3KXpL/6VorJ8wUe8y3i9X72c3xebvs/lz0VhZmfS9S74qH8v5bJW+75gtG+ToUfp9sbmc/Xm+uFs2lRil6lHKXfWEQlshYaK+ZXxmDT1p0h7lPcfP92QHhn7Sb91j6E3Sdyn6tfp123AQpOlfAqOAfvL/nJWb98tV61eQdIeVxCyod41dRU+K4iqr0/QrgTW+kHSHlcQsqF85s9tb1heRdAeW9H61fLzarMIncFvKjHIcWPr54ufZ5uaheXrKZeg9zrGqOU16eHmsz23Ic7gGvOZuytR7/Od0oiTlwaU1VnWatHd5p/N5hyJJ6sPb9eeX99tNZYd2jTL1HOWLzaZc3LcO9Ptkvb+VU1SSskdpq2LN+y6asF8Nfp7dl4tZW8vRhL1rkVccSNu3JnkFpkl72uPLYrl4eWy1x32y/vbIKCpJ2dseGYXRhH3XbcunfyxXt+1rt326/nXIKSxN2rsWOcUlKfvuRBffysV9DCFz29Eoae/a5BYJU/etU26hKHHP1Xi53pSLm83pZrMqvz437ywz6fvPuF0Kz2fpW9udis/m6Ffv7x2qrwIzdrLaLDuTpXftd1WhMVffNuiqRFOmnmP0crXp1A4wQ/9Ru1PxDXl6j+OdFMhn6bvmrVyW3eofZzlgLdxNhcZc/dfI3ZRoytR7Jniaz14qXsFsCJzjkNmgiwJNmQ6YEbqo0JCnp2f05Wl5vZwXq9nipm0mpml71zu7UJy8b12zi4Wpe866FZNp8dfEyfrProyikpS9Z1FGYTRh3/H6abaabZYrFzjWPlTT1AeM0uyCcxn6j83sojPp+9X1p+WiW3XDDL1rvFvxDXn61ns3BfJZ+s6Hzps3WzUSQ5rwgNmPUxxI23+u4xSYJu3pmVstf5SP5ebl86q4KdcMDx3K0N9T16n4hjy9PXedFMhn6Vf7Z49fi9vbYtU2gITpetc1q7A0ad+aZRWXpDxkt/L2ebO8u/vI26cEiQ/coXCKzaQ/bFfCKRgn71fLH5Y3s3n5rw47EZyjd313VKApU9+a76hCQx6eBmEg5Nnij+fiubiFkQ3hj4MEsyYCWfGLkY4NgW1fQChjWuI+Zf/SyqpGecUFSfuXt3aHoxil7RIeUJPhwZqGamw6WMMpp9imAXGVaWlR4m5lBsZe/fR2XiKWvv9pEEMn4lhmHmjXI0qUlsgJFYUlsiK4aGltYVzsklIjzxSVN/L2spqiuWhxnJCuTiW2fyErXK29zJvKfTLnFRmn7Vuij9HglRin7dIjSIeGJQ3Wibt1387zRYd5osf8wJ4XOs8HzHmgSS46eLAX23TuoEmqN+Ti9ud0pxs0Z5ioexm3xWZWzpuqe5+CJb3xbGtW+nHb6dYqQ61J9ljgTVF+LxoCKHPFHqOs7Yq0nHp1vaCXOiDnwdr4MaqPNiDnwdo8rZbfy9vi9hyEYWQViTMNoEM2tL5BhdYY+w4arJrCJvLGyomf6KDFmoPwstpkch9urwyklTfZDmyrg053HOifVSqT+/D2awfh+dbjE/EuGmVDrPKKtMZadSk/FyiXL74tYq6b5baE5zTZLTNOp0tt/Dl76lIV2+QHl/voQtZv80toWDzJdbAW9fqooxo021Dzb0c1SK6DtViuyiq8dv4+vqKlVY8k38GaFPD0eeAl2f7eY0n7vMKhxsHX7ZP02qCs8BnaaI+yaj5C29Od1MmN1FTGXbko1w8tZUSJWGVoMdHqJDT7u9nzfF/G4/J2f/3P/sdwb/vPN37pfPTTv+tT9Ec/HcljdTw5enN0Vxbz2/XRT7/7Et4c3Swft+dEbusjI//cJvt7Ue1yq8Q+9X+eHL35/eSNscfKyn/+883vdWb3g/tDLWP/F5dRHL35XbzR6vhExBlFklFEGeXRm9/lGyuO9SjKJ5N8Msqnjt78rkA+leRTUT599OZ3jb5QJxl1lNEcvfndvDHyeDKJSzRJRhNltEdvfreoRJtktFHG0dGb30co4yjJOIoyjo/e/D4GdTNO8o2jfJOjN79PQL5Jkm8SN35lC+IE5BSp3QhiOM5yBMoLTCe2HVGZhEDWI1LzEbH9iMosBLIgkZqQiG1IVJYhNMqbWpGIzUhUxiEMypsakogtSVT2ISzKm9qSiI1JVCYiRihvak4itidRmYkYI+MXqU2J2KhEZStiAjOnhiViy5KVscgTlFmmpiVj05KVtUgBM6e2Jcm45AYmibqfBGNTbFyyshepYObUumRsXbIyGImsS6bWJWPrkpXBSGRdMrUuGVuXrAxGIuuSqXXJ2LpkZTASWZdMrUvG1iUre5FovJKpccnYuGRlLnICKzo1Lhkbl6rMRaFhS6W2pWLbUpW1KIEKVqltqdi2VGUtCo1bKjUtReY9N/HBmQ9MfbFlqcpYFLIslVqWii1LmdzSQKWWpWLLUjY36arUslRsWaoyFmXeSH2slIkzp6alYtNSlbUoZNIqNS0Vm5aqjEWN3ujxsR6N48ypaanYtLQzLWTTOjUtHZuWdqaF5mGdWpaOLUtXxqKRSevUsnRsWVpla1qnpqXJssqtq9A0rsHCKjYtXVmLhkOtTm1Lx7albV7r1Lh0bFy6Mhet0AyhU+PSsXHpyl60fmNOjvVYx5lT69KxdenKXjQaqHVqXDo2LlPZi0ZWbVLjMrFxmcpeNBqoTWpcJjYuI7NVbVLrMrF1mcpe9Bh1J5Nal4mtyzjrQl3CpNZlyLrd5LUGS/fYukxlL+YEap1al4mty4zyn5xal4mty1T2YuDixaTWZWLrMpXBGAkzp+ZlYvOylcUYNMPY1LxsbF62shiDZhibmpeNzctWBmMM3Cml5mVj87L5wcum5mVj87KVxRjUoWxqXjY2L+v2hahD2dS6LNkZOutCs4QFe8PYuOwoX1upcdnYuKwzrgmyTJsal42Ny1bmYtEcY1PbsrFtjU6yzTRKjWsUG9eosheL5phRalyj2LhGlblYtOQapbY1im1rlLetUWpbo9i2RpW5WNSbRqltjWLbGlXmYlFvGqW2NYpta+TcDmiCGaW2NSKOh8paLOoPI+B6iE1rNM5XVmpao9i0Rs60UGcapaY1ik1rXBmLhW6P1LLGsWWNnWWh+WWcWtY4tqxxZSwj1B3GqWWNY8saV7YyQhY9Tg1rHBvWWGcrepxa1ji2rHFlLCPUHcapZY1jyxpXxjJCFj1OLWscW9bY+bSQRY9TyxoTr1bessbAsxVb1rgylhHqDuPUssaxZU0qYxmh7jBJLWsSW9akMpYRsuhJalmT2LImzrKQRU9Sy5rEljXJj1mT1LQmsWlNKmMZQZfNJDWtSWxak8paxqg/TFLTmsSmNamsZYz6wyQ1rUlsWpPKWsbIpCepaU1i05o4jyky6UlqWRPiNK2MZQx3txPgOKWe0/yE6H+Lswd/2+avTGYMlwH+N5qfeFBPKrMZQ5fiCfChnhAn6knezPxvND9xpJ5UtjOGXskT4Eo9Ib7UE2drqIf4n2h24k49ye8d/W80P3GpnoyyO0D/G81P3Kon4+z20/9G8xPP6okzPej98r/R/MT4nCsem65AnvvEdV8Z0wT6/aHzntie88hPsOsf2B514Dun/AR6/5ELn/rwRX7+FMiNT/34zjc/gT5egVz51Jfv/PMTCBGQN5+680XeLyaQR5+69J2XfgI5BPLpU6e+89Pnvh6YHvHrC+eqn8BxBzj2BfHsC+esz3w98O0L4twXzl8/geMO8O4L4t4XzmM/geMO8O8L4uAXzmk/QctNAVz8gvj4hfPbixPY74CbXxA/v5ANwx5w9Qvi6xfOfy9OYMcF7n5B/P1C5hdyArj8BfH5C+fGFycSbV8FcPsL4vcXyvNKDP+A9RHfv3DufHEC+y7w/gvi/hfOpS9ODPwAgAAEYQDC+fXFCew+AAMIwgGEahj7AAoQhAUIZRpaAPAAQYCAcE5+cQI7IGACgkABobwJwh4IsIAgXEA4X3+2BYANEjgglLdB2IcBHhCEDwjdsO4DiEAQRiC0aGgBwAkEAQVCN9kggAWC0ALhAIDA1B/wAkGAgdANNgiYgSDQQOgmGwTcQBBwIBwLEDj0AKADQdiBcDhA4PADQA8EwQdCN9kgIAiCIAThsIDAMQyAIgiCEYRpsEFAEgRBCcI02SDACYLwBOEQgcCBFIAoCIIUhFENNQiogiBYQThUIDLRGMAGCVoQDWxBALggCF0QxpughTsIABgEIQzCeBuE4yhgDIJABuG4gRBwHAWYQRDOIIw3QTgMAtIgCGoQDh8ICQcRQBsEwQ3CIQQhYR8GxEEQ5CBsHmkJAB0EoQ7CgQQh4RgAuIMg4EE4mCAk7MKAPQgCH4QDCgIGiwjAHwQBEMJBhcwOEjAIQSCEcFxBwIATATCEIBxCOLQgYNCJACRCEBQhHF4QMPBEABohCI4QDTxCACAhCJEQI29/sP8AKCEIlRAjH8GGGwCQCUHQhGhgEwLACUHohHDEQcAgGAEAhSCEQowaRkAAKQShFMKRB6FgBwagQhBSIUZ5gi8ArBCEVohRHuILwCsEARbCQQhM0gRgFoJAC+FABHa1CsAtBAEXwsEIAWOJBGAXgsAL4YCEgPFEAvALQQCGGPswSjgAAYYhCMQQY29/cAABGEMQjiEcmxAwxEcAlCEIyxDjhr0wwBmC8AwxzjN+AZCGIExDOEwhFBzAANUQBGsIhyoEjDQSgGwIgjaEwxUCRhsJQDcEwRvCIQsBI44EIByCIA7hsIWAgUMCUA5BMIdo4BwCgA5BSIeY+FBe2H8A6xAEdggHMISG/QfwDkGAh5g02B9gHoJAD+FARmb8AdxDEPAhHMwQGvZfwD4EgR/C8QwBA5kEwB+C8A/ZwD8k4B+S8A954u0PRq0C/iEJ/5AOaOD6kwCASAJApAMaAgZUSQBAJAEg8sTbH4ytlgCBSIJA5Ik3QDiDSABBJIEg0kENYTIx1iDyl1AQ6aiGwKFKEmAQSTCIdFhD4HAlCTiIJBxEOq4hDFwFSABCJAEh0h9gMBqHigMzJCRE+lMMBp4PkYCFSMJCpD/KYOA5EQloiCQ0RPrzDAaeF5GAh0jCQ6Q/1GDGWACwRAJE5PZkAw7GBkREEiIit8cbYJCxBExEEiYi/RkHK95oezw+oa0ALJFAESnynmkJqIgkVET6sw4wzEgCKiLpaQeHOQSMFpLovAM98OAwh4ARQxIdeUjOPOS3wxKeeiBG6ECHsNAhI9HJB3r0waEOYS3sR+j4Az3/4FgHjtqW6AgEPQMhvQ2O0IZAonMQ9CCEhyN2jAUAG6SnIRztyBkxOhFBj0R4PGLxjIBORRA8Ij0eGZ3ATwB8RBI+Ij0fGQnYCgCQSAJIpAckMD5JAj4iCR+RKr8qlICPSMJHpNINdgwAiSSARHpAkrFjAEgkASTSAxIYZSUBIJEEkEgPSDJ2DAiJJIREqiYzBIREEkIiPSHJWREwQ4JIpD5psCLASCRhJNIzEhhtJgEikQSRSN0wGgJCIgkhkbppNASIRBJEIrVuGEsAI5GEkUjPSDKNCBiJJIxEekaSawNghwSSSA9JYOCdBJBEEkgidcOMDBiJJIxEekaSawNghQSSSHPSMJoCSiIJJZEOemRmJABJJIEk0kOSjBEASiIJJZGekmSGAkBJJKEk0lOSjBUBTCIJJpEOewgYQSkBJpEEk0iPSUZ4bQswiSSYRHpMAkMpJcAkkmAS6TFJZiwDnEQSTiI9J8n0IwBKJAEl0oOSEfLTSABKJAEl0uYDZiQAJZKAEmllQz8CpEQSUiI9Kcn0I4BKJEEl0qGPTD8CqEQSVCJt05QMWIkkrETapqUhgCWSwBJpm7YngJZIQkukpyWZoQDgEklwibRNczLgJZLwEjlqmpMBMJEEmEgHQLC/WwJgIgkwkR6YjPEeEQATSYCJdABEwBhjCYCJJMBEemAyxgfDATGRhJjIBmIiATGRhJhIR0BwxK8ExEQSYiIdARFjuLIExEQSYiJH/jIAuKoCxEQSYiIdAcl9PzBBQkykIyBiDFcUgJhIQkykJyZj7GkByEQSZCI9MoFByxIgE0mQiRw3bE4AMpEEmUiPTGDUswTIRBJkIj0yGcOpBCATSZCJdAhETHAXBMxEEmYiHQMRMPBXAmYiCTORDQdBJGAmkjAT6ZlJxucKoIkk0ER6aJLxuQJqIgk1kZ6aZFymAJtIgk2kxyYZpy3gJpJwEzlRDT5XAE4kASfSg5OMzxWQE0nIifTkJONzBehEEnQiJ7bB5wrYiSTsRE5GDT5XAE8kgSfSw5PMXADoiST0RDoagk++S0BPJKEn6uQk7/RVAJ8ogk+UxyfY6asAP1GEn6gTmXf6KgBQFAEoygMU7PRVgKAoQlCUJyh4RaAAQVGEoChPUPCEoABBUYSgqJOGAVEBgqIIQVGeoEygHShAUBQhKOokPyIqAFAUASjKA5QJvFUE8BNF+Iny/AQeZlAAnyiCT5THJ/A0ggL0RBF6ojw9gccJFIAnisAT5eEJPA+gADtRhJ0oz04yDQjYiSLsRHl2MsH9ELATRdiJEnmOrAA6UQSdKI9O4JkEBciJIuREORIi4ZkEBciJIuREORIi4ZkCBciJIuREbS+KwnfqAAsk5ET5u6LgkQAFyIki5ET566LgkQAFyIki5ET5G6NOYA8A4EQRcKL8pVHwRIAC3EQRbqL8xVEwIF8BbqIIN1H+8igYkK8ANlEEmyh/gRSMp1eAmihCTZSnJpkOBKiJItRE+ZukYDi7AtBE0bukVD6QQaHrpOh9UspfVgY7ALpRil4p5RCIhNHoCt0qlVwr5QwQBpMreLMUMUBHQCSM5Vbodil6vZQDIFLA1ZxCV0zRO6YcAZHwdjyFrpmi90w5ACJhKLVCN03Rq6Yc/5AwlFqh26bodVPKGyDsAejCKYJLlKMfEoZSK0BLFKElytEPCUOpFaAlitAS5a+egpGUCtASRWiJcvBDwlBqBWCJIrBEOfYhYSi1AqxEEVaiHPqQMJRaAVSiCCpRjnxIGAqtAClRhJQo3XDRGSAlipAS5ciHlHgZC1CJIqhEbY+TwMMICqASRVCJMt4CoYNUAVSiCCpRxpsgjKZUgJUowkqU8Zc2wo25AqxEEVaijGoYhQArUYSVKIc+JL5UEKASRVCJcuhDwnhoBVCJIqhEOfIh8d2CgJQoQkqUIx8S3y8ISIkipEQ58CHxHYMAlCgCSpTJewcV4CSKcBLluIeE8cQKcBJFOIly3EPiKwMBJ1GEkyiHPXA8vwKYRBFMohrusVKAkihCSZTVDX0QYBJFMImy3gDhNAgoiSKURNmGjQiAJIpAEmW9AcJpFDASRRiJst4A4TQKEIkiiERtT5RkWhBYIEEkyhEPCSOiFSAkihASNcqTOgUIiSKERDngIWFEtQKARBFAohzwkDAiWgFAogggUSN/fS10DCoASBQBJKoBkCgASBQBJMoBD6nxfaOAkChCSNSo6cpRdOcoMUFHPPClgQoQEkUIiXLEQ2o8CQFEoggiUWNvgvaNNsdqZGMBgJEowkiUQx65KgSMRBFGosbeCLFjEkASRSCJGqsGKwKURBFKosbeDKGTXwFMoggmUQ57YBe9AphEEUyiHPXADnYFKIkilEQ56iHhpZcKUBJFKIlqoCQKUBJFKIly0CNjxQCSKAJJ1KTJCAEkUQSSqIlo6AYAkigCSdSkyQgBJFEEkqhJkxECSKIIJFGTJiMEkEQRSKIm/j5vOJkARqIII1ENx0sUQCSKIBI1GTU1IrBCgkiUIx7ZRgRmSBCJcshDGjidAUSiCCLRjnhIg6YzDQiJJoREO+Ah4XWoGgASTQCJPskHEWrARzThI9rhDgmvVNUAj2iCR7SjHdLAm4YBHdGEjugTb4FoQawBHNEEjmjHOiS8IFUDNqIJG9EOdWT2hBqwEU3YiHasQ8JbVjVgI5qwEX3iDRAuCDWAI5rAEe1gh4QXpmoARzSBI1rkF4QawBFN4Ih2sEPCe1M1gCOawBEtVEMFADqiCR3RQjc0IaAjmtAR7WCHhMcqNIAjmsARLfzLBvC2Kg3oiCZ0RDdctqUBHdGEjmhPR+C5DA3oiCZ0RHs6Am9z1YCOaEJHtKcj8EZXDeiIJnREezoCL2bVgI5oQke0pyPwclYN6IgmdER7OgIvaNWAjmhCR7SnI/CSVg3oiCZ0RHs6Ai9q1YCOaEJHtKcj8DyDBnREEzqit89rwEkI0BFN6Ij2T2zASHgN4IgmcER7OAKjuDWAI5rAEe1gh4QBwBrAEU3giPZwBF6jqgEc0QSOaA9HYPyvBnBEEziiPRyB0bcawBFN4Ij2cAReiqoBHNEEjmgPR2DQogZsRBM2oj0bgZejasBGNGEj2rORMbQ/wEY0YSPasxEYM6gBG9GEjWjPRmDMnwZsRNPXODwbgdecavQgB32Rw7MRGPKn0aMc9FUOxzokDNnT6GEO+jKHZyMwZE+jtzmSxzmc/cGbOjV8n4PYn2cjMGJPoyc66Bsdno3Auzo1eqWDPtPhWIeE8SkaPdRBX+rwbATGp2j0Vgd9rEP7Z4ag/aH3OggZ0Z6MwPgUDcCIJmBEezAC41M04CKacBHtuQi8sFIDLKIJFtEei8DoEA2oiCZURDvKoWB0iAZURBMqov09WzA6RAMqogkV0Y5yKBgdogEV0YSKaEc5FIwO0YCKaEJFtKMcCkaHaEBFNKEi2lMRGB2iARXRhIpoRzkUjA7RgIpoQkW0Pz0Co0M0oCKaUBHtr9mC0SEaUBFNqIj2VARGh2hARTShItqfHYHBHRpAEU2giHaQQ8HgDA2giCZQRHsoAoMzNIAimkAR7SCHgsEZGkARTaCIdpBDweAMDaCIJlBEO8ah4D15GjARTZiI9tdswdgMDZiIJkxEeyYCYzM0YCKaMBHtGIeCsRkaMBFNmIj2t2zB2AwNmIgmTEQ7xKFgbIYGSEQTJKI9EoGxGRogEU2QiHaEQ8HYCg2IiCZERHsiAmMrNCAimhAR7R8FgbEVGhARTYiI9mdGYGyFBkBEEyCiHd9Q8Jo5DXiIJjxEO7yh4DVzGuAQTXCIdnRDwWviNKAhmtAQ7Y+MSGh/AIZoAkO0fysERiVowEI0YSHasQ0FoxI0YCGasBDtb9mCUQkasBBNWIh2bEPBqAQNWIgmLER7FgKjEjRgIZqwEO3YhoJRBRqwEE1YiHZoQ8GoAg1QiCYoRDuyoSCU14CEaEJCtAMbCr9HCECIJiBE+1u28JuEgINowkG0wxoKv0sIMIgmGEQ7rKHw84IAg2iCQbTHIJBpa4BBNMEg2lENBW/50oCCaEJBtIMaCt6ypQEE0QSCaAc1VOa5QGB/BIIYf8tW5snA1P4MgSDGQQ2Fnw0EEMQQCGI8BNHI/gyAIIZAEOOfGcEPAAIIYggEMSf+rmlkfwZAEEMgiDnxIQnI/gyAIIZAELN9aATZnwEQxBAIYk68/xnZnwEMxBAGYrbnQ5D9GcBADGEg5sRHZSH7MwCBGIJAjPDB0dD+AAIxBIGYLQLBz1YC+yMIxAgP4aD9AQRiCAIxwkdlQfsDBMQQAmL8WyMQARkAQAwBIMYBDQURjgEAxBAAYvzpEAhQDOAfhvAP4/kHvJfKAP5hCP8w/l4tyD8M4B+G8A/jeIaC/MMA/mEI/zCOZyjIPwzgH4bwD+OfG4H8wwD+YQj/MP5eLcg/DOAfhvAP43iGgvzDAP5hCP8w0t+dAO0P8A9D+IfZ3qoF7Q/wD0P4h/EvjkD+YQD/MIR/GMczFOQfBvAPQ/iH8S+OQP5hAP8whH8YxzMU5B8G8A9D+Ifxh0Mg/zCAfxjCP4x/bRzyDwP4hyH8w/gHxyH/MIB/GMI/jL9PC/IPA/iHIfzD+PdGIP8wgH8Ywj+M5x8Y4BoAQAwBIMYBDQUBigEAxBAAYhpeITcAgBgCQIwDGviaUQMAiCEAxPjHyCHAMQCAGAJAzPY9ctiBAAAxBIAYnY9BMACAGAJAjL9KC17eYgAAMQSAGA9AcCCVAQTEEAJi/GsjkEAZQEAMISDG36T1RqvjE0HsDwAQQwCI8QAEx1EZQEAMISDGnw6BBMwAAmIIATH+sRF8hZIBCMQQBGK0t0A4hAEEYuib5f4eLViB6NVy+my5JyCZCkRPl9O3y/3j5RDhGfR6OX2+3N+ihfUH9kcfMPfnQnL6AwNMXjF3UzBEiAa+Y04s0N+hhfUH9kefMjcNgYAGvWZOnzP3CAQiTIMeNKcvmjukgc0XPWlOCIjxBAQSUAMIiCEExPiHRmD1AQBiCAAx/m3zzDvywPoIADEOaGSekgcAxBAAYvwL5/g1eQBADAEgxr9yjh+UBwDEEABi/EvnODuwPsI/jOMZ8GSbAfjDEPxhPP6A+NoA/GEI/jAef0B8bQD+MAR/GI8/IL42AH8Ygj+Mxx8QXxuAPwzBH8bjD4ivDcAfhuAP4/EHxNcG4A9D8Ifx+APiawPwhyH4w3j8AfG1AfjDEPxhPP6A+NoA/GEI/jDbK7Og+QL8YQj+MP7KLHgq0QD8YQj+MP5ACLzsxwD8YQj+MP48CO79AH8Ygj+Mxx8C9j+APwzBH8bhDA3xvwH4wxD8YRzO0BD/G4A/DMEfxuEMDfG/AfjDEPxhHM7QEP8bgD8MwR/G4QwN8b8B+MMQ/GH8IyMQ/xuAPwzBH8bhDA3xvwH4wxD8YRzO0BD/G4A/DMEfxuEMDfG/AfjDEPxhHM7QEP8bgD8MwR/G4QwN8b8B+MMQ/GEcztAQ/xuAPwzBH8bhDA3xvwH4wxD8YRzO0BD/G4A/DMEfxuEMDfG/AfjDEPxhHM7QEP8bgD8MwR/G4QwN8b8B+MMQ/GH8NVkQ/xuAPwzBH9bhDA3xvwX4wxL8YR3O0BD/W4A/LMEf1uEMDfG/BfjDEvxhHc7QEP9bgD8swR/W4QwN8b8F+MMS/GEdztAQ/1uAPyzBH9bhDA3xvwX4wxL8Yf076xD/W4A/LMEf1r+zDvG/BfjDEvxhT/w1bcj+LMAfluAP63CGhvjfAvxhCf6wDmdoiP8twB+W4A/rcIaG+N8C/GEJ/rAOZ2iI/y3AH5bgD+twhob43wL8YQn+sA5naIj/LcAfluAP63CGhvjfAvxhCf6wDmdoiP8twB+W4A/rcIaG+N8C/GEJ/rAOZ2iI/y3AH5bgD+twhob43wL8YQn+sA5naIj/LcAfluAPK/3VMND+AP6wBH9YhzM0xP8W4A9L8Id1OEND/G8B/rAEf1iHMzTE/xbgD0vwh3U4Q0P8bwH+sAR/WIczNMT/FuAPS/CHdThDQ/xvAf6wBH9YhzM0xP8W4A9L8Id1OEND/G8B/rAEf1iHMzTE/xbgD0vwh3U4Q0P8bwH+sAR/WIczNMT/FuAPS/CHdThDQ/xvAf6wBH9YRzM0xP8W0A9L6Id1NEND/G8B/bCEflhHMzTE/xbQD0voh3U0Q0P8bwH9sIR+WEczNMT/FtAPS+iHdTRDQ/xvAf2whH5YRzM0xP8W0A9L6If1V2NB/G8B/bCEflgHMzTE/xbAD0vgh3UwQ0P8bwH8sAR+WEczNMT/FtAPS+iHdTBDQ/xvAfywBH5YBzM0xP8WwA9L4Id1LEND/G8B+7CEfVjHMjTE/xawD0vYh3UwQ0P8bwH8sAR+WMcyNMT/FrAPS9iH9U+IIOe1BejDEvRh/ekPfLOYBfDDEvhht8+sw5vFLIAflsAP62/FwrcaWUA/LKEf1l+LhY8gW8A/LOEf1vMPfLOYBfzDEv5hHc/QMATDAv5hCf+w/gUR3IbABAn/sI5nQAe8BfjDEvxhPf7AXw/4hyX8w/rnQ6AH1QL+YQn/sFZlPZgW8A9L+If112JBD6oF/MMS/mH9rVjwfl8L+Icl/MNafy0bzg/MjwAQ64iGhgE4FhAQSwiI9S+HQOsBAMQSAGJtw9WAFhAQSwiIHTVcDWgBArEEgdhRw9WAFjAQSxiIHeUJnAUMxBIGYkcNNwNaAEEsgSDWQQ0NY6AsgCCWQBDbcC2WBRDEEghiHdTQMIbKAghiCQSx/qV1GENlAQSxBIJY/9I6jKGyAIJYAkGsgxoaxlBZAEEsgSDWQQ2MUC2AIJZAEOvfDcEPHlhAQSyhIHbc8GaDBRjEEgxixw1vNljAQSzhINa/HIKjaCwAIZaAEOufDsEc2QISYgkJsf7tEPzogwUoxBIUYv3bIfjRBwtYiCUsxPoH1/HbHRbAEEtgiPUwBMbiWQBDLIEh1sMQGItnAQyxBIZYD0NgLJ4FMMQSGGI9DIGxeBbAEEtgiPUwBIbSWQBDLIEh1sMQGMpmAQyxBIZYD0PGcBwDMMQSGGI9DIGRYBbAEEtgiJ00rQQBDbGEhlhPQ2AolwU0xBIaYj0NgZFYFtCQ+m//fHNULr4Xq01xe764LX4c/fT770fT6eblqTh68++jaen/qMwbV87RT/8+UqOjn/79v2+OtNr+1/r/Grn9r/H/tdvfRyfb/9b/P/b/Hevtf7f/P9n+Lk5O6n/s/rItQghd/2OrhJCi/kedRm7lCVUn1rVAXf/F1H+plRV2q72o1RW1vmJUpxnXRexUnWz/Imudq8ef/T/kVmD1jKz/h67/ous0dqu8rIuo3rXy/xjXuerqqZ7n8P8Q20Kr2+L9P/S2NqqLb/0/6sqvblL1/xiJ+h+m/keda1dE/TnVfWP+H0LU/9gmNnXzV9Gcvp29wP99Uxuc/3Ntau63yvZmN5tyuViHZlVdw7e3q7Gs1ZA8gbe39d8iqRXT30k13sw6CbtbLR/Xm1W5uI/FqlAs86MDseXi62xz81AQZXUo1fKk3m2KVbH447l4Lm5nm6hKRVilvrF48u7KRbl+SORJEcjzbc6Tt97MqmGFqjcJ1ZvwxM3noQxj9yIss3Wfyum34mW6WG6md8vnxW00uMnAXqpTzkyJ34qXSExY8XU3lnXHNnVXt7ruP0wr32xW5dfnTTQeC3GyL0z4kZgv6Wm22RSruCtWT8ftJEpup6klrqd/PBerl+mfy9XtdLm6LVaxtjLUlmmTe9mr2eJbubhHgkUomNlyO8Gb5c1q+RQKtEEbjpjGGYh7KO8f5uX9Q2TyNhg2Rl3rdbNcFZtVWXyPm1+FFTrmdcqvs9vpqvjjuVhH6lUXQOyt3455soq75arIjUA27OK8RvECc0PQSTgEnXQQmBmDxqGCzC8uF7PVyx/Ps8Wm/FcRjR/Vy6f7rqPqjl6vOmS9QJL17CxHvG+4mS1uinlx+/UlVj9cjKl6Njeqno55o0EtfDNbf4tnpFEwRFcbBb60RFY4stYLosoN1lGkG1xiuSo0CV6vupltivvlqizWt+Xad7ByuQjFTgLLFZLbSM/reK08DtrHMEe7m3lZLDaze7qWUYGpMi3/Znkb6VNd0hnImNQLOqaZLB8fy83tbENkmlAms/6dqPXDLJYUDj8nXKUWd2W8OAuE1Ctfrqj1ZvV8s1nGM0tgCPV8ve1ppt48mLrLVeci/D/qBb2tN0O27vOWObLeLBebYrGhGzARGoIY86amQFaxeH6M5Y1CeR10+xGNpSJcwUt28z0vIimjoDczl8A3q4LYZHWOY9/vLLOzODFkgjBB65t6bzSum5+55NxKfn6MFhgqHLeYteUE+fxhzYdLAN5S0ksiy1YZjHmyS92vF7On9cMyXkzocFhmCiNLsECfEXPwXC2f5sXifvMQCQp6zJhrDcunx9nqW7zKtMH4yVxr3c42s6+zdbEu/xWPmzrcTY14zXZb3M2e51E9V46eYI7mDQe3xbygXSb4NMPc+Xgxs/kcb77DnYlh7uS9yMxufhRMNXbEG6m2Aus/R/vtcagfzy5icWT/HlYhc7W0lZcuvcYnYbN2qbx0fAi6ouB1xUBSeVf8KNfxp4brTsFbw3mJdMSJdpod5KTLy2A0lfX613Yx49zyMhrHuN+6vlmVT3RNWT1zEHT52kE3qd1xE24NbGblnPQMGfYMZhuXzg03iz9YhGtEKeo9xQnTAsvHYrGmzj0RDsBSbt2GsvbBynqJJJkro9ty/TSfvVSTdb07jj8h3GvUzlJZu2rtmDfbVluDcnGzwW4XHVbTSe3bmZzUZbC/BG4/hA03krXHVdYObanqf+idV6muTMubKes/TJ31U0s9CffZgvkttUTsWgvHjOoCyC4il0+Jw1iocIfG9MHWf0i6uQhnY8EdbutZYDq7vS0rDafL1fT5iW6RRDi3KtGtfdbTu7KY366n8/Kx3ExXxezmIXY6VPem72tWMeexWnzd/KBKVFgl3Sp4Xd7GraXDOYg70NXCgG6h05M71W7/sCken+a0iUJ3n6wBkqwJh6z3d5I7pZCyHmc/vr7QYWp0Es5ZtY9o5zA2OzbE7CzPj09TtyBPenO41BQdpOGeHC7tNXegq8Q9rZY3xXo9vZuV84LIVKFMZhd5XiXfWoHfYN3Es9ri8WtxSxzKoetrUsPCcd1II57J1YKJfz1s91GNupiuk4ynVYZDzN7lsLXfijF3EV6thaJaDTc+1jA/PhC2/Po/xQ3ROFwMMR32xWq1WMY+o8grxrPFYrWKXTxVtEFgNMyGqKSsN7PN8zrxs4WOfl1DWqOY1vhjdrNZFOvYaEQ4GmteHy5+PJWrYk1MRYc+7xq9q8kORvFWR3ezmyKSOwndSJI3gzohWRds6OeSHbR6KGOXUjD6MZd+tZioCcLdJ9Pt5uQQeCxCY5OjetnGnBOdxJR+jcPlItPt70QlU2u4mGDuiZ2g9deXZOM5DkYNUbubBXMK9VI3sfGKkEELyxuIdpLiHhXu7ASTRNwVt8WqcuY9Ps835bqYrW4enmar2WMkehJKFszP9ZJpHwg32sx1+F4S2CmKeOvOG+r2EsFCPPQ/CeY28a6ooh/oMFy9AhcM5tx629w8lIu7aFpQIb4x3P5QSXpalY+z1QsF+uHgZpj7a7duz27wwglb7BYBzKWe3xLEK+LQCcycwu7K+SYeSMLNv62jp2pPhZjUy+E6KMgwkakvaPZ1XmR27OGcJE/qMXFcExNmEAKGxjqkcJY7zjo+vriJzCBcbHBHsdXyMV72yHDZw7TM58VNYkA69Naf8EbC+2Lhhq9NsZgtNpvltyKSGRIJprwN9iLpkOVZJoBz0ho9O9UZ471Yyf3oTaMrpzq4vxd6wuuBlVDoU46AEb8WsUM5dKCPeUPrfbGBu47qeGEQK8UWhpYwOnRkWsnbW1SyWoaB6gqCvVwmyrqv1KMLj2Cl1kkIGZZCLwNvLXRfbKiPO6gryVtleCEkPjKQwhsN74vNfHkzm1dBKpn6tlH8HLuqFsvFuqiWPZvlyg0isdQQmlom2rwvNk+z+3KRbujDBYth7mMraavlj8pj9vK0Km7KNZUaLjUsM/jwvths489Wz3NSk2H7WObSxcn7MzHe0PHQVQ6x33CxzB4snSy6ngobgQkr74uNXyA3dfjQAJnr253cm+fN8u7ukZh06P9h8honMW/P4eLEMv2rTuSmGjgJEw0DkpnLtErWcrVpqsbwo5lA7h7siVTkKNyu8Zig28lbPlVxn6RrhMMBMy6kEvayWC5eSOuG8Xr2hN0U1J8Vhh6L7SLT1KcRLHNbuZVLfHshlKgF1144y+44m5en5WY5L1ZV5FtsjKGrij8TfC9WdAwMI0cVT7OHYpZ4M0fh0t3wxueHYjaPQzTC7ZDcHV1gagVjbYOvYw5YOzlPy/VmM4uWPDYYAJnREXtxq4JKC2YL5pkJ4tQSkQkb3kRBPVoiDKcVzDiphyWJGg5jfHkj+MNm8+TDHOPlbrD7Z7bYpqrcJJA5nKy2fbA+/GK5X/l8f18u7qvVL6IDIgTuktt7Xr6uyls/d0Uut6AHMdFjGYcdh+O2YJpn+fj47OaUaX0kAhzLUeG6RjNDblLJ2wi4abwxV+HGSzOnmVT41sudCA+pKDPqKxUOVlUqXNFr5tmAVPJzSY6ehMyAGe4GpDr6nNZ0iEmYO8m9cCcl14gm3KQyIRYVTesiDK4wzCVDIhPXRBTRecIbe5Mleng2ZDvAMIdgr9tsvipmt5Xp0sgqGW7JNDPwPGifBP1Gk3wfcYDWynD+0sxlu5eKo01CxxPTq+PFVYB6dlNB5fLrnDC4MNadiY/2QhPqLcMIAd1Jya1P2Y+x+ZYfhZXKjIYLTT2u0pCudvn6bOxluMHlDk/p4CnDqBJV0y9Vn3FVky6qrqfrP2dP8XeH4XpMCrkVlqAwE+6qOnSdYr0q1s/zuAIjh2gH60nJeTQ4MsdbJyllN2HIPpPqu5zJxlFGRx6ZMM3lJUO/CI+Mifo0hdI1CajD3CyTlNRlxNqGjhGluB9enZScRedPVaitZp7lcoK+z+aPpAbDdTTbQr7P5uVtPfvHqoXjFTNehciDK8Jw46GZaI3KzQTIqnD7rJm7Nio7txwUoWiugcai4WIw3LUwySCV60L7IqnhaGvYc0EsdXl3ty6I2HBnJLk9yIvdHiFKLoSQYaSUZrp7a6H1D9OUaMowpkEzY2eAXIo45TicZ5k71kTufbH0OsdOjFA005+eiC5JdGfYJ5g7zURmYmEyjELRTECXiE1NTIbxd5p56UAi93tRncJbgxoOow008xhkLd6hrKnff2//x4mKekgYOMD09TbIT9YUKmxO07E5/WovbcswwkkzGVMsEzTkKHLHdBvYknVvLDncP3ccheB+UYbnCzR71ecl1lcKJExHTsIuwoxQ3ElNvVJyEnYN5mngWt7WqoKrEDbLKT0wp0L6rE03Q4AlQNeqCvdrmunybSwG3WygQvqt2QvdhlK2f6RrjvBjmIcnSDFVO0zTY4cq3Hxr082AQtHpQUQVomnNPIdKRPuwuFjhcM3YcQ1aS00mXBXuRTXbTxJJ3dnhtPLNT4k7XYUn77TttgRJS1gVaQHhAMPEEkkBm/X0qVhNn2b38QIqPB6iTS/t0zkhjFjT7L1dJPRx5kLr7qfrTRU0dE/2F+FYw97xRQWAWScM3NOm2/y7lZrWb9h4plfj/RELDA2aGYtNBNazzvpmWZnbw6pYPyzjtY4KF9am48J6W8z6Yfmnb8diXXWdMtlyhQ4TbbotWetClisyP4SNyPacRDL9CjA2uHA0ZYbf7aV6Fj/dBZhNMUpX4dlBwwzkQKW4eLMpDDhTYZSlYd6+kZSBArNUeGzQMAMBUsm7MK1sJYXbU+api6SYXXBSrpTQy2zYXmZSCo4qUiEeNswQ7UR2dumowovJDDN0LBFfLwFcmMv0kVROeAUd80xhpoTGlg6LOelbzDZ6JVtI6JZgBmCmhWyWT9Mk+kSZyMXZdR6sZYNYFBVGAxtmsGIiuQr0mMJIDxUGbBrmuf2d/PKxnM9WrGkmPI5mmFd17MrZUPAQgnHNvEVkL63S8q4kJGcSrjSYIV07kX/Onqa3z0/zsrrzabt9BEcawxmdebgnKgK5BkOPrmaepamFVpFFU3d54rQ+R0c9miEpNGy0l4ivg+ap+HD/bzru/wPx23vXEuXDztNxx+6k+1vd8pUTDinMI69Ifq52Qrpo2HwtlZ+rnnDUYsPGQHx9p9s0vjFOheewNfMsRCSYHmhQIdDTzPjcSOLOpRP3njDq0jDPFUVyU696GDunJ93GJifSH/ck3Ty8OkAzTxxHUiuPOhk5wh0hG4kGItPaDP0FzLjTcjlNzmipCBkyj51UPagK+ItNMbxigjl6rV1esuiVYW0p5hUi1CcZ9gs1qrEjMybpW/ECgy9CUquYh9qrwP/0FpowakUxL3mqJAEQLcMdjmbG0H4rXkCQQRj6o5iWP5+RWL0wEJ8vAmgT9m7FBJPJGBGNj/UBuJP6ivE6RFgx4xPn5SKKO5bhtkMz92dunxR9akjGmMOYF0JilcOYW+YNKumJklhkeI0GM86s5ZCKCC/zk/XF64q5NX+cze+Wq8fidvo0e5kvZ4QmheMs8zCe96agy1LD2HTmcm/rmkGemdArKJjrr9pjt3XYlXFNmujUlhfBdHjXgpP9lQhZgGCO405acq9ldE0Z0033OCM3IYbaMN3ij7Mf0/qWvml1TV/+qh0VBtpqZpd5nP1oqL7wo5mRKI+zH5vlZjZPwrnDg66SGfJaCXt5WiYXcYrQ5S2YIPdx9uP7bP5crJ+KVXJBRKidONm9d8Dsx8WMXJAVBmAzF/iPRTkv0/jrYHypn1Fgtuxe3uypTNdKYaSBYV5NHMgEAsPFF7eLEIGrarhZrEmwZLg8ZPqrAsFb2gkUDveoTE95IHdTPhbLZyQ33BwwQedjsbovUugVNtKkPunOroL1mtKG0AWrmW6hx5JcDhAe5mfyrMdyva5cPU2xW2GggGEGClC5mfiq8OJewzwSTEUjJ0roTzJMf9JO7vPmYbkq/+XjmP3hpTh4K5z/mae1a+HZeKjQn6aZ/rRaaGPcUuijYh5ZTeTS4KKQEnKnn61MVjhNOGB1lJ8J9QhrgTvubyU+zqoxKomUjG5WZx7AqUXCVWUoj7lTqOXlnYlhSzFvvKuFeseNsyjiFQgrk7mtfFzeFvN4Kg5vopD15R31cwSSuasLbtSJpIfXSjGHlb0kfKtO2ECCeQak+cKfcLxmAr1AYLLfD7c8ggktqLw/y03m8yfRsXCmfe6lowWECI9yCWZsdiyT3GstwvNbgunVoeOP1NHhxHp1N9n9Y/eCVX1HW/04j6kDzQ0zvmmxnK6fZjfFdF7cbabLxfS2+F7eEJARzgzM9WDzXQsihFCyfhNNMf1yi+fHr8VqeVf/QALSw3vimPvENKIjcg/XfpST3dVCTLHz+exxhg9ihk4MZqzB8qlYzEooLmTOkul4T69jO4lu5K8XlfWIKOr30kR9e69gBugsV2VFs+fp6kCHPiHLdBlnbtyIota2gzhzcthLRLcfiHCtLZmnSbcz7HSzXE7nsxVZbYc7Is18k+zp2z04Di9DZq+Zs0J4tKtc3FVPsd0U6MRcuDzWzOUxvoss4iL1syN1xxrXA1r96p9lugG2V7OWi/tqzxXPbuEijrnyeFotv5e3xS3BEDoMr7bMo7O7m1ziLha6x5ir4eY7YUS4CZa7pxWZx0+jCLFwD8g8elPN2cRfF8YLi/omdsFc827lIc+iiNZUzPktWaNE90nxdMrdniPCKBNZXxQp6ytJLRPDbMW7WAd09WEYUCyYu99QJgyfEGHogGBeVLea/Vn/rb46HF5xHl1TwuvIq+KmKL9nT3GGRxqZrjcQyi7CfiyZ/petnPTFpoh2Mpu6WOevngvHGOb5nq285svnQtBrmcy/Ftx0/Vx4px1zse/EZu55Cy+IYS4ynTh801uI55hnNby01rveQj2Z4U1OcuulZiGHYYYQO8Ft15qFfYfpIXZycxebhb4R5vrKy2u52iy0py79KX+5WdijmOGeTmL7/V9hWzFjmALJ+AawEHMxj9lsZTY0fjjbMY9tbYWiW8BCMMAkuF5ayz1g4aczvSVeLr65KzoA38Hi4d1d4UlZywzocdIaLsMKD9UzncOrYr18Xt0UyYImdoZ1kgXCLELPA38QSh0r4eJb7l4XZJ4trZ49xbvmkBTy+wj9SBHeKyOYK91V8T1de4+i95t4LekWZfEKL1yLqfod9/qxHFE/uy52kR3M0zapW1KFTjTDdE+1DYciHGVk/dS9nNSsnhlQkR8bRcjj5Lh+eIrZtbcu1aVHux70xnUSMiDmbQhIaOpgDYNRO9VCLBj1sPCoPTNGy4u+J4frQyewYe6Icg7l8HQ2M6YyIrFEt/BQNjPos8nXG/YypmPQi9uGpcO9iQoPzxvmWILFpvUpwmhDwbymYV08Vm883zgPelSdgTBm2FujDzcc4kV9Ew4zMg/62cLBSbKNenskAd0mFLrRmbFI1dGzcPccN0fo2uB2aCIQbfHDp4kEE+iuy/vH6CFiEZ6tkcxVaf0GauYarvB6HKbroXmtJ8KQUFlHKMr6MUHLDE6qCgkGyDhaXITjhmT66v2KKK7PcLVRv84oVU0Kdf2X+pYfyTxhC99016GT2TIX1+mFRmHAtOLOZS48PBITcjFVPxetbO3ZMluvnu1UArmnINxNKGbAAVzwi/BcnxT1Y1eTWknmg8wVwwYIO7rZqbOkdEyX0W3FTCdUJZG4xEIPB/PoD9rfiDC8Uoo6vm1SXzzKHIaTp7fCmB3LnG2DIyBgLAq5HnPTFJ0piaea0MCZ6NtJwzcBhhHzTEzipNXngGLdwmmLCbp9rEQCcER45lsxvXROVuYNvRCyMfuVE7cHNbF64RjAjF7zR1qeb26K4pZ+bXhLH/NEZiUO3OobLt0t84B55sm46MgI80aQJE479GUdbWEZ39DA2YzwKg7FdJE6UehwRnQpN/PKkFAYqrWwLZm0x4lMZjMRbnFUveZQTOdtJTM56iTCyxnU7rlh5pVnlUgaIBY6K1W90bfMjf424DR21oWEuYsUOl2FIwgzUsHtFpyA9Ix5SPwN02Xi5AHUpMKVnmHeq5VuZcKY7A4i/FYz/cBwQ81EvFWUwONs8TKtYjzcUWIS8Ra55ZjfSSM8Q6+XqiOGdN0ftNit7uq5n7mbTXqHDC8nUswrQCp3aewVCxdeHYSAMwEhOOaaXM57K0JQJ0X9BjjT3UG6fXQLdY3ud8e16ofEzP7YC88+05tDwxGQyQGeF9v7rdwdCLufo+VAGBnGhMjpPl2Fg6lhXnK5vSc73kRFt6DUzzGMd/NlJ8kZShuiCubxklpgC6YNFxzMo+U7yU2cNmRVzCXWVi5k8aGz2jB3B0Te1xf0NJwOr2YyzFiwrGQUmBCiEsFEl6SA6hx59TQi4c3hCGOYuzEiuVx89afqYsHhwM98tNoLzmD2cFvGPDro5WHOHi5LmaufrbhW0B5qytyhedFeQuRfC8f/DpKSKyBDv1IHOa3sP9zMMyGel9wG/8NoBaaPxQvO0f/QHpk++a3AFvwfDlPMlZwXnOf/4VjNvATIi2wPAAgbjBnaForGEQChB5B5cWcttOEZsDCugnmWpZaKYgDCFTeTImzFtQQBRDfNd/p6HAUQmj7zgY+tPPiEV1iNzEB1L64hDiAMVGC6159X5BRLGEhex2zL2mUrmafwntfFqg5+xeQ9esiR9/nONx8xy6BJmI5+GPEcBiUzm2Irxx3JfCgXG3AEUoXH6g3T5fPnrNzcVYYduz/Da9vl7kW6baNYZqMEsuPVfITbt8Lr144t8/h4JRyskWTYDRW3Egp6124Y3y6Ync9LKW6z9C16pY6rWnp0PTxGxJnF//nm6Kl8Kublojj66fd//u///j9WX9Fdi6gCAA=="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..9d619a641 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1448 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +footer > p { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} +a.tsd-anchor-link { + color: var(--color-text); +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; +} + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-navigation .tsd-nav-link { + display: none; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation-section { + margin-left: 10px; +} +.tsd-page-navigation-section > summary { + padding: 0.25rem; +} +.tsd-page-navigation-section > div { + margin-left: 20px; +} +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} +.tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; +} +.tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/EnqueuedTask.html b/classes/EnqueuedTask.html new file mode 100644 index 000000000..be49609c0 --- /dev/null +++ b/classes/EnqueuedTask.html @@ -0,0 +1,7 @@ +EnqueuedTask | Meilisearch JS

Class EnqueuedTask

Constructors

constructor +

Properties

enqueuedAt +indexUid +status +taskUid +type +

Constructors

constructor

Properties

enqueuedAt

enqueuedAt: Date

indexUid

indexUid: undefined | string

status

status: TaskStatus

taskUid

taskUid: number

type

type: TaskTypes

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/classes/Index.html b/classes/Index.html new file mode 100644 index 000000000..cc3e7fed8 --- /dev/null +++ b/classes/Index.html @@ -0,0 +1,344 @@ +Index | Meilisearch JS

Class Index<T>

Type Parameters

  • T extends Record<string, any> = Record<string, any>

Constructors

constructor +

Properties

createdAt +httpRequest +primaryKey +tasks +uid +updatedAt +

Methods

addDocuments +addDocumentsFromString +addDocumentsInBatches +delete +deleteAllDocuments +deleteDocument +deleteDocuments +fetchInfo +fetchPrimaryKey +getDictionary +getDisplayedAttributes +getDistinctAttribute +getDocument +getDocuments +getEmbedders +getFaceting +getFilterableAttributes +getLocalizedAttributes +getNonSeparatorTokens +getPagination +getProximityPrecision +getRankingRules +getRawInfo +getSearchableAttributes +getSearchCutoffMs +getSeparatorTokens +getSettings +getSortableAttributes +getStats +getStopWords +getSynonyms +getTask +getTasks +getTypoTolerance +resetDictionary +resetDisplayedAttributes +resetDistinctAttribute +resetEmbedders +resetFaceting +resetFilterableAttributes +resetLocalizedAttributes +resetNonSeparatorTokens +resetPagination +resetProximityPrecision +resetRankingRules +resetSearchableAttributes +resetSearchCutoffMs +resetSeparatorTokens +resetSettings +resetSortableAttributes +resetStopWords +resetSynonyms +resetTypoTolerance +search +searchForFacetValues +searchGet +searchSimilarDocuments +update +updateDictionary +updateDisplayedAttributes +updateDistinctAttribute +updateDocuments +updateDocumentsByFunction +updateDocumentsFromString +updateDocumentsInBatches +updateEmbedders +updateFaceting +updateFilterableAttributes +updateLocalizedAttributes +updateNonSeparatorTokens +updatePagination +updateProximityPrecision +updateRankingRules +updateSearchableAttributes +updateSearchCutoffMs +updateSeparatorTokens +updateSettings +updateSortableAttributes +updateStopWords +updateSynonyms +updateTypoTolerance +waitForTask +waitForTasks +create +

Constructors

constructor

  • new Index<T>(config, uid, primaryKey?): Index<T>

  • Type Parameters

    • T extends Record<string, any> = Record<string, any>

    Parameters

    • config: Config

      Request configuration options

      +
    • uid: string

      UID of the index

      +
    • OptionalprimaryKey: string

      Primary Key of the index

      +

    Returns Index<T>

Properties

createdAt

createdAt: undefined | Date

httpRequest

httpRequest: HttpRequests

primaryKey

primaryKey: undefined | string

tasks

tasks: TaskClient

uid

uid: string

updatedAt

updatedAt: undefined | Date

Methods

addDocuments

  • addDocuments(documents, options?): Promise<EnqueuedTask>

  • Add or replace multiples documents to an index

    +

    Parameters

    • documents: T[]

      Array of Document objects to add/replace

      +
    • Optionaloptions: DocumentOptions

      Options on document addition

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

addDocumentsFromString

  • addDocumentsFromString(documents, contentType, queryParams?): Promise<EnqueuedTask>

  • Add or replace multiples documents in a string format to an index. It only +supports csv, ndjson and json formats.

    +

    Parameters

    • documents: string

      Documents provided in a string to add/replace

      +
    • contentType: ContentType

      Content type of your document: +'text/csv'|'application/x-ndjson'|'application/json'

      +
    • OptionalqueryParams: RawDocumentAdditionOptions

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

addDocumentsInBatches

  • addDocumentsInBatches(documents, batchSize?, options?): Promise<EnqueuedTask[]>

  • Add or replace multiples documents to an index in batches

    +

    Parameters

    • documents: T[]

      Array of Document objects to add/replace

      +
    • batchSize: number = 1000

      Size of the batch

      +
    • Optionaloptions: DocumentOptions

      Options on document addition

      +

    Returns Promise<EnqueuedTask[]>

    Promise containing array of enqueued task objects for each batch

    +

delete

deleteAllDocuments

deleteDocument

  • deleteDocument(documentId): Promise<EnqueuedTask>

  • Delete one document

    +

    Parameters

    • documentId: string | number

      Id of Document to delete

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

deleteDocuments

  • deleteDocuments(params): Promise<EnqueuedTask>

  • Delete multiples documents of an index.

    +

    Parameters

    • params: DocumentsDeletionQuery | DocumentsIds

      Params value can be:

      +
        +
      • DocumentsDeletionQuery: An object containing the parameters to customize +your document deletion. Only available in Meilisearch v1.2 and newer
        • +
      • DocumentsIds: An array of document ids to delete
        • +
      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

fetchInfo

  • fetchInfo(): Promise<Index<T>>

  • Fetch and update Index information.

    +

    Returns Promise<Index<T>>

    Promise to the current Index object with updated information

    +

fetchPrimaryKey

  • fetchPrimaryKey(): Promise<undefined | string>

  • Get Primary Key.

    +

    Returns Promise<undefined | string>

    Promise containing the Primary Key of the index

    +

getDictionary

  • getDictionary(): Promise<string[]>

  • Get the dictionary settings of a Meilisearch index.

    +

    Returns Promise<string[]>

    Promise containing the dictionary settings

    +

getDisplayedAttributes

  • getDisplayedAttributes(): Promise<string[]>

  • Get the displayed-attributes

    +

    Returns Promise<string[]>

    Promise containing array of displayed-attributes

    +

getDistinctAttribute

  • getDistinctAttribute(): Promise<null | string>

  • Get the distinct-attribute

    +

    Returns Promise<null | string>

    Promise containing the distinct-attribute of the index

    +

getDocument

  • getDocument<D>(documentId, parameters?): Promise<D>

  • Get one document

    +

    Type Parameters

    • D extends Record<string, any> = T

    Parameters

    • documentId: string | number

      Document ID

      +
    • Optionalparameters: DocumentQuery<T>

      Parameters applied on a document

      +

    Returns Promise<D>

    Promise containing Document response

    +

getDocuments

  • getDocuments<D>(parameters?): Promise<ResourceResults<D[]>>

  • Get documents of an index.

    +

    Type Parameters

    • D extends Record<string, any> = T

    Parameters

    • parameters: DocumentsQuery<D> = {}

      Parameters to browse the documents. Parameters can +contain the filter field only available in Meilisearch v1.2 and newer

      +

    Returns Promise<ResourceResults<D[]>>

    Promise containing the returned documents

    +

getEmbedders

  • getEmbedders(): Promise<Embedders>

  • Get the embedders settings of a Meilisearch index.

    +

    Returns Promise<Embedders>

    Promise containing the embedders settings

    +

getFaceting

getFilterableAttributes

  • getFilterableAttributes(): Promise<string[]>

  • Get the filterable-attributes

    +

    Returns Promise<string[]>

    Promise containing an array of filterable-attributes

    +

getLocalizedAttributes

getNonSeparatorTokens

  • getNonSeparatorTokens(): Promise<string[]>

  • Get the list of all non-separator tokens.

    +

    Returns Promise<string[]>

    Promise containing array of non-separator tokens

    +

getPagination

getProximityPrecision

getRankingRules

  • getRankingRules(): Promise<string[]>

  • Get the list of all ranking-rules

    +

    Returns Promise<string[]>

    Promise containing array of ranking-rules

    +

getRawInfo

getSearchableAttributes

  • getSearchableAttributes(): Promise<string[]>

  • Get the searchable-attributes

    +

    Returns Promise<string[]>

    Promise containing array of searchable-attributes

    +

getSearchCutoffMs

getSeparatorTokens

  • getSeparatorTokens(): Promise<string[]>

  • Get the list of all separator tokens.

    +

    Returns Promise<string[]>

    Promise containing array of separator tokens

    +

getSettings

getSortableAttributes

  • getSortableAttributes(): Promise<string[]>

  • Get the sortable-attributes

    +

    Returns Promise<string[]>

    Promise containing array of sortable-attributes

    +

getStats

getStopWords

  • getStopWords(): Promise<string[]>

  • Get the list of all stop-words

    +

    Returns Promise<string[]>

    Promise containing array of stop-words

    +

getSynonyms

  • getSynonyms(): Promise<object>

  • Get the list of all synonyms

    +

    Returns Promise<object>

    Promise containing object of synonym mappings

    +

getTask

  • getTask(taskUid): Promise<Task>

  • Get one task of the index.

    +

    Parameters

    • taskUid: number

      Task identifier

      +

    Returns Promise<Task>

    Promise containing a task

    +

getTasks

getTypoTolerance

resetDictionary

resetDisplayedAttributes

resetDistinctAttribute

resetEmbedders

resetFaceting

resetFilterableAttributes

resetLocalizedAttributes

resetNonSeparatorTokens

resetPagination

resetProximityPrecision

resetRankingRules

resetSearchableAttributes

resetSearchCutoffMs

resetSeparatorTokens

resetSettings

resetSortableAttributes

resetStopWords

resetSynonyms

resetTypoTolerance

search

  • search<D, S>(query?, options?, config?): Promise<SearchResponse<D, S>>

  • Search for documents into an index

    +

    Type Parameters

    Parameters

    • Optionalquery: null | string

      Query string

      +
    • Optionaloptions: S

      Search options

      +
    • Optionalconfig: Partial<Request>

      Additional request configuration options

      +

    Returns Promise<SearchResponse<D, S>>

    Promise containing the search response

    +

searchForFacetValues

searchGet

  • searchGet<D, S>(query?, options?, config?): Promise<SearchResponse<D, S>>

  • Search for documents into an index using the GET method

    +

    Type Parameters

    Parameters

    • Optionalquery: null | string

      Query string

      +
    • Optionaloptions: S

      Search options

      +
    • Optionalconfig: Partial<Request>

      Additional request configuration options

      +

    Returns Promise<SearchResponse<D, S>>

    Promise containing the search response

    +

searchSimilarDocuments

update

updateDictionary

  • updateDictionary(dictionary): Promise<EnqueuedTask>

  • Update the dictionary settings. Overwrite the old settings.

    +

    Parameters

    • dictionary: Dictionary

      Array that contains the new dictionary settings.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask or null

    +

updateDisplayedAttributes

  • updateDisplayedAttributes(displayedAttributes): Promise<EnqueuedTask>

  • Update the displayed-attributes.

    +

    Parameters

    • displayedAttributes: DisplayedAttributes

      Array of strings that contains attributes of +an index to display

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateDistinctAttribute

updateDocuments

  • updateDocuments(documents, options?): Promise<EnqueuedTask>

  • Add or update multiples documents to an index

    +

    Parameters

    • documents: Partial<T>[]

      Array of Document objects to add/update

      +
    • Optionaloptions: DocumentOptions

      Options on document update

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateDocumentsByFunction

updateDocumentsFromString

  • updateDocumentsFromString(documents, contentType, queryParams?): Promise<EnqueuedTask>

  • Add or update multiples documents in a string format to an index. It only +supports csv, ndjson and json formats.

    +

    Parameters

    • documents: string

      Documents provided in a string to add/update

      +
    • contentType: ContentType

      Content type of your document: +'text/csv'|'application/x-ndjson'|'application/json'

      +
    • OptionalqueryParams: RawDocumentAdditionOptions

      Options on raw document addition

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateDocumentsInBatches

  • updateDocumentsInBatches(documents, batchSize?, options?): Promise<EnqueuedTask[]>

  • Add or update multiples documents to an index in batches

    +

    Parameters

    • documents: Partial<T>[]

      Array of Document objects to add/update

      +
    • batchSize: number = 1000

      Size of the batch

      +
    • Optionaloptions: DocumentOptions

      Options on document update

      +

    Returns Promise<EnqueuedTask[]>

    Promise containing array of enqueued task objects for each batch

    +

updateEmbedders

  • updateEmbedders(embedders): Promise<EnqueuedTask>

  • Update the embedders settings. Overwrite the old settings.

    +

    Parameters

    • embedders: Embedders

      Object that contains the new embedders settings.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask or null

    +

updateFaceting

updateFilterableAttributes

  • updateFilterableAttributes(filterableAttributes): Promise<EnqueuedTask>

  • Update the filterable-attributes.

    +

    Parameters

    • filterableAttributes: FilterableAttributes

      Array of strings containing the attributes +that can be used as filters at query time

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateLocalizedAttributes

updateNonSeparatorTokens

  • updateNonSeparatorTokens(nonSeparatorTokens): Promise<EnqueuedTask>

  • Update the list of non-separator tokens. Overwrite the old list.

    +

    Parameters

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask or null

    +

updatePagination

updateProximityPrecision

  • updateProximityPrecision(proximityPrecision): Promise<EnqueuedTask>

  • Update the proximity precision settings. Overwrite the old settings.

    +

    Parameters

    • proximityPrecision: ProximityPrecision

      String that contains the new proximity +precision settings.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask or null

    +

updateRankingRules

  • updateRankingRules(rankingRules): Promise<EnqueuedTask>

  • Update the list of ranking-rules. Overwrite the old list.

    +

    Parameters

    • rankingRules: RankingRules

      Array that contain ranking rules sorted by order of +importance.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateSearchableAttributes

  • updateSearchableAttributes(searchableAttributes): Promise<EnqueuedTask>

  • Update the searchable-attributes.

    +

    Parameters

    • searchableAttributes: SearchableAttributes

      Array of strings that contains searchable +attributes sorted by order of importance(most to least important)

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateSearchCutoffMs

updateSeparatorTokens

  • updateSeparatorTokens(separatorTokens): Promise<EnqueuedTask>

  • Update the list of separator tokens. Overwrite the old list.

    +

    Parameters

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask or null

    +

updateSettings

  • updateSettings(settings): Promise<EnqueuedTask>

  • Update all settings Any parameters not provided will be left unchanged.

    +

    Parameters

    • settings: Settings

      Object containing parameters with their updated values

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateSortableAttributes

  • updateSortableAttributes(sortableAttributes): Promise<EnqueuedTask>

  • Update the sortable-attributes.

    +

    Parameters

    • sortableAttributes: SortableAttributes

      Array of strings containing the attributes that +can be used to sort search results at query time

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateStopWords

  • updateStopWords(stopWords): Promise<EnqueuedTask>

  • Update the list of stop-words. Overwrite the old list.

    +

    Parameters

    • stopWords: StopWords

      Array of strings that contains the stop-words.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateSynonyms

  • updateSynonyms(synonyms): Promise<EnqueuedTask>

  • Update the list of synonyms. Overwrite the old list.

    +

    Parameters

    • synonyms: Synonyms

      Mapping of synonyms with their associated words

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

updateTypoTolerance

  • updateTypoTolerance(typoTolerance): Promise<EnqueuedTask>

  • Update the typo tolerance settings.

    +

    Parameters

    • typoTolerance: TypoTolerance

      Object containing the custom typo tolerance +settings.

      +

    Returns Promise<EnqueuedTask>

    Promise containing object of the enqueued update

    +

waitForTask

  • waitForTask(taskUid, waitOptions?): Promise<Task>

  • Wait for a task to be processed.

    +

    Parameters

    • taskUid: number

      Task identifier

      +
    • waitOptions: WaitOptions = {}

      Options on timeout and interval

      +

    Returns Promise<Task>

    Promise containing an array of tasks

    +

waitForTasks

  • waitForTasks(taskUids, waitOptions?): Promise<Task[]>

  • Wait for multiple tasks to be processed.

    +

    Parameters

    • taskUids: number[]

      Tasks identifier

      +
    • waitOptions: WaitOptions = {}

      Options on timeout and interval

      +

    Returns Promise<Task[]>

    Promise containing an array of tasks

    +

Staticcreate

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
addDocumentsaddDocumentsFromStringaddDocumentsInBatchesdeletedeleteAllDocumentsdeleteDocumentdeleteDocumentsfetchInfofetchPrimaryKeygetDictionarygetDisplayedAttributesgetDistinctAttributegetDocumentgetDocumentsgetEmbeddersgetFacetinggetFilterableAttributesgetLocalizedAttributesgetNonSeparatorTokensgetPaginationgetProximityPrecisiongetRankingRulesgetRawInfogetSearchableAttributesgetSearchCutoffMsgetSeparatorTokensgetSettingsgetSortableAttributesgetStatsgetStopWordsgetSynonymsgetTaskgetTasksgetTypoToleranceresetDictionaryresetDisplayedAttributesresetDistinctAttributeresetEmbeddersresetFacetingresetFilterableAttributesresetLocalizedAttributesresetNonSeparatorTokensresetPaginationresetProximityPrecisionresetRankingRulesresetSearchableAttributesresetSearchCutoffMsresetSeparatorTokensresetSettingsresetSortableAttributesresetStopWordsresetSynonymsresetTypoTolerancesearchsearchForFacetValuessearchGetsearchSimilarDocumentsupdateupdateDictionaryupdateDisplayedAttributesupdateDistinctAttributeupdateDocumentsupdateDocumentsByFunctionupdateDocumentsFromStringupdateDocumentsInBatchesupdateEmbeddersupdateFacetingupdateFilterableAttributesupdateLocalizedAttributesupdateNonSeparatorTokensupdatePaginationupdateProximityPrecisionupdateRankingRulesupdateSearchableAttributesupdateSearchCutoffMsupdateSeparatorTokensupdateSettingsupdateSortableAttributesupdateStopWordsupdateSynonymsupdateTypoTolerancewaitForTaskwaitForTaskscreate
diff --git a/classes/MeiliSearch-1.html b/classes/MeiliSearch-1.html new file mode 100644 index 000000000..aebcffdac --- /dev/null +++ b/classes/MeiliSearch-1.html @@ -0,0 +1,131 @@ +MeiliSearch | Meilisearch JS

Class MeiliSearch

Hierarchy

  • Client
    • MeiliSearch

Constructors

constructor +

Properties

config +httpRequest +tasks +tokens +

Methods

cancelTasks +createDump +createIndex +createKey +createSnapshot +deleteIndex +deleteIndexIfExists +deleteKey +deleteTasks +generateTenantToken +getIndex +getIndexes +getKey +getKeys +getRawIndex +getRawIndexes +getStats +getTask +getTasks +getVersion +health +index +isHealthy +multiSearch +swapIndexes +updateIndex +updateKey +waitForTask +waitForTasks +

Constructors

constructor

Properties

config

config: Config

httpRequest

httpRequest: HttpRequests

tasks

tasks: TaskClient

tokens

tokens: Token

Methods

cancelTasks

  • cancelTasks(parameters): Promise<EnqueuedTask>

  • Cancel a list of enqueued or processing tasks.

    +

    Parameters

    • parameters: Omit<TasksQuery, "limit" | "from">

      Parameters to filter the tasks.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

createDump

createIndex

createKey

createSnapshot

deleteIndex

  • deleteIndex(uid): Promise<EnqueuedTask>

  • Delete an index

    +

    Parameters

    • uid: string

      The index UID

      +

    Returns Promise<EnqueuedTask>

    Promise which resolves when index is deleted successfully

    +

deleteIndexIfExists

  • deleteIndexIfExists(uid): Promise<boolean>

  • Deletes an index if it already exists.

    +

    Parameters

    • uid: string

      The index UID

      +

    Returns Promise<boolean>

    Promise which resolves to true when index exists and is deleted +successfully, otherwise false if it does not exist

    +

deleteKey

  • deleteKey(keyOrUid): Promise<void>

  • Delete one API key

    +

    Parameters

    • keyOrUid: string

      Key

      +

    Returns Promise<void>

deleteTasks

  • deleteTasks(parameters?): Promise<EnqueuedTask>

  • Delete a list of tasks.

    +

    Parameters

    • parameters: Omit<TasksQuery, "limit" | "from"> = {}

      Parameters to filter the tasks.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

generateTenantToken

  • generateTenantToken(apiKeyUid, searchRules, options?): Promise<string>

  • Generate a tenant token

    +

    Parameters

    • apiKeyUid: string

      The uid of the api key used as issuer of the token.

      +
    • searchRules: TokenSearchRules

      Search rules that are applied to every search.

      +
    • Optionaloptions: TokenOptions

      Token options to customize some aspect of the token.

      +

    Returns Promise<string>

    The token in JWT format.

    +

getIndex

  • getIndex<T>(indexUid): Promise<Index<T>>

  • Gather information about an index by calling MeiliSearch and return an +Index instance with the gathered information

    +

    Type Parameters

    • T extends Record<string, any> = Record<string, any>

    Parameters

    • indexUid: string

      The index UID

      +

    Returns Promise<Index<T>>

    Promise returning Index instance

    +

getIndexes

  • getIndexes(parameters?): Promise<IndexesResults<Index<Record<string, any>>[]>>

  • Get all the indexes as Index instances.

    +

    Parameters

    • parameters: Pagination = {}

      Parameters to browse the indexes

      +

    Returns Promise<IndexesResults<Index<Record<string, any>>[]>>

    Promise returning array of raw index information

    +

getKey

  • getKey(keyOrUid): Promise<Key>

  • Get one API key

    +

    Parameters

    • keyOrUid: string

      Key or uid of the API key

      +

    Returns Promise<Key>

    Promise returning a key

    +

getKeys

getRawIndex

  • getRawIndex(indexUid): Promise<IndexObject>

  • Gather information about an index by calling MeiliSearch and return the raw +JSON response

    +

    Parameters

    • indexUid: string

      The index UID

      +

    Returns Promise<IndexObject>

    Promise returning index information

    +

getRawIndexes

getStats

  • getStats(): Promise<Stats>

  • Get the stats of all the database

    +

    Returns Promise<Stats>

    Promise returning object of all the stats

    +

getTask

  • getTask(taskUid): Promise<Task>

  • Get one task on the client scope

    +

    Parameters

    • taskUid: number

      Task identifier

      +

    Returns Promise<Task>

    Promise returning a task

    +

getTasks

getVersion

  • getVersion(): Promise<Version>

  • Get the version of MeiliSearch

    +

    Returns Promise<Version>

    Promise returning object with version details

    +

health

  • health(): Promise<Health>

  • Checks if the server is healthy, otherwise an error will be thrown.

    +

    Returns Promise<Health>

    Promise returning an object with health details

    +

index

  • index<T>(indexUid): Index<T>

  • Return an Index instance

    +

    Type Parameters

    • T extends Record<string, any> = Record<string, any>

    Parameters

    • indexUid: string

      The index UID

      +

    Returns Index<T>

    Instance of Index

    +

isHealthy

  • isHealthy(): Promise<boolean>

  • Checks if the server is healthy, return true or false.

    +

    Returns Promise<boolean>

    Promise returning a boolean

    +

multiSearch

  • multiSearch<T>(queries, config?): Promise<MultiSearchResponse<T>>

  • Perform multiple search queries.

    +

    It is possible to make multiple search queries on the same index or on +different ones

    +

    Type Parameters

    • T extends Record<string, unknown> = Record<string, any>

    Parameters

    • queries: MultiSearchParams

      Search queries

      +
    • Optionalconfig: Partial<Request>

      Additional request configuration options

      +

    Returns Promise<MultiSearchResponse<T>>

    Promise containing the search responses

    +

    Example

    client.multiSearch({
      queries: [
        { indexUid: "movies", q: "wonder" },
        { indexUid: "books", q: "flower" },
      ],
    });
+
    + +
  • multiSearch<T>(queries, config?): Promise<SearchResponse<T>>

  • Type Parameters

    • T extends Record<string, unknown> = Record<string, any>

    Parameters

    Returns Promise<SearchResponse<T>>

swapIndexes

updateIndex

updateKey

  • updateKey(keyOrUid, options): Promise<Key>

  • Update one API key

    +

    Parameters

    • keyOrUid: string

      Key

      +
    • options: KeyUpdate

      Key options

      +

    Returns Promise<Key>

    Promise returning a key

    +

waitForTask

  • waitForTask(taskUid, waitOptions?): Promise<Task>

  • Wait for a task to be finished.

    +

    Parameters

    • taskUid: number

      Task identifier

      +
    • waitOptions: WaitOptions = {}

      Options on timeout and interval

      +

    Returns Promise<Task>

    Promise returning an array of tasks

    +

waitForTasks

  • waitForTasks(taskUids, waitOptions?): Promise<Task[]>

  • Wait for multiple tasks to be finished.

    +

    Parameters

    • taskUids: number[]

      Tasks identifier

      +
    • waitOptions: WaitOptions = {}

      Options on timeout and interval

      +

    Returns Promise<Task[]>

    Promise returning an array of tasks

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/MeiliSearchApiError.html b/classes/MeiliSearchApiError.html new file mode 100644 index 000000000..c73c2b79e --- /dev/null +++ b/classes/MeiliSearchApiError.html @@ -0,0 +1,13 @@ +MeiliSearchApiError | Meilisearch JS

Class MeiliSearchApiError

Hierarchy (view full)

Constructors

constructor +

Properties

cause? +message +name +response +stack? +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +

Constructors

constructor

Properties

Optionalcause

cause?: MeiliSearchErrorResponse

message

message: string

name

name: string = "MeiliSearchApiError"

Readonlyresponse

response: Response

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

+

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/MeiliSearchError.html b/classes/MeiliSearchError.html new file mode 100644 index 000000000..ed75aeaf0 --- /dev/null +++ b/classes/MeiliSearchError.html @@ -0,0 +1,12 @@ +MeiliSearchError | Meilisearch JS

Class MeiliSearchError

Hierarchy (view full)

Constructors

constructor +

Properties

cause? +message +name +stack? +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string = "MeiliSearchError"

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

+

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/MeiliSearchRequestError.html b/classes/MeiliSearchRequestError.html new file mode 100644 index 000000000..c256730f5 --- /dev/null +++ b/classes/MeiliSearchRequestError.html @@ -0,0 +1,12 @@ +MeiliSearchRequestError | Meilisearch JS

Class MeiliSearchRequestError

Hierarchy (view full)

Constructors

constructor +

Properties

cause? +message +name +stack? +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string = "MeiliSearchRequestError"

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

+

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/MeiliSearchTimeOutError.html b/classes/MeiliSearchTimeOutError.html new file mode 100644 index 000000000..c12553b46 --- /dev/null +++ b/classes/MeiliSearchTimeOutError.html @@ -0,0 +1,12 @@ +MeiliSearchTimeOutError | Meilisearch JS

Class MeiliSearchTimeOutError

Hierarchy (view full)

Constructors

constructor +

Properties

cause? +message +name +stack? +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string = "MeiliSearchTimeOutError"

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

+

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/Task.html b/classes/Task.html new file mode 100644 index 000000000..f47c844c5 --- /dev/null +++ b/classes/Task.html @@ -0,0 +1,13 @@ +Task | Meilisearch JS

Class Task

Constructors

constructor +

Properties

canceledBy +details +duration +enqueuedAt +error +finishedAt +indexUid +startedAt +status +type +uid +

Constructors

constructor

Properties

canceledBy

canceledBy: number

details

details: {
    canceledTasks?: number;
    deletedDocuments?: number;
    deletedTasks?: number;
    displayedAttributes?: DisplayedAttributes;
    distinctAttribute?: DistinctAttribute;
    filterableAttributes?: FilterableAttributes;
    indexedDocuments?: number;
    matchedTasks?: number;
    originalFilter?: string;
    primaryKey?: string;
    providedIds?: number;
    rankingRules?: RankingRules;
    receivedDocuments?: number;
    searchableAttributes?: SearchableAttributes;
    sortableAttributes?: SortableAttributes;
    stopWords?: StopWords;
    swaps?: SwapIndexesParams;
    synonyms?: Synonyms;
}

duration

duration: string

enqueuedAt

enqueuedAt: Date

error

error: null | MeiliSearchErrorResponse

finishedAt

finishedAt: Date

indexUid

indexUid: undefined | string

startedAt

startedAt: Date

status

status: TaskStatus

type

type: TaskTypes

uid

uid: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/classes/TaskClient.html b/classes/TaskClient.html new file mode 100644 index 000000000..c2b7ab66c --- /dev/null +++ b/classes/TaskClient.html @@ -0,0 +1,28 @@ +TaskClient | Meilisearch JS

Class TaskClient

Constructors

constructor +

Properties

httpRequest +

Methods

cancelTasks +deleteTasks +getTask +getTasks +waitForTask +waitForTasks +

Constructors

constructor

Properties

httpRequest

httpRequest: HttpRequests

Methods

cancelTasks

  • cancelTasks(parameters?): Promise<EnqueuedTask>

  • Cancel a list of enqueued or processing tasks.

    +

    Parameters

    • parameters: Omit<TasksQuery, "limit" | "from"> = {}

      Parameters to filter the tasks.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

deleteTasks

  • deleteTasks(parameters?): Promise<EnqueuedTask>

  • Delete a list tasks.

    +

    Parameters

    • parameters: Omit<TasksQuery, "limit" | "from"> = {}

      Parameters to filter the tasks.

      +

    Returns Promise<EnqueuedTask>

    Promise containing an EnqueuedTask

    +

getTask

  • getTask(uid): Promise<Task>

  • Get one task

    +

    Parameters

    • uid: number

      Unique identifier of the task

      +

    Returns Promise<Task>

getTasks

waitForTask

  • waitForTask(taskUid, options?): Promise<Task>

  • Wait for a task to be processed.

    +

    Parameters

    • taskUid: number

      Task identifier

      +
    • options: WaitOptions = {}

      Additional configuration options

      +

    Returns Promise<Task>

    Promise returning a task after it has been processed

    +

waitForTasks

  • waitForTasks(taskUids, options?): Promise<Task[]>

  • Waits for multiple tasks to be processed

    +

    Parameters

    • taskUids: number[]

      Tasks identifier list

      +
    • options: WaitOptions = {}

      Wait options

      +

    Returns Promise<Task[]>

    Promise returning a list of tasks after they have been processed

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/functions/versionErrorHintMessage.html b/functions/versionErrorHintMessage.html new file mode 100644 index 000000000..1a6961906 --- /dev/null +++ b/functions/versionErrorHintMessage.html @@ -0,0 +1 @@ +versionErrorHintMessage | Meilisearch JS

Function versionErrorHintMessage

Settings

Member Visibility
diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 000000000..c3c01c193 --- /dev/null +++ b/hierarchy.html @@ -0,0 +1 @@ +Meilisearch JS

Meilisearch JS

Class Hierarchy

Settings

Member Visibility
diff --git a/index.html b/index.html new file mode 100644 index 000000000..7e23674f6 --- /dev/null +++ b/index.html @@ -0,0 +1,445 @@ +Meilisearch JS

Meilisearch JS

+ Meilisearch-JavaScript +

+

Meilisearch JavaScript

+

+ Meilisearch | + Meilisearch Cloud | + Documentation | + Discord | + Roadmap | + Website | + FAQ +

+

+ npm version + Tests + + Codecov + + Prettier + License + Bors enabled +

+

⚡ The Meilisearch API client written for JavaScript

+

Meilisearch JavaScript is the Meilisearch API client for JavaScript developers.

+

Meilisearch is an open-source search engine. Learn more about Meilisearch.

+

Table of Contents

+

📖 Documentation

This readme and Meilisearch JS documentation website contains all the information you need to start using this Meilisearch SDK.

+

For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our main documentation website.

+

⚡ Supercharge your Meilisearch experience

Say goodbye to server deployment and manual updates with Meilisearch Cloud. Get started with a 14-day free trial! No credit card required.

+

🔧 Installation

We recommend installing meilisearch-js in your project with your package manager of choice.

+
npm install meilisearch
+
+ +

meilisearch-js officially supports node versions >= 14 and <= 18.

+

Instead of using a package manager, you may also import the library directly into your HTML via a CDN.

+

Run Meilisearch

To use one of our SDKs, you must first have a running Meilisearch instance. Consult our documentation for instructions on how to download and launch Meilisearch.

+

Import

After installing meilisearch-js, you must import it into your application. There are many ways of doing that depending on your development environment.

+

import syntax

Usage in an ES module environment:

+
import { MeiliSearch } from 'meilisearch'

const client = new MeiliSearch({
  host: 'http://127.0.0.1:7700',
  apiKey: 'masterKey',
})
+
+ +

<script> tag

Usage in an HTML (or alike) file:

+
<script src='https://cdn.jsdelivr.net/npm/meilisearch@latest/dist/bundles/meilisearch.umd.js'></script>
<script>
  const client = new MeiliSearch({
    host: 'http://127.0.0.1:7700',
    apiKey: 'masterKey',
  })
</script>
+
+ +

require syntax

Usage in a back-end node.js or another environment supporting CommonJS modules:

+
const { MeiliSearch } = require('meilisearch')

const client = new MeiliSearch({
  host: 'http://127.0.0.1:7700',
  apiKey: 'masterKey',
})
+
+ +

React Native

To use meilisearch-js with React Native, you must also install react-native-url-polyfill.

+

Deno

Usage in a Deno environment:

+
import { MeiliSearch } from "https://esm.sh/meilisearch"

const client = new MeiliSearch({
  host: 'http://127.0.0.1:7700',
  apiKey: 'masterKey',
})
+
+ +

🎬 Getting started

Add documents 

const { MeiliSearch } = require('meilisearch')
// Or if you are in a ES environment
import { MeiliSearch } from 'meilisearch'

;(async () => {
  const client = new MeiliSearch({
    host: 'http://127.0.0.1:7700',
    apiKey: 'masterKey',
  })

  // An index is where the documents are stored.
  const index = client.index('movies')

  const documents = [
      { id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
      { id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
      { id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
      { id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
      { id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
      { id: 6, title: 'Philadelphia', genres: ['Drama'] },
  ]

  // If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
  let response = await index.addDocuments(documents)

  console.log(response) // => { "uid": 0 }
})()
+
+ +

Tasks such as document addition always return a unique identifier. You can use this identifier taskUid to check the status (enqueued, canceled, processing, succeeded or failed) of a task.

+

Basic search 

// Meilisearch is typo-tolerant:
const search = await index.search('philoudelphia')
console.log(search)
+
+ +

Output:

+
{
  "hits": [
    {
      "id": "6",
      "title": "Philadelphia",
      "genres": ["Drama"]
    }
  ],
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 1,
  "processingTimeMs": 1,
  "query": "philoudelphia"
}
+
+ +

Using search parameters

meilisearch-js supports all search parameters described in our main documentation website.

+
await index.search(
  'wonder',
  {
    attributesToHighlight: ['*']
  }
)
+
+ +
{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action", "Adventure"],
      "_formatted": {
        "id": "2",
        "title": "<em>Wonder</em> Woman",
        "genres": ["Action", "Adventure"]
      }
    }
  ],
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 1,
  "processingTimeMs": 0,
  "query": "wonder"
}
+
+ +

Custom search with filters

To enable filtering, you must first add your attributes to the filterableAttributes index setting.

+
await index.updateFilterableAttributes([
    'id',
    'genres'
  ])
+
+ +

You only need to perform this operation once per index.

+

Note that Meilisearch rebuilds your index whenever you update filterableAttributes. Depending on the size of your dataset, this might take considerable time. You can track the process using the tasks API).

+

After you configured filterableAttributes, you can use the filter search parameter to refine your search:

+
await index.search(
  'wonder',
  {
    filter: ['id > 1 AND genres = Action']
  }
)
+
+ +
{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action","Adventure"]
    }
  ],
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 1,
  "processingTimeMs": 0,
  "query": "wonder"
}
+
+ +

Placeholder search

Placeholder search makes it possible to receive hits based on your parameters without having any query (q). For example, in a movies database you can run an empty query to receive all results filtered by genre.

+
await index.search(
  '',
  {
    filter: ['genres = fantasy'],
    facets: ['genres']
  }
)
+
+ +
{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action","Adventure"]
    },
    {
      "id": 5,
      "title": "Moana",
      "genres": ["Fantasy","Action"]
    }
  ],
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 2,
  "processingTimeMs": 0,
  "query": "",
  "facetDistribution": {
    "genres": {
      "Action": 2,
      "Fantasy": 1,
      "Adventure": 1
    }
  }
}
+
+ +

Note that to enable faceted search on your dataset you need to add genres to the filterableAttributes index setting. For more information on filtering and faceting, consult our documentation settings.

+

Abortable search

You can abort a pending search request by providing an AbortSignal to the request.

+
const controller = new AbortController()

index
  .search('wonder', {}, {
    signal: controller.signal,
  })
  .then((response) => {
    /** ... */
  })
  .catch((e) => {
    /** Catch AbortError here. */
  })

controller.abort()
+
+ +

Using Meilisearch behind a proxy

Custom request config

You can provide a custom request configuration. for example, with custom headers.

+
const client: MeiliSearch = new MeiliSearch({
  host: 'http://localhost:3000/api/meilisearch/proxy',
  requestConfig: {
    headers: {
      Authorization: AUTH_TOKEN
    },
    // OR
    credentials: 'include'
  }
})
+
+ +

Custom http client

You can use your own HTTP client, for example, with axios.

+
const client: MeiliSearch = new MeiliSearch({
  host: 'http://localhost:3000/api/meilisearch/proxy',
  httpClient: async (url, opts) => {
    const response = await $axios.request({
      url,
      data: opts?.body,
      headers: opts?.headers,
      method: (opts?.method?.toLocaleUpperCase() as Method) ?? 'GET'
    })

    return response.data
  }
})
+
+ +

🤖 Compatibility with Meilisearch

This package guarantees compatibility with version v1.x of Meilisearch, but some features may not be present. Please check the issues for more info.

+

💡 Learn more

The following sections in our main documentation website may interest you:

+ +

This repository also contains more examples.

+

⚙️ Contributing

We welcome all contributions, big and small! If you want to know more about this SDK's development workflow or want to contribute to the repo, please visit our contributing guidelines for detailed instructions.

+

📜 API resources

Search

Make a search request

client.index<T>('xxx').search(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>
+
+ +

Make a search request using the GET method (slower than the search method)

client.index<T>('xxx').searchGet(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>
+
+ +

Multi Search

Make multiple search requests

client.multiSearch(queries?: MultiSearchParams, config?: Partial<Request>): Promise<Promise<MultiSearchResponse<T>>>
+
+ +

multiSearch uses the POST method when performing its request to Meilisearch.

+

Search For Facet Values

Search for facet values

client.index<T>('myIndex').searchForFacetValues(params: SearchForFacetValuesParams, config?: Partial<Request>): Promise<SearchForFacetValuesResponse>
+
+ +

Documents

Add or replace multiple documents

client.index('myIndex').addDocuments(documents: Document<T>[]): Promise<EnqueuedTask>
+
+ +

Add or replace multiple documents in string format

client.index('myIndex').addDocumentsFromString(documents: string, contentType: ContentType, queryParams: RawDocumentAdditionOptions): Promise<EnqueuedTask>
+
+ +

Add or replace multiple documents in batches

client.index('myIndex').addDocumentsInBatches(documents: Document<T>[], batchSize = 1000): Promise<EnqueuedTask[]>
+
+ +

Add or update multiple documents

client.index('myIndex').updateDocuments(documents: Array<Document<Partial<T>>>): Promise<EnqueuedTask>
+
+ +

Add or update multiple documents in string format

client.index('myIndex').updateDocumentsFromString(documents: string, contentType: ContentType, queryParams: RawDocumentAdditionOptions): Promise<EnqueuedTask>
+
+ +

Add or update multiple documents in batches

client.index('myIndex').updateDocumentsInBatches(documents: Array<Document<Partial<T>>>, batchSize = 1000): Promise<EnqueuedTask[]>
+
+ +

Get Documents

client.index.getDocuments(parameters: DocumentsQuery = {}): Promise<DocumentsResults<T>>>
+
+ +

Get one document

client.index('myIndex').getDocument(documentId: string): Promise<Document<T>>
+
+ +

Delete one document

client.index('myIndex').deleteDocument(documentId: string | number): Promise<EnqueuedTask>
+
+ +

Delete multiple documents

client.index('myIndex').deleteDocuments(params: DocumentsDeletionQuery | DocumentsIds): Promise<EnqueuedTask>
+
+ +

Delete all documents

client.index('myIndex').deleteAllDocuments(): Promise<Types.EnqueuedTask>
+
+ +

Tasks

Get all tasks

client.getTasks(parameters: TasksQuery): Promise<TasksResults>
+
+ +

Get one task

client.getTask(uid: number): Promise<Task>
+
+ +

Delete tasks

client.deleteTasks(parameters: DeleteTasksQuery = {}): Promise<EnqueuedTask>
+
+ +

Cancel tasks

client.cancelTasks(parameters: CancelTasksQuery = {}): Promise<EnqueuedTask>
+
+ +

Get all tasks of an index

client.index('myIndex').getTasks(parameters: TasksQuery): Promise<TasksResults>
+
+ +

Get one task of an index

client.index('myIndex').getTask(uid: number): Promise<Task>
+
+ +

Wait for one task

Using the client
client.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>
+
+ +
Using the index
client.index('myIndex').waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>
+
+ +

Wait for multiple tasks

Using the client
client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>
+
+ +
Using the index
client.index('myIndex').waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>
+
+ +

Indexes

Get all indexes in Index instances

client.getIndexes(parameters: IndexesQuery): Promise<IndexesResults<Index[]>>
+
+ +

Get all indexes

client.getRawIndexes(parameters: IndexesQuery): Promise<IndexesResults<IndexObject[]>>
+
+ +

Create a new index

client.createIndex<T>(uid: string, options?: IndexOptions): Promise<EnqueuedTask>
+
+ +

Create a local reference to an index

client.index<T>(uid: string): Index<T>
+
+ +

Get an index instance completed with information fetched from Meilisearch

client.getIndex<T>(uid: string): Promise<Index<T>>
+
+ +

Get the raw index JSON response from Meilisearch

client.getRawIndex(uid: string): Promise<IndexObject>
+
+ +

Get an object with information about the index

client.index('myIndex').getRawInfo(): Promise<IndexObject>
+
+ +

Update Index

Using the client
client.updateIndex(uid: string, options: IndexOptions): Promise<EnqueuedTask>
+
+ +
Using the index object
client.index('myIndex').update(data: IndexOptions): Promise<EnqueuedTask>
+
+ +

Delete index

Using the client
client.deleteIndex(uid): Promise<void>
+
+ +
Using the index object
client.index('myIndex').delete(): Promise<void>
+
+ +

Get specific index stats

client.index('myIndex').getStats(): Promise<IndexStats>
+
+ +
Return Index instance with updated information
client.index('myIndex').fetchInfo(): Promise<Index>
+
+ +
Get Primary Key of an Index
client.index('myIndex').fetchPrimaryKey(): Promise<string | undefined>
+
+ +
Swap two indexes
client.swapIndexes(params: SwapIndexesParams): Promise<EnqueuedTask>
+
+ +

Settings

Get settings

client.index('myIndex').getSettings(): Promise<Settings>
+
+ +

Update settings

client.index('myIndex').updateSettings(settings: Settings): Promise<EnqueuedTask>
+
+ +

Reset settings

client.index('myIndex').resetSettings(): Promise<EnqueuedTask>
+
+ +

Pagination Settings

Get pagination

client.index('myIndex').getPagination(): Promise<PaginationSettings>
+
+ +

Update pagination

client.index('myIndex').updatePagination(pagination: PaginationSettings): Promise<EnqueuedTask>
+
+ +

Reset pagination

client.index('myIndex').resetPagination(): Promise<EnqueuedTask>
+
+ +

Synonyms

Get synonyms

client.index('myIndex').getSynonyms(): Promise<Synonyms>
+
+ +

Update synonyms

client.index('myIndex').updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask>
+
+ +

Reset synonyms

client.index('myIndex').resetSynonyms(): Promise<EnqueuedTask>
+
+ +

Stop words

Get stop words

client.index('myIndex').getStopWords(): Promise<string[]>
+
+ +

Update stop words

client.index('myIndex').updateStopWords(stopWords: string[] | null ): Promise<EnqueuedTask>
+
+ +

Reset stop words

client.index('myIndex').resetStopWords(): Promise<EnqueuedTask>
+
+ +

Ranking rules

Get ranking rules

client.index('myIndex').getRankingRules(): Promise<string[]>
+
+ +

Update ranking rules

client.index('myIndex').updateRankingRules(rankingRules: string[] | null): Promise<EnqueuedTask>
+
+ +

Reset ranking rules

client.index('myIndex').resetRankingRules(): Promise<EnqueuedTask>
+
+ +

Distinct Attribute

Get distinct attribute

client.index('myIndex').getDistinctAttribute(): Promise<string | void>
+
+ +

Update distinct attribute

client.index('myIndex').updateDistinctAttribute(distinctAttribute: string | null): Promise<EnqueuedTask>
+
+ +

Reset distinct attribute

client.index('myIndex').resetDistinctAttribute(): Promise<EnqueuedTask>
+
+ +

Searchable attributes

Get searchable attributes

client.index('myIndex').getSearchableAttributes(): Promise<string[]>
+
+ +

Update searchable attributes

client.index('myIndex').updateSearchableAttributes(searchableAttributes: string[] | null): Promise<EnqueuedTask>
+
+ +

Reset searchable attributes

client.index('myIndex').resetSearchableAttributes(): Promise<EnqueuedTask>
+
+ +

Displayed attributes

Get displayed attributes

client.index('myIndex').getDisplayedAttributes(): Promise<string[]>
+
+ +

Update displayed attributes

client.index('myIndex').updateDisplayedAttributes(displayedAttributes: string[] | null): Promise<EnqueuedTask>
+
+ +

Reset displayed attributes

client.index('myIndex').resetDisplayedAttributes(): Promise<EnqueuedTask>
+
+ +

Filterable attributes

Get filterable attributes

client.index('myIndex').getFilterableAttributes(): Promise<string[]>
+
+ +

Update filterable attributes

client.index('myIndex').updateFilterableAttributes(filterableAttributes: string[] | null): Promise<EnqueuedTask>
+
+ +

Reset filterable attributes

client.index('myIndex').resetFilterableAttributes(): Promise<EnqueuedTask>
+
+ +

Sortable attributes

Get sortable attributes

client.index('myIndex').getSortableAttributes(): Promise<string[]>
+
+ +

Update sortable attributes

client.index('myIndex').updateSortableAttributes(sortableAttributes: string[] | null): Promise<EnqueuedTask>
+
+ +

Reset sortable attributes

client.index('myIndex').resetSortableAttributes(): Promise<EnqueuedTask>
+
+ +

Faceting

Get faceting

client.index('myIndex').getFaceting(): Promise<Faceting>
+
+ +

Update faceting

client.index('myIndex').updateFaceting(faceting: Faceting): Promise<EnqueuedTask>
+
+ +

Reset faceting

client.index('myIndex').resetFaceting(): Promise<EnqueuedTask>
+
+ +

Typo tolerance

Get typo tolerance

client.index('myIndex').getTypoTolerance(): Promise<TypoTolerance>
+
+ +

Update typo tolerance

client.index('myIndex').updateTypoTolerance(typoTolerance: TypoTolerance | null): Promise<EnqueuedTask>
+
+ +

Reset typo tolerance

client.index('myIndex').resetTypoTolerance(): Promise<EnqueuedTask>
+
+ +

Separator tokens

Get separator tokens

client.index('myIndex').getSeparatorTokens(): Promise<SeparatorTokens>
+
+ +

Update separator tokens

client.index('myIndex').updateSeparatorTokens(separatorTokens: SeparatorTokens | null): Promise<EnqueuedTask>
+
+ +

Reset separator tokens

client.index('myIndex').resetSeparatorTokens(): Promise<EnqueuedTask>
+
+ +

Non Separator tokens

Get non separator tokens

client.index('myIndex').getNonSeparatorTokens(): Promise<NonSeparatorTokens>
+
+ +

Update non separator tokens

client.index('myIndex').updateNonSeparatorTokens(nonSeparatorTokens: NonSeparatorTokens | null): Promise<EnqueuedTask>
+
+ +

Reset non separator tokens

client.index('myIndex').resetNonSeparatorTokens(): Promise<EnqueuedTask>
+
+ +

Dictionary

Get dictionary

client.index('myIndex').getDictionary(): Promise<Dictionary>
+
+ +

Update dictionary

client.index('myIndex').updateDictionary(dictionary: Dictionary | null): Promise<EnqueuedTask>
+
+ +

Reset dictionary

client.index('myIndex').resetDictionary(): Promise<EnqueuedTask>
+
+ +

Proximity Precision

Get proximity precision

client.index('myIndex').getProximityPrecision(): Promise<ProximityPrecision>
+
+ +

Update proximity precision

client.index('myIndex').updateProximityPrecision(proximityPrecision: ProximityPrecision): Promise<EnqueuedTask>
+
+ +

Reset proximity precision

client.index('myIndex').resetProximityPrecision(): Promise<EnqueuedTask>
+
+ +

Embedders

⚠️ This feature is experimental. Activate the vectorStore experimental feature to use it

+

Get embedders

client.index('myIndex').getEmbedders(): Promise<Embedders>
+
+ +

Update embedders

client.index('myIndex').updateEmbedders(embedders: Embedders): Promise<EnqueuedTask>
+
+ +

Reset embedders

client.index('myIndex').resetEmbedders(): Promise<EnqueuedTask>
+
+ +

SearchCutoffMs

Get SearchCutoffMs

client.index('myIndex').getSearchCutoffMs(): Promise<SearchCutoffMs>
+
+ +

Update SearchCutoffMs

client.index('myIndex').updateSearchCutoffMs(searchCutoffMs: SearchCutoffMs): Promise<EnqueuedTask>
+
+ +

Reset SearchCutoffMs

client.index('myIndex').resetSearchCutoffMs(): Promise<EnqueuedTask>
+
+ +

Keys

Get keys

client.getKeys(parameters: KeysQuery): Promise<KeysResults>
+
+ +

Get one key

client.getKey(keyOrUid: string): Promise<Key>
+
+ +

Create a key

client.createKey(options: KeyCreation): Promise<Key>
+
+ +

Update a key

client.updateKey(keyOrUid: string, options: KeyUpdate): Promise<Key>
+
+ +

Delete a key

client.deleteKey(keyOrUid: string): Promise<void>
+
+ +

isHealthy

Return true or false depending on the health of the server

client.isHealthy(): Promise<boolean>
+
+ +

Health

Check if the server is healthy

client.health(): Promise<Health>
+
+ +

Stats

Get database stats

client.getStats(): Promise<Stats>
+
+ +

Version

Get binary version

client.getVersion(): Promise<Version>
+
+ +

Dumps

Trigger a dump creation process

client.createDump(): Promise<EnqueuedTask>
+
+ +

Snapshots

Trigger a snapshot on-demand process

client.createSnapshot(): Promise<EnqueuedTask>
+
+ +
+

Meilisearch provides and maintains many SDKs and integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. For a full overview of everything we create and maintain, take a look at the integration-guides repository.

+

Settings

Member Visibility

On This Page

Table of Contents <!-- omit in TOC -->📖 Documentation⚡ Supercharge your Meilisearch experience🔧 Installation🎬 Getting started🤖 Compatibility with Meilisearch💡 Learn more⚙️ Contributing📜 API resources
diff --git a/interfaces/FetchError.html b/interfaces/FetchError.html new file mode 100644 index 000000000..b03f40f24 --- /dev/null +++ b/interfaces/FetchError.html @@ -0,0 +1,8 @@ +FetchError | Meilisearch JS

Interface FetchError

interface FetchError {
    cause?: unknown;
    code: string;
    errno: string;
    message: string;
    name: string;
    stack?: string;
    type: string;
}

Hierarchy

  • Error
    • FetchError

Properties

cause? +code +errno +message +name +stack? +type +

Properties

Optionalcause

cause?: unknown

code

code: string

errno

errno: string

message

message: string

name

name: string

Optionalstack

stack?: string

type

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/modules.html b/modules.html new file mode 100644 index 000000000..185c6b98b --- /dev/null +++ b/modules.html @@ -0,0 +1,123 @@ +Meilisearch JS

Meilisearch JS

References

default +Meilisearch +

Classes

EnqueuedTask +Index +MeiliSearch +MeiliSearchApiError +MeiliSearchError +MeiliSearchRequestError +MeiliSearchTimeOutError +Task +TaskClient +

Interfaces

FetchError +

Type Aliases

CancelTasksQuery +CategoriesDistribution +Config +ContentType +Crop +DeleteTasksQuery +Dictionary +DisplayedAttributes +DistinctAttribute +Distribution +DocumentOptions +DocumentQuery +DocumentsDeletionQuery +DocumentsIds +DocumentsQuery +Embedder +Embedders +EnqueuedTaskObject +ErrorStatusCode +Facet +FacetDistribution +FacetHit +Faceting +FacetOrder +FacetsByIndex +FacetStat +FacetStats +FederatedMultiSearchParams +FederationDetails +FederationOptions +FieldDistribution +Filter +FilterableAttributes +Health +Highlight +Hit +Hits +HuggingFaceEmbedder +HybridSearch +IndexesQuery +IndexesResults +IndexObject +IndexOptions +IndexStats +Key +KeyCreation +KeysQuery +KeysResults +KeyUpdate +Locale +LocalizedAttribute +LocalizedAttributes +MatchesPosition +MatchingStrategies +MeiliSearchErrorResponse +MergeFacets +MultiSearchFederation +MultiSearchParams +MultiSearchQuery +MultiSearchQueryWithFederation +MultiSearchResponse +MultiSearchResult +NonSeparatorTokens +OllamaEmbedder +OpenAiEmbedder +Pagination +PaginationSettings +ProximityPrecision +Query +RankingRules +RankingScoreDetails +RawDocumentAdditionOptions +ResourceQuery +ResourceResults +RestEmbedder +SearchableAttributes +SearchCutoffMs +SearchForFacetValuesParams +SearchForFacetValuesResponse +SearchParams +SearchRequestGET +SearchResponse +SearchSimilarDocumentsParams +SeparatorTokens +Settings +SortableAttributes +Stats +StopWords +SwapIndexesParams +Synonyms +TaskObject +TasksQuery +TasksResults +TasksResultsObject +TaskStatus +TaskTypes +TokenIndexRules +TokenOptions +TokenSearchRules +TypoTolerance +UpdateDocumentsByFunctionOptions +UserProvidedEmbedder +Version +WaitOptions +

Variables

ContentTypeEnum +ErrorStatusCode +MatchingStrategies +TaskStatus +TaskTypes +

Functions

versionErrorHintMessage +

References

default

Renames and re-exports MeiliSearch

Meilisearch

Renames and re-exports MeiliSearch

Settings

Member Visibility

On This Page

References
diff --git a/types/CancelTasksQuery.html b/types/CancelTasksQuery.html new file mode 100644 index 000000000..97c58fed2 --- /dev/null +++ b/types/CancelTasksQuery.html @@ -0,0 +1 @@ +CancelTasksQuery | Meilisearch JS

Type Alias CancelTasksQuery

CancelTasksQuery: Omit<TasksQuery, "limit" | "from"> & {}

Settings

Member Visibility
diff --git a/types/CategoriesDistribution.html b/types/CategoriesDistribution.html new file mode 100644 index 000000000..d643a9ae6 --- /dev/null +++ b/types/CategoriesDistribution.html @@ -0,0 +1 @@ +CategoriesDistribution | Meilisearch JS

Type Alias CategoriesDistribution

CategoriesDistribution: {
    [category: string]: number;
}

Settings

Member Visibility
diff --git a/types/Config.html b/types/Config.html new file mode 100644 index 000000000..b44ae7575 --- /dev/null +++ b/types/Config.html @@ -0,0 +1 @@ +Config | Meilisearch JS

Type Alias Config

Config: {
    apiKey?: string;
    clientAgents?: string[];
    host: string;
    httpClient?: ((input: string, init?: RequestInit) => Promise<any>);
    requestConfig?: Partial<Omit<RequestInit, "body" | "method">>;
    timeout?: number;
}

Settings

Member Visibility
diff --git a/types/ContentType.html b/types/ContentType.html new file mode 100644 index 000000000..11255ad86 --- /dev/null +++ b/types/ContentType.html @@ -0,0 +1 @@ +ContentType | Meilisearch JS

Type Alias ContentType

ContentType: "text/csv" | "application/x-ndjson" | "application/json"

Settings

Member Visibility
diff --git a/types/Crop.html b/types/Crop.html new file mode 100644 index 000000000..746086ce0 --- /dev/null +++ b/types/Crop.html @@ -0,0 +1 @@ +Crop | Meilisearch JS

Type Alias Crop

Crop: {
    attributesToCrop?: string[];
    cropLength?: number;
    cropMarker?: string;
}

Settings

Member Visibility
diff --git a/types/DeleteTasksQuery.html b/types/DeleteTasksQuery.html new file mode 100644 index 000000000..c97061be8 --- /dev/null +++ b/types/DeleteTasksQuery.html @@ -0,0 +1 @@ +DeleteTasksQuery | Meilisearch JS

Type Alias DeleteTasksQuery

DeleteTasksQuery: Omit<TasksQuery, "limit" | "from"> & {}

Settings

Member Visibility
diff --git a/types/Dictionary.html b/types/Dictionary.html new file mode 100644 index 000000000..c7f99c405 --- /dev/null +++ b/types/Dictionary.html @@ -0,0 +1 @@ +Dictionary | Meilisearch JS

Type Alias Dictionary

Dictionary: string[] | null

Settings

Member Visibility
diff --git a/types/DisplayedAttributes.html b/types/DisplayedAttributes.html new file mode 100644 index 000000000..aa8606849 --- /dev/null +++ b/types/DisplayedAttributes.html @@ -0,0 +1 @@ +DisplayedAttributes | Meilisearch JS

Type Alias DisplayedAttributes

DisplayedAttributes: string[] | null

Settings

Member Visibility
diff --git a/types/DistinctAttribute.html b/types/DistinctAttribute.html new file mode 100644 index 000000000..7d6a36ff1 --- /dev/null +++ b/types/DistinctAttribute.html @@ -0,0 +1 @@ +DistinctAttribute | Meilisearch JS

Type Alias DistinctAttribute

DistinctAttribute: string | null

Settings

Member Visibility
diff --git a/types/Distribution.html b/types/Distribution.html new file mode 100644 index 000000000..c459e2b37 --- /dev/null +++ b/types/Distribution.html @@ -0,0 +1 @@ +Distribution | Meilisearch JS

Type Alias Distribution

Distribution: {
    mean: number;
    sigma: number;
}

Settings

Member Visibility
diff --git a/types/DocumentOptions.html b/types/DocumentOptions.html new file mode 100644 index 000000000..57220626a --- /dev/null +++ b/types/DocumentOptions.html @@ -0,0 +1 @@ +DocumentOptions | Meilisearch JS

Type Alias DocumentOptions

DocumentOptions: {
    primaryKey?: string;
}

Settings

Member Visibility
diff --git a/types/DocumentQuery.html b/types/DocumentQuery.html new file mode 100644 index 000000000..686bb4476 --- /dev/null +++ b/types/DocumentQuery.html @@ -0,0 +1 @@ +DocumentQuery | Meilisearch JS

Type Alias DocumentQuery<T>

DocumentQuery<T>: {
    fields?: Fields<T>;
}

Type Parameters

  • T = Record<string, any>

Settings

Member Visibility
diff --git a/types/DocumentsDeletionQuery.html b/types/DocumentsDeletionQuery.html new file mode 100644 index 000000000..419e8514c --- /dev/null +++ b/types/DocumentsDeletionQuery.html @@ -0,0 +1 @@ +DocumentsDeletionQuery | Meilisearch JS

Type Alias DocumentsDeletionQuery

DocumentsDeletionQuery: {
    filter: Filter;
}

Settings

Member Visibility
diff --git a/types/DocumentsIds.html b/types/DocumentsIds.html new file mode 100644 index 000000000..140b2d944 --- /dev/null +++ b/types/DocumentsIds.html @@ -0,0 +1 @@ +DocumentsIds | Meilisearch JS

Type Alias DocumentsIds

DocumentsIds: string[] | number[]

Settings

Member Visibility
diff --git a/types/DocumentsQuery.html b/types/DocumentsQuery.html new file mode 100644 index 000000000..6bcd1db7c --- /dev/null +++ b/types/DocumentsQuery.html @@ -0,0 +1 @@ +DocumentsQuery | Meilisearch JS

Type Alias DocumentsQuery<T>

DocumentsQuery<T>: ResourceQuery & {
    fields?: Fields<T>;
    filter?: Filter;
    limit?: number;
    offset?: number;
    retrieveVectors?: boolean;
}

Type Parameters

  • T = Record<string, any>

Settings

Member Visibility
diff --git a/types/Embedder.html b/types/Embedder.html new file mode 100644 index 000000000..b747bdd44 --- /dev/null +++ b/types/Embedder.html @@ -0,0 +1 @@ +Embedder | Meilisearch JS

Type Alias Embedder

Embedder:
    | OpenAiEmbedder
    | HuggingFaceEmbedder
    | UserProvidedEmbedder
    | RestEmbedder
    | OllamaEmbedder
    | null

Settings

Member Visibility
diff --git a/types/Embedders.html b/types/Embedders.html new file mode 100644 index 000000000..d90ca5a4b --- /dev/null +++ b/types/Embedders.html @@ -0,0 +1 @@ +Embedders | Meilisearch JS

Type Alias Embedders

Embedders: Record<string, Embedder> | null

Settings

Member Visibility
diff --git a/types/EnqueuedTaskObject.html b/types/EnqueuedTaskObject.html new file mode 100644 index 000000000..ad8774eb8 --- /dev/null +++ b/types/EnqueuedTaskObject.html @@ -0,0 +1 @@ +EnqueuedTaskObject | Meilisearch JS

Type Alias EnqueuedTaskObject

EnqueuedTaskObject: {
    canceledBy: number;
    enqueuedAt: string;
    indexUid?: string;
    status: TaskStatus;
    taskUid: number;
    type: TaskTypes;
}

Settings

Member Visibility
diff --git a/types/ErrorStatusCode.html b/types/ErrorStatusCode.html new file mode 100644 index 000000000..93de6f8c5 --- /dev/null +++ b/types/ErrorStatusCode.html @@ -0,0 +1 @@ +ErrorStatusCode | Meilisearch JS

Type Alias ErrorStatusCode

ErrorStatusCode: typeof ErrorStatusCode[keyof typeof ErrorStatusCode]

Settings

Member Visibility
diff --git a/types/Facet.html b/types/Facet.html new file mode 100644 index 000000000..e13e7fb60 --- /dev/null +++ b/types/Facet.html @@ -0,0 +1 @@ +Facet | Meilisearch JS

Type Alias Facet

Facet: string

Settings

Member Visibility
diff --git a/types/FacetDistribution.html b/types/FacetDistribution.html new file mode 100644 index 000000000..815d0d9f7 --- /dev/null +++ b/types/FacetDistribution.html @@ -0,0 +1 @@ +FacetDistribution | Meilisearch JS

Type Alias FacetDistribution

FacetDistribution: Record<Facet, CategoriesDistribution>

Settings

Member Visibility
diff --git a/types/FacetHit.html b/types/FacetHit.html new file mode 100644 index 000000000..745543a0d --- /dev/null +++ b/types/FacetHit.html @@ -0,0 +1 @@ +FacetHit | Meilisearch JS

Type Alias FacetHit

FacetHit: {
    count: number;
    value: string;
}

Settings

Member Visibility
diff --git a/types/FacetOrder.html b/types/FacetOrder.html new file mode 100644 index 000000000..8216a2c13 --- /dev/null +++ b/types/FacetOrder.html @@ -0,0 +1 @@ +FacetOrder | Meilisearch JS

Type Alias FacetOrder

FacetOrder: "alpha" | "count"

Settings

Member Visibility
diff --git a/types/FacetStat.html b/types/FacetStat.html new file mode 100644 index 000000000..8df440cd5 --- /dev/null +++ b/types/FacetStat.html @@ -0,0 +1 @@ +FacetStat | Meilisearch JS

Type Alias FacetStat

FacetStat: {
    max: number;
    min: number;
}

Settings

Member Visibility
diff --git a/types/FacetStats.html b/types/FacetStats.html new file mode 100644 index 000000000..00e87c1bc --- /dev/null +++ b/types/FacetStats.html @@ -0,0 +1 @@ +FacetStats | Meilisearch JS

Type Alias FacetStats

FacetStats: Record<string, FacetStat>

Settings

Member Visibility
diff --git a/types/Faceting.html b/types/Faceting.html new file mode 100644 index 000000000..9672368da --- /dev/null +++ b/types/Faceting.html @@ -0,0 +1 @@ +Faceting | Meilisearch JS

Type Alias Faceting

Faceting: {
    maxValuesPerFacet?: number | null;
    sortFacetValuesBy?: Record<string, FacetOrder> | null;
}

Settings

Member Visibility
diff --git a/types/FacetsByIndex.html b/types/FacetsByIndex.html new file mode 100644 index 000000000..6f723d551 --- /dev/null +++ b/types/FacetsByIndex.html @@ -0,0 +1 @@ +FacetsByIndex | Meilisearch JS

Type Alias FacetsByIndex

FacetsByIndex: Record<string, {
    distribution: FacetDistribution;
    stats: FacetStats;
}>

Settings

Member Visibility
diff --git a/types/FederatedMultiSearchParams.html b/types/FederatedMultiSearchParams.html new file mode 100644 index 000000000..46b587a31 --- /dev/null +++ b/types/FederatedMultiSearchParams.html @@ -0,0 +1 @@ +FederatedMultiSearchParams | Meilisearch JS

Type Alias FederatedMultiSearchParams

FederatedMultiSearchParams: {
    federation: MultiSearchFederation;
    queries: MultiSearchQueryWithFederation[];
}

Settings

Member Visibility
diff --git a/types/FederationDetails.html b/types/FederationDetails.html new file mode 100644 index 000000000..92961dc45 --- /dev/null +++ b/types/FederationDetails.html @@ -0,0 +1 @@ +FederationDetails | Meilisearch JS

Type Alias FederationDetails

FederationDetails: {
    indexUid: string;
    queriesPosition: number;
    weightedRankingScore: number;
}

Settings

Member Visibility
diff --git a/types/FederationOptions.html b/types/FederationOptions.html new file mode 100644 index 000000000..2a1f92535 --- /dev/null +++ b/types/FederationOptions.html @@ -0,0 +1 @@ +FederationOptions | Meilisearch JS

Type Alias FederationOptions

FederationOptions: {
    weight: number;
}

Settings

Member Visibility
diff --git a/types/FieldDistribution.html b/types/FieldDistribution.html new file mode 100644 index 000000000..5dd2ed19e --- /dev/null +++ b/types/FieldDistribution.html @@ -0,0 +1 @@ +FieldDistribution | Meilisearch JS

Type Alias FieldDistribution

FieldDistribution: {
    [field: string]: number;
}

Settings

Member Visibility
diff --git a/types/Filter.html b/types/Filter.html new file mode 100644 index 000000000..4f5b9a128 --- /dev/null +++ b/types/Filter.html @@ -0,0 +1 @@ +Filter | Meilisearch JS

Type Alias Filter

Filter: string | (string | string[])[]

Settings

Member Visibility
diff --git a/types/FilterableAttributes.html b/types/FilterableAttributes.html new file mode 100644 index 000000000..6888b1568 --- /dev/null +++ b/types/FilterableAttributes.html @@ -0,0 +1 @@ +FilterableAttributes | Meilisearch JS

Type Alias FilterableAttributes

FilterableAttributes: string[] | null

Settings

Member Visibility
diff --git a/types/Health.html b/types/Health.html new file mode 100644 index 000000000..271ea9199 --- /dev/null +++ b/types/Health.html @@ -0,0 +1 @@ +Health | Meilisearch JS

Type Alias Health

Health: {
    status: "available";
}

Settings

Member Visibility
diff --git a/types/Highlight.html b/types/Highlight.html new file mode 100644 index 000000000..1965d7c49 --- /dev/null +++ b/types/Highlight.html @@ -0,0 +1 @@ +Highlight | Meilisearch JS

Type Alias Highlight

Highlight: {
    attributesToHighlight?: string[];
    highlightPostTag?: string;
    highlightPreTag?: string;
}

Settings

Member Visibility
diff --git a/types/Hit.html b/types/Hit.html new file mode 100644 index 000000000..adfe3973e --- /dev/null +++ b/types/Hit.html @@ -0,0 +1 @@ +Hit | Meilisearch JS

Type Alias Hit<T>

Hit<T>: T & {
    _federation?: FederationDetails;
    _formatted?: Partial<T>;
    _matchesPosition?: MatchesPosition<T>;
    _rankingScore?: number;
    _rankingScoreDetails?: RankingScoreDetails;
}

Type Parameters

  • T = Record<string, any>

Settings

Member Visibility
diff --git a/types/Hits.html b/types/Hits.html new file mode 100644 index 000000000..4ca181e48 --- /dev/null +++ b/types/Hits.html @@ -0,0 +1 @@ +Hits | Meilisearch JS

Type Alias Hits<T>

Hits<T>: Hit<T>[]

Type Parameters

  • T = Record<string, any>

Settings

Member Visibility
diff --git a/types/HuggingFaceEmbedder.html b/types/HuggingFaceEmbedder.html new file mode 100644 index 000000000..abbccea7c --- /dev/null +++ b/types/HuggingFaceEmbedder.html @@ -0,0 +1 @@ +HuggingFaceEmbedder | Meilisearch JS

Type Alias HuggingFaceEmbedder

HuggingFaceEmbedder: {
    binaryQuantized?: boolean;
    distribution?: Distribution;
    documentTemplate?: string;
    documentTemplateMaxBytes?: number;
    model?: string;
    revision?: string;
    source: "huggingFace";
}

Settings

Member Visibility
diff --git a/types/HybridSearch.html b/types/HybridSearch.html new file mode 100644 index 000000000..5d9861126 --- /dev/null +++ b/types/HybridSearch.html @@ -0,0 +1 @@ +HybridSearch | Meilisearch JS

Type Alias HybridSearch

HybridSearch: {
    embedder: string;
    semanticRatio?: number;
}

Settings

Member Visibility
diff --git a/types/IndexObject.html b/types/IndexObject.html new file mode 100644 index 000000000..707dd3cac --- /dev/null +++ b/types/IndexObject.html @@ -0,0 +1 @@ +IndexObject | Meilisearch JS

Type Alias IndexObject

IndexObject: {
    createdAt: Date;
    primaryKey?: string;
    uid: string;
    updatedAt: Date;
}

Settings

Member Visibility
diff --git a/types/IndexOptions.html b/types/IndexOptions.html new file mode 100644 index 000000000..5180ec8b7 --- /dev/null +++ b/types/IndexOptions.html @@ -0,0 +1 @@ +IndexOptions | Meilisearch JS

Type Alias IndexOptions

IndexOptions: {
    primaryKey?: string;
}

Settings

Member Visibility
diff --git a/types/IndexStats.html b/types/IndexStats.html new file mode 100644 index 000000000..3d444a10a --- /dev/null +++ b/types/IndexStats.html @@ -0,0 +1 @@ +IndexStats | Meilisearch JS

Type Alias IndexStats

IndexStats: {
    fieldDistribution: FieldDistribution;
    isIndexing: boolean;
    numberOfDocuments: number;
}

Settings

Member Visibility
diff --git a/types/IndexesQuery.html b/types/IndexesQuery.html new file mode 100644 index 000000000..ab94c8d44 --- /dev/null +++ b/types/IndexesQuery.html @@ -0,0 +1 @@ +IndexesQuery | Meilisearch JS

Type Alias IndexesQuery

IndexesQuery: ResourceQuery & {}

Settings

Member Visibility
diff --git a/types/IndexesResults.html b/types/IndexesResults.html new file mode 100644 index 000000000..fcc807ba7 --- /dev/null +++ b/types/IndexesResults.html @@ -0,0 +1 @@ +IndexesResults | Meilisearch JS

Type Alias IndexesResults<T>

IndexesResults<T>: ResourceResults<T> & {}

Type Parameters

  • T

Settings

Member Visibility
diff --git a/types/Key.html b/types/Key.html new file mode 100644 index 000000000..f76ce457d --- /dev/null +++ b/types/Key.html @@ -0,0 +1 @@ +Key | Meilisearch JS

Type Alias Key

Key: {
    actions: string[];
    createdAt: Date;
    description: string;
    expiresAt: Date;
    indexes: string[];
    key: string;
    name: string | null;
    uid: string;
    updatedAt: Date;
}

Settings

Member Visibility
diff --git a/types/KeyCreation.html b/types/KeyCreation.html new file mode 100644 index 000000000..f9425a63b --- /dev/null +++ b/types/KeyCreation.html @@ -0,0 +1 @@ +KeyCreation | Meilisearch JS

Type Alias KeyCreation

KeyCreation: {
    actions: string[];
    description?: string;
    expiresAt: Date | null;
    indexes: string[];
    name?: string;
    uid?: string;
}

Settings

Member Visibility
diff --git a/types/KeyUpdate.html b/types/KeyUpdate.html new file mode 100644 index 000000000..fb359dfa8 --- /dev/null +++ b/types/KeyUpdate.html @@ -0,0 +1 @@ +KeyUpdate | Meilisearch JS

Type Alias KeyUpdate

KeyUpdate: {
    description?: string;
    name?: string;
}

Settings

Member Visibility
diff --git a/types/KeysQuery.html b/types/KeysQuery.html new file mode 100644 index 000000000..861c2b57c --- /dev/null +++ b/types/KeysQuery.html @@ -0,0 +1 @@ +KeysQuery | Meilisearch JS

Type Alias KeysQuery

KeysQuery: ResourceQuery & {}

Settings

Member Visibility
diff --git a/types/KeysResults.html b/types/KeysResults.html new file mode 100644 index 000000000..4baa61440 --- /dev/null +++ b/types/KeysResults.html @@ -0,0 +1 @@ +KeysResults | Meilisearch JS

Type Alias KeysResults

KeysResults: ResourceResults<Key[]> & {}

Settings

Member Visibility
diff --git a/types/Locale.html b/types/Locale.html new file mode 100644 index 000000000..bf27c7e83 --- /dev/null +++ b/types/Locale.html @@ -0,0 +1 @@ +Locale | Meilisearch JS

Type Alias Locale

Locale: string

Settings

Member Visibility
diff --git a/types/LocalizedAttribute.html b/types/LocalizedAttribute.html new file mode 100644 index 000000000..9ff3559e2 --- /dev/null +++ b/types/LocalizedAttribute.html @@ -0,0 +1 @@ +LocalizedAttribute | Meilisearch JS

Type Alias LocalizedAttribute

LocalizedAttribute: {
    attributePatterns: string[];
    locales: Locale[];
}

Settings

Member Visibility
diff --git a/types/LocalizedAttributes.html b/types/LocalizedAttributes.html new file mode 100644 index 000000000..d07db4b6f --- /dev/null +++ b/types/LocalizedAttributes.html @@ -0,0 +1 @@ +LocalizedAttributes | Meilisearch JS

Type Alias LocalizedAttributes

LocalizedAttributes: LocalizedAttribute[] | null

Settings

Member Visibility
diff --git a/types/MatchesPosition.html b/types/MatchesPosition.html new file mode 100644 index 000000000..10e1f2e21 --- /dev/null +++ b/types/MatchesPosition.html @@ -0,0 +1 @@ +MatchesPosition | Meilisearch JS

Type Alias MatchesPosition<T>

MatchesPosition<T>: Partial<Record<keyof T, {
    length: number;
    start: number;
}[]>>

Type Parameters

  • T

Settings

Member Visibility
diff --git a/types/MatchingStrategies.html b/types/MatchingStrategies.html new file mode 100644 index 000000000..c6b49cf74 --- /dev/null +++ b/types/MatchingStrategies.html @@ -0,0 +1 @@ +MatchingStrategies | Meilisearch JS

Type Alias MatchingStrategies

MatchingStrategies: typeof MatchingStrategies[keyof typeof MatchingStrategies]

Settings

Member Visibility
diff --git a/types/MeiliSearchErrorResponse.html b/types/MeiliSearchErrorResponse.html new file mode 100644 index 000000000..daf58320b --- /dev/null +++ b/types/MeiliSearchErrorResponse.html @@ -0,0 +1 @@ +MeiliSearchErrorResponse | Meilisearch JS

Type Alias MeiliSearchErrorResponse

MeiliSearchErrorResponse: {
    code: string;
    link: string;
    message: string;
    type: string;
}

Settings

Member Visibility
diff --git a/types/MergeFacets.html b/types/MergeFacets.html new file mode 100644 index 000000000..5ea63c9f2 --- /dev/null +++ b/types/MergeFacets.html @@ -0,0 +1 @@ +MergeFacets | Meilisearch JS

Type Alias MergeFacets

MergeFacets: {
    maxValuesPerFacet?: number | null;
}

Settings

Member Visibility
diff --git a/types/MultiSearchFederation.html b/types/MultiSearchFederation.html new file mode 100644 index 000000000..11878806f --- /dev/null +++ b/types/MultiSearchFederation.html @@ -0,0 +1 @@ +MultiSearchFederation | Meilisearch JS

Type Alias MultiSearchFederation

MultiSearchFederation: {
    facetsByIndex?: Record<string, string[]>;
    limit?: number;
    mergeFacets?: MergeFacets | null;
    offset?: number;
}

Settings

Member Visibility
diff --git a/types/MultiSearchParams.html b/types/MultiSearchParams.html new file mode 100644 index 000000000..ffaee870a --- /dev/null +++ b/types/MultiSearchParams.html @@ -0,0 +1 @@ +MultiSearchParams | Meilisearch JS

Type Alias MultiSearchParams

MultiSearchParams: {
    queries: MultiSearchQuery[];
}

Settings

Member Visibility
diff --git a/types/MultiSearchQuery.html b/types/MultiSearchQuery.html new file mode 100644 index 000000000..ce7f2b08c --- /dev/null +++ b/types/MultiSearchQuery.html @@ -0,0 +1 @@ +MultiSearchQuery | Meilisearch JS

Type Alias MultiSearchQuery

MultiSearchQuery: SearchParams & {
    indexUid: string;
}

Settings

Member Visibility
diff --git a/types/MultiSearchQueryWithFederation.html b/types/MultiSearchQueryWithFederation.html new file mode 100644 index 000000000..562e4d152 --- /dev/null +++ b/types/MultiSearchQueryWithFederation.html @@ -0,0 +1 @@ +MultiSearchQueryWithFederation | Meilisearch JS

Type Alias MultiSearchQueryWithFederation

MultiSearchQueryWithFederation: MultiSearchQuery & {
    federationOptions?: FederationOptions;
}

Settings

Member Visibility
diff --git a/types/MultiSearchResponse.html b/types/MultiSearchResponse.html new file mode 100644 index 000000000..650952097 --- /dev/null +++ b/types/MultiSearchResponse.html @@ -0,0 +1 @@ +MultiSearchResponse | Meilisearch JS

Type Alias MultiSearchResponse<T>

MultiSearchResponse<T>: {
    results: MultiSearchResult<T>[];
}

Type Parameters

  • T = Record<string, any>

Settings

Member Visibility
diff --git a/types/MultiSearchResult.html b/types/MultiSearchResult.html new file mode 100644 index 000000000..74193de0f --- /dev/null +++ b/types/MultiSearchResult.html @@ -0,0 +1 @@ +MultiSearchResult | Meilisearch JS

Type Alias MultiSearchResult<T>

MultiSearchResult<T>: SearchResponse<T> & {
    indexUid: string;
}

Type Parameters

  • T

Settings

Member Visibility
diff --git a/types/NonSeparatorTokens.html b/types/NonSeparatorTokens.html new file mode 100644 index 000000000..8c181bfed --- /dev/null +++ b/types/NonSeparatorTokens.html @@ -0,0 +1 @@ +NonSeparatorTokens | Meilisearch JS

Type Alias NonSeparatorTokens

NonSeparatorTokens: string[] | null

Settings

Member Visibility
diff --git a/types/OllamaEmbedder.html b/types/OllamaEmbedder.html new file mode 100644 index 000000000..91b7a6a3b --- /dev/null +++ b/types/OllamaEmbedder.html @@ -0,0 +1 @@ +OllamaEmbedder | Meilisearch JS

Type Alias OllamaEmbedder

OllamaEmbedder: {
    apiKey?: string;
    binaryQuantized?: boolean;
    dimensions?: number;
    distribution?: Distribution;
    documentTemplate?: string;
    documentTemplateMaxBytes?: number;
    model?: string;
    source: "ollama";
    url?: string;
}

Settings

Member Visibility
diff --git a/types/OpenAiEmbedder.html b/types/OpenAiEmbedder.html new file mode 100644 index 000000000..3859ad99e --- /dev/null +++ b/types/OpenAiEmbedder.html @@ -0,0 +1 @@ +OpenAiEmbedder | Meilisearch JS

Type Alias OpenAiEmbedder

OpenAiEmbedder: {
    apiKey?: string;
    binaryQuantized?: boolean;
    dimensions?: number;
    distribution?: Distribution;
    documentTemplate?: string;
    documentTemplateMaxBytes?: number;
    model?: string;
    source: "openAi";
    url?: string;
}

Settings

Member Visibility
diff --git a/types/Pagination.html b/types/Pagination.html new file mode 100644 index 000000000..b7c7dd432 --- /dev/null +++ b/types/Pagination.html @@ -0,0 +1 @@ +Pagination | Meilisearch JS

Type Alias Pagination

Pagination: {
    limit?: number;
    offset?: number;
}

Settings

Member Visibility
diff --git a/types/PaginationSettings.html b/types/PaginationSettings.html new file mode 100644 index 000000000..29871b91d --- /dev/null +++ b/types/PaginationSettings.html @@ -0,0 +1 @@ +PaginationSettings | Meilisearch JS

Type Alias PaginationSettings

PaginationSettings: {
    maxTotalHits?: number | null;
}

Settings

Member Visibility
diff --git a/types/ProximityPrecision.html b/types/ProximityPrecision.html new file mode 100644 index 000000000..5bef6bd37 --- /dev/null +++ b/types/ProximityPrecision.html @@ -0,0 +1 @@ +ProximityPrecision | Meilisearch JS

Type Alias ProximityPrecision

ProximityPrecision: "byWord" | "byAttribute"

Settings

Member Visibility
diff --git a/types/Query.html b/types/Query.html new file mode 100644 index 000000000..5db91a521 --- /dev/null +++ b/types/Query.html @@ -0,0 +1 @@ +Query | Meilisearch JS

Type Alias Query

Query: {
    q?: string | null;
}

Settings

Member Visibility
diff --git a/types/RankingRules.html b/types/RankingRules.html new file mode 100644 index 000000000..68d063e94 --- /dev/null +++ b/types/RankingRules.html @@ -0,0 +1 @@ +RankingRules | Meilisearch JS

Type Alias RankingRules

RankingRules: string[] | null

Settings

Member Visibility
diff --git a/types/RankingScoreDetails.html b/types/RankingScoreDetails.html new file mode 100644 index 000000000..10cca3682 --- /dev/null +++ b/types/RankingScoreDetails.html @@ -0,0 +1 @@ +RankingScoreDetails | Meilisearch JS

Type Alias RankingScoreDetails

RankingScoreDetails: {
    attribute?: {
        attributes_query_word_order: number;
        attributes_ranking_order: number;
        order: number;
        score: number;
    };
    exactness?: {
        matchType: string;
        order: number;
        score: number;
    };
    proximity?: {
        order: number;
        score: number;
    };
    typo?: {
        maxTypoCount: number;
        order: number;
        score: number;
        typoCount: number;
    };
    words?: {
        matchingWords: number;
        maxMatchingWords: number;
        order: number;
        score: number;
    };
    [key: string]: Record<string, any> | undefined;
}

Settings

Member Visibility
diff --git a/types/RawDocumentAdditionOptions.html b/types/RawDocumentAdditionOptions.html new file mode 100644 index 000000000..ab65c442b --- /dev/null +++ b/types/RawDocumentAdditionOptions.html @@ -0,0 +1 @@ +RawDocumentAdditionOptions | Meilisearch JS

Type Alias RawDocumentAdditionOptions

RawDocumentAdditionOptions: DocumentOptions & {
    csvDelimiter?: string;
}

Settings

Member Visibility
diff --git a/types/ResourceQuery.html b/types/ResourceQuery.html new file mode 100644 index 000000000..ad5fdb6bb --- /dev/null +++ b/types/ResourceQuery.html @@ -0,0 +1 @@ +ResourceQuery | Meilisearch JS

Type Alias ResourceQuery

ResourceQuery: Pagination & {}

Settings

Member Visibility
diff --git a/types/ResourceResults.html b/types/ResourceResults.html new file mode 100644 index 000000000..e68f702dc --- /dev/null +++ b/types/ResourceResults.html @@ -0,0 +1 @@ +ResourceResults | Meilisearch JS

Type Alias ResourceResults<T>

ResourceResults<T>: Pagination & {
    results: T;
    total: number;
}

Type Parameters

  • T

Settings

Member Visibility
diff --git a/types/RestEmbedder.html b/types/RestEmbedder.html new file mode 100644 index 000000000..1f01317d7 --- /dev/null +++ b/types/RestEmbedder.html @@ -0,0 +1 @@ +RestEmbedder | Meilisearch JS

Type Alias RestEmbedder

RestEmbedder: {
    apiKey?: string;
    binaryQuantized?: boolean;
    dimensions?: number;
    distribution?: Distribution;
    documentTemplate?: string;
    documentTemplateMaxBytes?: number;
    headers?: Record<string, string>;
    request: Record<string, any>;
    response: Record<string, any>;
    source: "rest";
    url: string;
}

Settings

Member Visibility
diff --git a/types/SearchCutoffMs.html b/types/SearchCutoffMs.html new file mode 100644 index 000000000..066edad60 --- /dev/null +++ b/types/SearchCutoffMs.html @@ -0,0 +1 @@ +SearchCutoffMs | Meilisearch JS

Type Alias SearchCutoffMs

SearchCutoffMs: number | null

Settings

Member Visibility
diff --git a/types/SearchForFacetValuesParams.html b/types/SearchForFacetValuesParams.html new file mode 100644 index 000000000..129896c7b --- /dev/null +++ b/types/SearchForFacetValuesParams.html @@ -0,0 +1 @@ +SearchForFacetValuesParams | Meilisearch JS

Type Alias SearchForFacetValuesParams

SearchForFacetValuesParams: Omit<SearchParams, "facetName"> & {
    facetName: string;
}

Settings

Member Visibility
diff --git a/types/SearchForFacetValuesResponse.html b/types/SearchForFacetValuesResponse.html new file mode 100644 index 000000000..930b20b73 --- /dev/null +++ b/types/SearchForFacetValuesResponse.html @@ -0,0 +1 @@ +SearchForFacetValuesResponse | Meilisearch JS

Type Alias SearchForFacetValuesResponse

SearchForFacetValuesResponse: {
    facetHits: FacetHit[];
    facetQuery: string | null;
    processingTimeMs: number;
}

Settings

Member Visibility
diff --git a/types/SearchParams.html b/types/SearchParams.html new file mode 100644 index 000000000..7f28003c5 --- /dev/null +++ b/types/SearchParams.html @@ -0,0 +1 @@ +SearchParams | Meilisearch JS

Type Alias SearchParams

SearchParams: Query & Pagination & Highlight & Crop & {
    attributesToRetrieve?: string[];
    attributesToSearchOn?: string[] | null;
    distinct?: string;
    facetName?: string;
    facetQuery?: string;
    facets?: string[];
    filter?: Filter;
    hitsPerPage?: number;
    hybrid?: HybridSearch;
    locales?: Locale[];
    matchingStrategy?: MatchingStrategies;
    page?: number;
    rankingScoreThreshold?: number;
    retrieveVectors?: boolean;
    showMatchesPosition?: boolean;
    showRankingScore?: boolean;
    showRankingScoreDetails?: boolean;
    sort?: string[];
    vector?: number[] | null;
}

Settings

Member Visibility
diff --git a/types/SearchRequestGET.html b/types/SearchRequestGET.html new file mode 100644 index 000000000..59fd901de --- /dev/null +++ b/types/SearchRequestGET.html @@ -0,0 +1 @@ +SearchRequestGET | Meilisearch JS

Type Alias SearchRequestGET

SearchRequestGET: Pagination & Query & Omit<Highlight, "attributesToHighlight"> & Omit<Crop, "attributesToCrop"> & {
    attributesToCrop?: string;
    attributesToHighlight?: string;
    attributesToRetrieve?: string;
    attributesToSearchOn?: string | null;
    distinct?: string;
    facets?: string;
    filter?: string;
    hybridEmbedder?: string;
    hybridSemanticRatio?: number;
    locales?: Locale[];
    rankingScoreThreshold?: number;
    retrieveVectors?: boolean;
    showMatchesPosition?: boolean;
    sort?: string;
    vector?: string | null;
}

Settings

Member Visibility
diff --git a/types/SearchResponse.html b/types/SearchResponse.html new file mode 100644 index 000000000..590e4edd6 --- /dev/null +++ b/types/SearchResponse.html @@ -0,0 +1 @@ +SearchResponse | Meilisearch JS

Type Alias SearchResponse<T, S>

SearchResponse<T, S>: {
    facetDistribution?: FacetDistribution;
    facetsByIndex?: FacetsByIndex;
    facetStats?: FacetStats;
    hits: Hits<T>;
    processingTimeMs: number;
    query: string;
} & (undefined extends S
    ? Partial<FinitePagination & InfinitePagination>
    : true extends IsFinitePagination<NonNullable<S>>
        ? FinitePagination
        : InfinitePagination)

Type Parameters

  • T = Record<string, any>
  • S extends SearchParams | undefined = undefined

Settings

Member Visibility
diff --git a/types/SearchSimilarDocumentsParams.html b/types/SearchSimilarDocumentsParams.html new file mode 100644 index 000000000..0d63382f6 --- /dev/null +++ b/types/SearchSimilarDocumentsParams.html @@ -0,0 +1 @@ +SearchSimilarDocumentsParams | Meilisearch JS

Type Alias SearchSimilarDocumentsParams

SearchSimilarDocumentsParams: {
    attributesToRetrieve?: string[];
    embedder?: string;
    filter?: Filter;
    id: string | number;
    limit?: number;
    offset?: number;
    rankingScoreThreshold?: number;
    showRankingScore?: boolean;
    showRankingScoreDetails?: boolean;
}

Settings

Member Visibility
diff --git a/types/SearchableAttributes.html b/types/SearchableAttributes.html new file mode 100644 index 000000000..ebabf2d2d --- /dev/null +++ b/types/SearchableAttributes.html @@ -0,0 +1 @@ +SearchableAttributes | Meilisearch JS

Type Alias SearchableAttributes

SearchableAttributes: string[] | null

Settings

Member Visibility
diff --git a/types/SeparatorTokens.html b/types/SeparatorTokens.html new file mode 100644 index 000000000..d0a675b9a --- /dev/null +++ b/types/SeparatorTokens.html @@ -0,0 +1 @@ +SeparatorTokens | Meilisearch JS

Type Alias SeparatorTokens

SeparatorTokens: string[] | null

Settings

Member Visibility
diff --git a/types/Settings.html b/types/Settings.html new file mode 100644 index 000000000..72649d37d --- /dev/null +++ b/types/Settings.html @@ -0,0 +1 @@ +Settings | Meilisearch JS

Type Alias Settings

Settings: {
    dictionary?: Dictionary;
    displayedAttributes?: DisplayedAttributes;
    distinctAttribute?: DistinctAttribute;
    embedders?: Embedders;
    faceting?: Faceting;
    filterableAttributes?: FilterableAttributes;
    localizedAttributes?: LocalizedAttributes;
    nonSeparatorTokens?: NonSeparatorTokens;
    pagination?: PaginationSettings;
    proximityPrecision?: ProximityPrecision;
    rankingRules?: RankingRules;
    searchableAttributes?: SearchableAttributes;
    searchCutoffMs?: SearchCutoffMs;
    separatorTokens?: SeparatorTokens;
    sortableAttributes?: SortableAttributes;
    stopWords?: StopWords;
    synonyms?: Synonyms;
    typoTolerance?: TypoTolerance;
}

Settings

Member Visibility
diff --git a/types/SortableAttributes.html b/types/SortableAttributes.html new file mode 100644 index 000000000..b0ad7b9f9 --- /dev/null +++ b/types/SortableAttributes.html @@ -0,0 +1 @@ +SortableAttributes | Meilisearch JS

Type Alias SortableAttributes

SortableAttributes: string[] | null

Settings

Member Visibility
diff --git a/types/Stats.html b/types/Stats.html new file mode 100644 index 000000000..80257d8d7 --- /dev/null +++ b/types/Stats.html @@ -0,0 +1 @@ +Stats | Meilisearch JS

Type Alias Stats

Stats: {
    databaseSize: number;
    indexes: {
        [index: string]: IndexStats;
    };
    lastUpdate: string;
}

Settings

Member Visibility
diff --git a/types/StopWords.html b/types/StopWords.html new file mode 100644 index 000000000..b32f27af3 --- /dev/null +++ b/types/StopWords.html @@ -0,0 +1 @@ +StopWords | Meilisearch JS

Type Alias StopWords

StopWords: string[] | null

Settings

Member Visibility
diff --git a/types/SwapIndexesParams.html b/types/SwapIndexesParams.html new file mode 100644 index 000000000..6a542d954 --- /dev/null +++ b/types/SwapIndexesParams.html @@ -0,0 +1 @@ +SwapIndexesParams | Meilisearch JS

Type Alias SwapIndexesParams

SwapIndexesParams: {
    indexes: string[];
}[]

Settings

Member Visibility
diff --git a/types/Synonyms.html b/types/Synonyms.html new file mode 100644 index 000000000..84bea3510 --- /dev/null +++ b/types/Synonyms.html @@ -0,0 +1 @@ +Synonyms | Meilisearch JS

Type Alias Synonyms

Synonyms: {
    [field: string]: string[];
} | null

Settings

Member Visibility
diff --git a/types/TaskObject.html b/types/TaskObject.html new file mode 100644 index 000000000..288fda0c9 --- /dev/null +++ b/types/TaskObject.html @@ -0,0 +1 @@ +TaskObject | Meilisearch JS

Type Alias TaskObject

TaskObject: Omit<EnqueuedTaskObject, "taskUid"> & {
    details: {
        canceledTasks?: number;
        deletedDocuments?: number;
        deletedTasks?: number;
        displayedAttributes?: DisplayedAttributes;
        distinctAttribute?: DistinctAttribute;
        filterableAttributes?: FilterableAttributes;
        indexedDocuments?: number;
        matchedTasks?: number;
        originalFilter?: string;
        primaryKey?: string;
        providedIds?: number;
        rankingRules?: RankingRules;
        receivedDocuments?: number;
        searchableAttributes?: SearchableAttributes;
        sortableAttributes?: SortableAttributes;
        stopWords?: StopWords;
        swaps?: SwapIndexesParams;
        synonyms?: Synonyms;
    };
    duration: string;
    error: MeiliSearchErrorResponse | null;
    finishedAt: string;
    startedAt: string;
    uid: number;
}

Settings

Member Visibility
diff --git a/types/TaskStatus.html b/types/TaskStatus.html new file mode 100644 index 000000000..0286d6e98 --- /dev/null +++ b/types/TaskStatus.html @@ -0,0 +1 @@ +TaskStatus | Meilisearch JS

Type Alias TaskStatus

TaskStatus: typeof TaskStatus[keyof typeof TaskStatus]

Settings

Member Visibility
diff --git a/types/TaskTypes.html b/types/TaskTypes.html new file mode 100644 index 000000000..b319eb7bb --- /dev/null +++ b/types/TaskTypes.html @@ -0,0 +1 @@ +TaskTypes | Meilisearch JS

Type Alias TaskTypes

TaskTypes: typeof TaskTypes[keyof typeof TaskTypes]

Settings

Member Visibility
diff --git a/types/TasksQuery.html b/types/TasksQuery.html new file mode 100644 index 000000000..0062872fa --- /dev/null +++ b/types/TasksQuery.html @@ -0,0 +1 @@ +TasksQuery | Meilisearch JS

Type Alias TasksQuery

TasksQuery: {
    afterEnqueuedAt?: Date;
    afterFinishedAt?: Date;
    afterStartedAt?: Date;
    beforeEnqueuedAt?: Date;
    beforeFinishedAt?: Date;
    beforeStartedAt?: Date;
    canceledBy?: number[];
    from?: number;
    indexUids?: string[];
    limit?: number;
    statuses?: TaskStatus[];
    types?: TaskTypes[];
    uids?: number[];
}

Settings

Member Visibility
diff --git a/types/TasksResults.html b/types/TasksResults.html new file mode 100644 index 000000000..1ed8f9c91 --- /dev/null +++ b/types/TasksResults.html @@ -0,0 +1 @@ +TasksResults | Meilisearch JS

Type Alias TasksResults

TasksResults: CursorResults<Task>

Settings

Member Visibility
diff --git a/types/TasksResultsObject.html b/types/TasksResultsObject.html new file mode 100644 index 000000000..120b3457c --- /dev/null +++ b/types/TasksResultsObject.html @@ -0,0 +1 @@ +TasksResultsObject | Meilisearch JS

Type Alias TasksResultsObject

TasksResultsObject: CursorResults<TaskObject>

Settings

Member Visibility
diff --git a/types/TokenIndexRules.html b/types/TokenIndexRules.html new file mode 100644 index 000000000..89f313e65 --- /dev/null +++ b/types/TokenIndexRules.html @@ -0,0 +1 @@ +TokenIndexRules | Meilisearch JS

Type Alias TokenIndexRules

TokenIndexRules: {
    filter?: Filter;
    [field: string]: any;
}

Settings

Member Visibility
diff --git a/types/TokenOptions.html b/types/TokenOptions.html new file mode 100644 index 000000000..0a14d202c --- /dev/null +++ b/types/TokenOptions.html @@ -0,0 +1 @@ +TokenOptions | Meilisearch JS

Type Alias TokenOptions

TokenOptions: {
    apiKey?: string;
    expiresAt?: Date;
}

Settings

Member Visibility
diff --git a/types/TokenSearchRules.html b/types/TokenSearchRules.html new file mode 100644 index 000000000..0d6d10e6d --- /dev/null +++ b/types/TokenSearchRules.html @@ -0,0 +1 @@ +TokenSearchRules | Meilisearch JS

Type Alias TokenSearchRules

TokenSearchRules: Record<string, TokenIndexRules | null> | string[]

Settings

Member Visibility
diff --git a/types/TypoTolerance.html b/types/TypoTolerance.html new file mode 100644 index 000000000..d230e2bd3 --- /dev/null +++ b/types/TypoTolerance.html @@ -0,0 +1 @@ +TypoTolerance | Meilisearch JS

Type Alias TypoTolerance

TypoTolerance: {
    disableOnAttributes?: string[] | null;
    disableOnWords?: string[] | null;
    enabled?: boolean | null;
    minWordSizeForTypos?: {
        oneTypo?: number | null;
        twoTypos?: number | null;
    };
} | null

Settings

Member Visibility
diff --git a/types/UpdateDocumentsByFunctionOptions.html b/types/UpdateDocumentsByFunctionOptions.html new file mode 100644 index 000000000..a3680ad96 --- /dev/null +++ b/types/UpdateDocumentsByFunctionOptions.html @@ -0,0 +1 @@ +UpdateDocumentsByFunctionOptions | Meilisearch JS

Type Alias UpdateDocumentsByFunctionOptions

UpdateDocumentsByFunctionOptions: {
    context?: Record<string, any>;
    filter?: string | string[];
    function: string;
}

Settings

Member Visibility
diff --git a/types/UserProvidedEmbedder.html b/types/UserProvidedEmbedder.html new file mode 100644 index 000000000..8546d7df8 --- /dev/null +++ b/types/UserProvidedEmbedder.html @@ -0,0 +1 @@ +UserProvidedEmbedder | Meilisearch JS

Type Alias UserProvidedEmbedder

UserProvidedEmbedder: {
    binaryQuantized?: boolean;
    dimensions: number;
    distribution?: Distribution;
    source: "userProvided";
}

Settings

Member Visibility
diff --git a/types/Version.html b/types/Version.html new file mode 100644 index 000000000..f2d11e0ee --- /dev/null +++ b/types/Version.html @@ -0,0 +1 @@ +Version | Meilisearch JS

Type Alias Version

Version: {
    commitDate: string;
    commitSha: string;
    pkgVersion: string;
}

Settings

Member Visibility
diff --git a/types/WaitOptions.html b/types/WaitOptions.html new file mode 100644 index 000000000..4ffd0cb46 --- /dev/null +++ b/types/WaitOptions.html @@ -0,0 +1 @@ +WaitOptions | Meilisearch JS

Type Alias WaitOptions

WaitOptions: {
    intervalMs?: number;
    timeOutMs?: number;
}

Settings

Member Visibility
diff --git a/variables/ContentTypeEnum.html b/variables/ContentTypeEnum.html new file mode 100644 index 000000000..8b029889f --- /dev/null +++ b/variables/ContentTypeEnum.html @@ -0,0 +1 @@ +ContentTypeEnum | Meilisearch JS

Variable ContentTypeEnumConst

ContentTypeEnum: Readonly<Record<string, ContentType>> = ...

Settings

Member Visibility
diff --git a/variables/ErrorStatusCode-1.html b/variables/ErrorStatusCode-1.html new file mode 100644 index 000000000..79c4aac0d --- /dev/null +++ b/variables/ErrorStatusCode-1.html @@ -0,0 +1,118 @@ +ErrorStatusCode | Meilisearch JS

Variable ErrorStatusCodeConst

ErrorStatusCode: {
    API_KEY_NOT_FOUND: string;
    BAD_REQUEST: string;
    DOCUMENT_NOT_FOUND: string;
    DOCUMENTS_FIELDS_LIMIT_REACHED: string;
    DUMP_NOT_FOUND: string;
    DUMP_PROCESS_FAILED: string;
    IMMUTABLE_API_KEY_ACTIONS: string;
    IMMUTABLE_API_KEY_CREATED_AT: string;
    IMMUTABLE_API_KEY_EXPIRES_AT: string;
    IMMUTABLE_API_KEY_INDEXES: string;
    IMMUTABLE_API_KEY_UID: string;
    IMMUTABLE_API_KEY_UPDATED_AT: string;
    IMMUTABLE_INDEX_CREATED_AT: string;
    IMMUTABLE_INDEX_UID: string;
    IMMUTABLE_INDEX_UPDATED_AT: string;
    INDEX_ALREADY_EXISTS: string;
    INDEX_CREATION_FAILED: string;
    INDEX_NOT_ACCESSIBLE: string;
    INDEX_NOT_FOUND: string;
    INDEX_PRIMARY_KEY_ALREADY_EXISTS: string;
    INTERNAL: string;
    INVALID_API_KEY: string;
    INVALID_API_KEY_ACTIONS: string;
    INVALID_API_KEY_DESCRIPTION: string;
    INVALID_API_KEY_EXPIRES_AT: string;
    INVALID_API_KEY_INDEXES: string;
    INVALID_API_KEY_LIMIT: string;
    INVALID_API_KEY_OFFSET: string;
    INVALID_CONTENT_TYPE: string;
    INVALID_DOCUMENT_FIELDS: string;
    INVALID_DOCUMENT_FILTER: string;
    INVALID_DOCUMENT_GEO_FIELD: string;
    INVALID_DOCUMENT_ID: string;
    INVALID_DOCUMENT_LIMIT: string;
    INVALID_DOCUMENT_OFFSET: string;
    INVALID_DOCUMENT_VECTORS_FIELD: string;
    INVALID_FACET_SEARCH_FACET_NAME: string;
    INVALID_FACET_SEARCH_FACET_QUERY: string;
    INVALID_INDEX_LIMIT: string;
    INVALID_INDEX_OFFSET: string;
    INVALID_INDEX_PRIMARY_KEY: string;
    INVALID_INDEX_UID: string;
    INVALID_RANKING_RULES: string;
    INVALID_REQUEST: string;
    INVALID_SEARCH_ATTRIBUTES_TO_CROP: string;
    INVALID_SEARCH_ATTRIBUTES_TO_HIGHLIGHT: string;
    INVALID_SEARCH_ATTRIBUTES_TO_RETRIEVE: string;
    INVALID_SEARCH_ATTRIBUTES_TO_SEARCH_ON: string;
    INVALID_SEARCH_CROP_LENGTH: string;
    INVALID_SEARCH_CROP_MARKER: string;
    INVALID_SEARCH_FACETS: string;
    INVALID_SEARCH_FILTER: string;
    INVALID_SEARCH_HIGHLIGHT_POST_TAG: string;
    INVALID_SEARCH_HIGHLIGHT_PRE_TAG: string;
    INVALID_SEARCH_HITS_PER_PAGE: string;
    INVALID_SEARCH_LIMIT: string;
    INVALID_SEARCH_MATCHING_STRATEGY: string;
    INVALID_SEARCH_OFFSET: string;
    INVALID_SEARCH_PAGE: string;
    INVALID_SEARCH_Q: string;
    INVALID_SEARCH_RANKING_SCORE_THRESHOLD: string;
    INVALID_SEARCH_SHOW_MATCHES_POSITION: string;
    INVALID_SEARCH_SORT: string;
    INVALID_SEARCH_VECTOR: string;
    INVALID_SETTINGS_DISPLAYED_ATTRIBUTES: string;
    INVALID_SETTINGS_DISTINCT_ATTRIBUTE: string;
    INVALID_SETTINGS_FACETING: string;
    INVALID_SETTINGS_FILTERABLE_ATTRIBUTES: string;
    INVALID_SETTINGS_LOCALIZED_ATTRIBUTES: string;
    INVALID_SETTINGS_PAGINATION: string;
    INVALID_SETTINGS_RANKING_RULES: string;
    INVALID_SETTINGS_SEARCH_CUTOFF_MS: string;
    INVALID_SETTINGS_SEARCHABLE_ATTRIBUTES: string;
    INVALID_SETTINGS_SORTABLE_ATTRIBUTES: string;
    INVALID_SETTINGS_STOP_WORDS: string;
    INVALID_SETTINGS_SYNONYMS: string;
    INVALID_SETTINGS_TYPO_TOLERANCE: string;
    INVALID_SIMILAR_RANKING_SCORE_THRESHOLD: string;
    INVALID_STATE: string;
    INVALID_STORE_FILE: string;
    INVALID_SWAP_DUPLICATE_INDEX_FOUND: string;
    INVALID_SWAP_INDEXES: string;
    INVALID_TASK_AFTER_ENQUEUED_AT: string;
    INVALID_TASK_AFTER_FINISHED_AT: string;
    INVALID_TASK_AFTER_STARTED_AT: string;
    INVALID_TASK_BEFORE_ENQUEUED_AT: string;
    INVALID_TASK_BEFORE_FINISHED_AT: string;
    INVALID_TASK_BEFORE_STARTED_AT: string;
    INVALID_TASK_CANCELED_BY: string;
    INVALID_TASK_FROM: string;
    INVALID_TASK_INDEX_UIDS: string;
    INVALID_TASK_LIMIT: string;
    INVALID_TASK_STATUSES: string;
    INVALID_TASK_TYPES: string;
    INVALID_TASK_UIDS: string;
    IO_ERROR: string;
    MALFORMED_PAYLOAD: string;
    MAX_DATABASE_SIZE_LIMIT_REACHED: string;
    MISSING_API_KEY_ACTIONS: string;
    MISSING_API_KEY_EXPIRES_AT: string;
    MISSING_API_KEY_INDEXES: string;
    MISSING_AUTHORIZATION_HEADER: string;
    MISSING_CONTENT_TYPE: string;
    MISSING_DOCUMENT_FILTER: string;
    MISSING_DOCUMENT_ID: string;
    MISSING_FACET_SEARCH_FACET_NAME: string;
    MISSING_INDEX_UID: string;
    MISSING_MASTER_KEY: string;
    MISSING_PAYLOAD: string;
    MISSING_SWAP_INDEXES: string;
    MISSING_TASK_FILTERS: string;
    NO_SPACE_LEFT_ON_DEVICE: string;
    PAYLOAD_TOO_LARGE: string;
    PRIMARY_KEY_INFERENCE_FAILED: string;
    TASK_NOT_FOUND: string;
    TOO_MANY_OPEN_FILES: string;
    UNRETRIEVABLE_DOCUMENT: string;
} = ...

Type declaration

Settings

Member Visibility
diff --git a/variables/MatchingStrategies-1.html b/variables/MatchingStrategies-1.html new file mode 100644 index 000000000..4e92cbb6b --- /dev/null +++ b/variables/MatchingStrategies-1.html @@ -0,0 +1 @@ +MatchingStrategies | Meilisearch JS

Variable MatchingStrategiesConst

MatchingStrategies: {
    ALL: "all";
    FREQUENCY: "frequency";
    LAST: "last";
} = ...

Settings

Member Visibility
diff --git a/variables/TaskStatus-1.html b/variables/TaskStatus-1.html new file mode 100644 index 000000000..d0c08f627 --- /dev/null +++ b/variables/TaskStatus-1.html @@ -0,0 +1 @@ +TaskStatus | Meilisearch JS

Variable TaskStatusConst

TaskStatus: {
    TASK_CANCELED: "canceled";
    TASK_ENQUEUED: "enqueued";
    TASK_FAILED: "failed";
    TASK_PROCESSING: "processing";
    TASK_SUCCEEDED: "succeeded";
} = ...

Settings

Member Visibility
diff --git a/variables/TaskTypes-1.html b/variables/TaskTypes-1.html new file mode 100644 index 000000000..11cbfd1e1 --- /dev/null +++ b/variables/TaskTypes-1.html @@ -0,0 +1 @@ +TaskTypes | Meilisearch JS

Variable TaskTypesConst

TaskTypes: {
    DOCUMENT_DELETION: "documentDeletion";
    DOCUMENTS_ADDITION_OR_UPDATE: "documentAdditionOrUpdate";
    DUMP_CREATION: "dumpCreation";
    INDEX_CREATION: "indexCreation";
    INDEX_DELETION: "indexDeletion";
    INDEX_UPDATE: "indexUpdate";
    INDEXES_SWAP: "indexSwap";
    SETTINGS_UPDATE: "settingsUpdate";
    SNAPSHOT_CREATION: "snapshotCreation";
    TASK_CANCELATION: "taskCancelation";
    TASK_DELETION: "taskDeletion";
} = ...

Settings

Member Visibility