@ng-doc/keywords-loaders 22.0.0 → 22.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Aleksandr Skoropad
+
+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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-doc/keywords-loaders",
-  "version": "22.0.0",
+  "version": "22.2.0",
   "description": "Keyword loaders that link NgDoc pages to Angular, RxJS and other NgDoc sites.",
   "keywords": [
     "angular",
@@ -23,7 +23,7 @@
   "license": "MIT",
   "type": "commonjs",
   "dependencies": {
-    "@ng-doc/core": "22.0.0",
+    "@ng-doc/core": "22.2.0",
     "node-fetch": "2.6.11"
   },
   "publishConfig": {

package/ng-doc/helpers/fetch-keywords.d.ts

@@ -1,6 +0,0 @@
-import { NgDocKeyword } from '@ng-doc/core';
-/**
- *
- * @param endpoint
- */
-export declare function fetchKeywords(endpoint: string): Promise<Record<string, NgDocKeyword>>;

package/ng-doc/helpers/index.d.ts

@@ -1 +0,0 @@
-export * from './fetch-keywords';

package/ng-doc/index.d.ts

@@ -1,2 +0,0 @@
-export * from './interfaces';
-export * from './ng-doc-keywords-loader';

package/ng-doc/interfaces/index.d.ts

@@ -1 +0,0 @@
-export * from './keywords-loader-options';

package/ng-doc/interfaces/keywords-loader-options.d.ts

@@ -1,23 +0,0 @@
-/**
- * List of possible options for the NgDoc keywords loader.
- */
-export interface NgDocKeywordsLoaderOptions {
-    /**
-     * The URL endpoint of the NgDoc documentation. (e.g. https://ng-doc.com)
-     */
-    endpoint: string;
-    /**
-     * The path to the assets folder of the NgDoc documentation. (default: `/assets/ng-doc`)
-     */
-    assetsPath?: string;
-    /**
-     * Whether to load the keywords for the external guides. (default: `false`)
-     */
-    loadGuides?: boolean;
-    /**
-     * Defines the prefix to use for the external guides.
-     * (e.g. if the external guides have keyword `Installation`
-     * and you set `guidesPrefix` to `External`, the keyword will be `ExternalInstallation`)
-     */
-    guidesPrefix?: string;
-}

package/ng-doc/ng-doc-keywords-loader.d.ts

@@ -1,8 +0,0 @@
-import { NgDocKeywordsLoader } from '@ng-doc/core';
-import { NgDocKeywordsLoaderOptions } from './interfaces';
-/**
- * Loads keywords from an external NgDoc documentation.
- * You can use it to integrate your documentation with another NgDoc documentation and use its API or Pages keywords.
- * @param options - The options for the NgDoc keywords loader.
- */
-export declare function ngDocKeywordsLoader(options: NgDocKeywordsLoaderOptions): NgDocKeywordsLoader;