meilisearch - npm Package Compare versions

Comparing version 0.24.0-beta.1 to 0.24.0

dist/types/index.d.ts

@@ -1,6 +0,6 @@
-// Type definitions for meilisearch 0.24.0-beta.1
+// Type definitions for meilisearch 0.24.0
 // Project: https://github.com/meilisearch/meilisearch-js
 // Definitions by: cvermand <[e-mail]> <https://github.com/meilisearch>
 // Definitions: https://github.com/meilisearch/meilisearch-js
-// TypeScript Version: 4.5.2
+// TypeScript Version: 4.5.4
 
@@ -7,0 +7,0 @@ export * from './types';

dist/types/lib/indexes.d.ts

@@ -202,3 +202,3 @@ import { Config, Task, SearchResponse, SearchParams, IndexResponse, IndexOptions, IndexStats, GetDocumentsParams, GetDocumentsResponse, Document, AddDocumentParams, EnqueuedTask, Settings, Synonyms, StopWords, RankingRules, DistinctAttribute, FilterableAttributes, SortableAttributes, SearchableAttributes, DisplayedAttributes, Result } from '../types';
      * @param {string | number} documentId Id of Document to delete
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -211,3 +211,3 @@ deleteDocument(documentId: string | number): Promise<EnqueuedTask>;
      * @param {string[] | number[]} documentsIds Array of Document Ids to delete
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -219,3 +219,3 @@ deleteDocuments(documentsIds: string[] | number[]): Promise<EnqueuedTask>;
      * @method deleteAllDocuments
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -236,3 +236,3 @@ deleteAllDocuments(): Promise<EnqueuedTask>;
      * @param {Settings} settings Object containing parameters with their updated values
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -244,3 +244,3 @@ updateSettings(settings: Settings): Promise<EnqueuedTask>;
      * @method resetSettings
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -260,3 +260,3 @@ resetSettings(): Promise<EnqueuedTask>;
      * @param {Synonyms} synonyms Mapping of synonyms with their associated words
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -268,3 +268,3 @@ updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask>;
      * @method resetSynonyms
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -372,3 +372,3 @@ resetSynonyms(): Promise<EnqueuedTask>;
      * @param {SortableAttributes} sortableAttributes Array of strings containing the attributes that can be used to sort search results at query time
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -380,3 +380,3 @@ updateSortableAttributes(sortableAttributes: SortableAttributes): Promise<EnqueuedTask>;
      * @method resetSortableAttributes
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -396,3 +396,3 @@ resetSortableAttributes(): Promise<EnqueuedTask>;
      * @param {SearchableAttributes} searchableAttributes Array of strings that contains searchable attributes sorted by order of importance(most to least important)
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -404,3 +404,3 @@ updateSearchableAttributes(searchableAttributes: SearchableAttributes): Promise<EnqueuedTask>;
      * @method resetSearchableAttributes
-     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+     * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
      */
@@ -407,0 +407,0 @@ resetSearchableAttributes(): Promise<EnqueuedTask>;

package.json

 {
   "name": "meilisearch",
-  "version": "0.24.0-beta.1",
+  "version": "0.24.0",
   "description": "The MeiliSearch JS client for Node.js and the browser.",
@@ -73,8 +73,8 @@ "keywords": [
   "devDependencies": {
-    "@babel/preset-env": "^7.16.4",
+    "@babel/preset-env": "^7.16.7",
     "@rollup/plugin-babel": "^5.3.0",
     "@rollup/plugin-commonjs": "21.0.1",
     "@rollup/plugin-json": "^4.0.2",
-    "@rollup/plugin-node-resolve": "13.0.6",
-    "@types/jest": "^27.0.3",
+    "@rollup/plugin-node-resolve": "13.1.3",
+    "@types/jest": "^27.4.0",
     "@types/prettier": "^2.2.3",
@@ -105,7 +105,7 @@ "@typescript-eslint/eslint-plugin": "2.34.0",
     "rollup-plugin-terser": "^7.0.0",
-    "rollup-plugin-typescript2": "^0.31.0",
+    "rollup-plugin-typescript2": "^0.31.1",
     "shx": "^0.3.2",
     "ts-jest": "^26.5.6",
-    "typescript": "4.5.2"
+    "typescript": "4.5.4"
   }
 }

README.md

@@ -172,3 +172,3 @@ <p align="center">
 
-With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-one-task).
+With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
 
@@ -250,3 +250,3 @@ #### Basic Search <!-- omit in toc -->
 
-Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [update status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-task)).
 
@@ -418,10 +418,18 @@ Then, you can perform the search:
 
-- [Get One update info](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status):
+- [Get task info using the client](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks):
 
-`index.getTask(uid: number): Promise<Task>`
+Task list:
+`client.getTasks(): Promise<Result<Task[]>>`
 
-- [Get all updates info](https://docs.meilisearch.com/reference/api/updates.html#get-all-update-status):
+One task:
+`client.getTask(uid: number): Promise<Task>`
 
+- [Get task info using the index](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks-by-index):
+
+Task list:
 `index.getTasks(): Promise<Result<Task[]>>`
 
+One task:
+`index.getTask(uid: number): Promise<Task>`
+
 - Wait for one task:
@@ -432,3 +440,3 @@
 
-Using de index:
+Using the index:
 `index.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>`
@@ -438,6 +446,6 @@
 
-Using de client:
+Using the client:
 `client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Result<Task[]>>`
 
-Using de index:
+Using the index:
 `index.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Result<Task[]>>`
@@ -444,0 +452,0 @@

src/lib/indexes.ts

@@ -438,3 +438,3 @@ /*
    * @param {string | number} documentId Id of Document to delete
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -451,3 +451,3 @@ async deleteDocument(documentId: string | number): Promise<EnqueuedTask> {
    * @param {string[] | number[]} documentsIds Array of Document Ids to delete
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -466,3 +466,3 @@ async deleteDocuments(
    * @method deleteAllDocuments
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -495,3 +495,3 @@ async deleteAllDocuments(): Promise<EnqueuedTask> {
    * @param {Settings} settings Object containing parameters with their updated values
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -507,3 +507,3 @@ async updateSettings(settings: Settings): Promise<EnqueuedTask> {
    * @method resetSettings
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -535,3 +535,3 @@ async resetSettings(): Promise<EnqueuedTask> {
    * @param {Synonyms} synonyms Mapping of synonyms with their associated words
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -547,3 +547,3 @@ async updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask> {
    * @method resetSynonyms
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -731,3 +731,3 @@ async resetSynonyms(): Promise<EnqueuedTask> {
    * @param {SortableAttributes} sortableAttributes Array of strings containing the attributes that can be used to sort search results at query time
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -745,3 +745,3 @@ async updateSortableAttributes(
    * @method resetSortableAttributes
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -773,3 +773,3 @@ async resetSortableAttributes(): Promise<EnqueuedTask> {
    * @param {SearchableAttributes} searchableAttributes Array of strings that contains searchable attributes sorted by order of importance(most to least important)
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -787,3 +787,3 @@ async updateSearchableAttributes(
    * @method resetSearchableAttributes
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
    */
@@ -790,0 +790,0 @@ async resetSearchableAttributes(): Promise<EnqueuedTask> {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

391680

Number of lines in readme file

663

increased by1.22%

No dependency changes