Permalink
Cannot retrieve contributors at this time
| /* | |
| * Copyright (c) 2016-2020 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 PARTICULAR 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 { SearchIndex, SearchTransformFn } from "integrations" | |
| /* ---------------------------------------------------------------------------- | |
| * Types | |
| * ------------------------------------------------------------------------- */ | |
| /** | |
| * Feature flags | |
| */ | |
| export type Feature = | |
| | "navigation.tabs" /* Tabs navigation */ | |
| | "navigation.instant" /* Instant loading */ | |
| /* ------------------------------------------------------------------------- */ | |
| /** | |
| * Configuration | |
| */ | |
| export interface Config { | |
| base: string /* Base URL */ | |
| features: Feature[] /* Feature flags */ | |
| search: { | |
| worker: string /* Worker URL */ | |
| index?: Promise<SearchIndex> /* Promise resolving with index */ | |
| transform?: SearchTransformFn /* Transformation function */ | |
| } | |
| } | |
| /* ---------------------------------------------------------------------------- | |
| * Functions | |
| * ------------------------------------------------------------------------- */ | |
| /** | |
| * Ensure that the given value is a valid configuration | |
| * | |
| * We could use `jsonschema` or any other schema validation framework, but that | |
| * would just add more bloat to the bundle, so we'll keep it plain and simple. | |
| * | |
| * @param config - Configuration | |
| * | |
| * @return Test result | |
| */ | |
| export function isConfig(config: any): config is Config { | |
| return typeof config === "object" | |
| && typeof config.base === "string" | |
| && typeof config.features === "object" | |
| && typeof config.search === "object" | |
| } |