aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/templates/assets/javascripts/integrations/search/worker/_
diff options
context:
space:
mode:
Diffstat (limited to 'src/templates/assets/javascripts/integrations/search/worker/_')
-rw-r--r--src/templates/assets/javascripts/integrations/search/worker/_/index.ts95
1 files changed, 0 insertions, 95 deletions
diff --git a/src/templates/assets/javascripts/integrations/search/worker/_/index.ts b/src/templates/assets/javascripts/integrations/search/worker/_/index.ts
deleted file mode 100644
index 26713573..00000000
--- a/src/templates/assets/javascripts/integrations/search/worker/_/index.ts
+++ /dev/null
@@ -1,95 +0,0 @@
-/*
- * Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A RTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import {
- ObservableInput,
- Subject,
- first,
- merge,
- of,
- switchMap
-} from "rxjs"
-
-import { feature } from "~/_"
-import { watchToggle, watchWorker } from "~/browser"
-
-import { SearchIndex } from "../../config"
-import {
- SearchMessage,
- SearchMessageType
-} from "../message"
-
-/* ----------------------------------------------------------------------------
- * Functions
- * ------------------------------------------------------------------------- */
-
-/**
- * Set up search worker
- *
- * This function creates and initializes a web worker that is used for search,
- * so that the user interface doesn't freeze. In general, the application does
- * not care how search is implemented, as long as the web worker conforms to
- * the format expected by the application as defined in `SearchMessage`. This
- * allows the author to implement custom search functionality, by providing a
- * custom web worker via configuration.
- *
- * Material for MkDocs' built-in search implementation makes use of Lunr.js, an
- * efficient and fast implementation for client-side search. Leveraging a tiny
- * iframe-based web worker shim, search is even supported for the `file://`
- * protocol, enabling search for local non-hosted builds.
- *
- * If the protocol is `file://`, search initialization is deferred to mitigate
- * freezing, as it's now synchronous by design - see https://bit.ly/3C521EO
- *
- * @see https://bit.ly/3igvtQv - How to implement custom search
- *
- * @param url - Worker URL
- * @param index$ - Search index observable input
- *
- * @returns Search worker
- */
-export function setupSearchWorker(
- url: string, index$: ObservableInput<SearchIndex>
-): Subject<SearchMessage> {
- const worker$ = watchWorker<SearchMessage>(url)
- merge(
- of(location.protocol !== "file:"),
- watchToggle("search")
- )
- .pipe(
- first(active => active),
- switchMap(() => index$)
- )
- .subscribe(({ config, docs }) => worker$.next({
- type: SearchMessageType.SETUP,
- data: {
- config,
- docs,
- options: {
- suggest: feature("search.suggest")
- }
- }
- }))
-
- /* Return search worker */
- return worker$
-}