wikipedia - npm Package Compare versions

Comparing version 1.1.9 to 1.2.0

dist/errors.d.ts

@@ -8,2 +8,5 @@ export declare class wikiError extends Error {
 }
+export declare class autocompletionsError extends wikiError {
+    constructor(message: string);
+}
 export declare class pageError extends wikiError {
@@ -10,0 +13,0 @@ constructor(message: string);

dist/errors.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.citationError = exports.pdfError = exports.fcError = exports.eventsError = exports.mediaError = exports.relatedError = exports.introError = exports.preloadError = exports.infoboxError = exports.coordinatesError = exports.geoSearchError = exports.linksError = exports.categoriesError = exports.contentError = exports.htmlError = exports.imageError = exports.summaryError = exports.pageError = exports.searchError = exports.wikiError = void 0;
+exports.citationError = exports.pdfError = exports.fcError = exports.eventsError = exports.mediaError = exports.relatedError = exports.introError = exports.preloadError = exports.infoboxError = exports.coordinatesError = exports.geoSearchError = exports.linksError = exports.categoriesError = exports.contentError = exports.htmlError = exports.imageError = exports.summaryError = exports.pageError = exports.autocompletionsError = exports.searchError = exports.wikiError = void 0;
 class wikiError extends Error {
@@ -19,2 +19,9 @@ constructor(message, code) {
 exports.searchError = searchError;
+class autocompletionsError extends wikiError {
+    constructor(message) {
+        super(message);
+        this.name = 'autocompletionsError';
+    }
+}
+exports.autocompletionsError = autocompletionsError;
 class pageError extends wikiError {
@@ -21,0 +28,0 @@ constructor(message) {

dist/index.d.ts

@@ -1,2 +0,2 @@
-import { pageOptions, searchOptions, geoOptions, listOptions, eventOptions, fcOptions, randomFormats, pdfOptions, citationFormat } from './optionTypes';
+import { pageOptions, searchOptions, geoOptions, listOptions, eventOptions, fcOptions, randomFormats, pdfOptions, citationFormat, autocompletionOptions } from './optionTypes';
 import Page from './page';
@@ -289,2 +289,13 @@ import { coordinatesResult, eventResult, featuredContentResult, geoSearchResult, imageResult, langLinksResult, languageResult, mobileSections, relatedResult, title, wikiMediaResult, wikiSearchResult, wikiSummary, notFound } from './resultTypes';
     citation(query: string, format?: citationFormat, language?: string): Promise<any>;
+    /**
+     * Returns the autocompletion results for a given query
+     *
+     * @remarks
+     * Limits results by default to 10
+     *
+     * @param query - The string to search for
+     * @param autocompletionOptions - The number of results {@link autocompletionOptions | autocompletionOptions }
+     * @returns an array of string
+     */
+    autocompletions(query: string, autocompletionOptions?: autocompletionOptions | undefined): Promise<Array<string>>;
 };
@@ -291,0 +302,0 @@ export default wiki;

dist/index.js

@@ -629,2 +629,28 @@ "use strict";
 };
+/**
+ * Returns the autocompletion results for a given query
+ *
+ * @remarks
+ * Limits results by default to 10
+ *
+ * @param query - The string to search for
+ * @param autocompletionOptions - The number of results {@link autocompletionOptions | autocompletionOptions }
+ * @returns an array of string
+ */
+wiki.autocompletions = async (query, autocompletionOptions) => {
+    try {
+        const autocompletionsParams = {
+            list: "search",
+            limit: (autocompletionOptions === null || autocompletionOptions === void 0 ? void 0 : autocompletionOptions.limit) || 10,
+            search: query,
+            action: "opensearch",
+            redirect: "return"
+        };
+        const [, autocompletions] = await (0, request_1.default)(autocompletionsParams, false);
+        return autocompletions;
+    }
+    catch (error) {
+        throw new errors_1.autocompletionsError(error);
+    }
+};
 exports.default = wiki;
@@ -631,0 +657,0 @@ // For CommonJS default export support

dist/messages.d.ts

@@ -0,0 +0,0 @@ export declare const MSGS: {

dist/messages.js

@@ -0,0 +0,0 @@ "use strict";

dist/optionTypes.d.ts

@@ -5,2 +5,5 @@ export interface searchOptions {
 }
+export interface autocompletionOptions {
+    limit?: number;
+}
 export interface pageOptions {
@@ -7,0 +10,0 @@ autoSuggest?: boolean;

dist/optionTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });

dist/page.d.ts

@@ -0,0 +0,0 @@ import { coordinatesResult, imageResult, langLinksResult, notFound, pageResult, relatedResult, wikiMediaResult, wikiSummary } from './resultTypes';

dist/page.js

@@ -0,0 +0,0 @@ "use strict";

dist/request.d.ts

@@ -0,0 +0,0 @@ declare function makeRequest(params: any, redirect?: boolean): Promise<any>;

dist/request.js

@@ -0,0 +0,0 @@ "use strict";

dist/resultTypes.d.ts

@@ -0,0 +0,0 @@ export interface wikiSearchResult {

dist/resultTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });

dist/utils.d.ts

@@ -0,0 +0,0 @@ export declare function isString(title: any): boolean;

dist/utils.js

@@ -0,0 +0,0 @@ "use strict";

package.json

 {
   "name": "wikipedia",
-  "version": "1.1.9",
+  "version": "1.2.0",
   "description": "A JavaScript wrapper for the wikipedia apis",
@@ -5,0 +5,0 @@ "main": "dist",

No alert changes

Improved metrics

Lines of code

2982

increased by1.71%

Worsened metrics

Total package byte prevSize

111168

decreased by-1.04%

No dependency changes