Rollback previous commit

Author: bidoubiwa

README.md

@@ -415,15 +415,15 @@ If you want to know more about the development workflow or want to contribute, p
 
 - [Get all tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks)
 
-  `client.getTasks(parameters: TasksQuery): Promise<TasksResults>`
+  `client.getTasks(parameters: TaskParams): Promise<TasksResults>`
 
 - [Get one task](https://docs.meilisearch.com/reference/api/tasks.html#get-task)
 
   `client.getTask(uid: number): Promise<Task>`
 
 - [Get all tasks of an index](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks-by-index)
 
-  `index.getTasks(parameters: TasksQuery): Promise<TasksResults>`
+  `index.getTasks(parameters: TaskParams): Promise<TasksResults>`
 
 - [Get one task of an index](https://docs.meilisearch.com/reference/api/tasks.html#get-task)
 
@@ -450,7 +450,7 @@ If you want to know more about the development workflow or want to contribute, p
 
 - [Get all indexes](https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes):
 
-`client.getRawIndexes(parameters: IndexesQuery): Promise<IndexesResults<IndexObject[]>>`
+`client.getRawIndexes(parameters: IndexesQuery): Promise<Result<IndexObject[]>>`
 
 - [Create a new index](https://docs.meilisearch.com/reference/api/indexes.html#create-an-index):
 

src/clients/client.ts

@@ -22,7 +22,7 @@ import {
   Task,
   TokenSearchRules,
   TokenOptions,
-  TasksQuery,
+  TaskParams,
   WaitOptions,
   KeyUpdate,
   IndexesQuery,
@@ -90,7 +90,7 @@ class Client {
    * Get all the indexes as Index instances.
    * @memberof MeiliSearch
    * @method getIndexes
-   * @param {IndexesQuery} [parameters={}] - Parameters to browse the indexes
+   * @param {IndexesQuery} parameters - Parameters to browse the indexes
    *
    * @returns {Promise<IndexesResults<Index[]>>} Promise returning array of raw index information
    */
@@ -108,7 +108,7 @@ class Client {
    * Get all the indexes in their raw value (no Index instances).
    * @memberof MeiliSearch
    * @method getRawIndexes
-   * @param {IndexesQuery} [parameters={}] - Parameters to browse the indexes
+   * @param {IndexesQuery} parameters - Parameters to browse the indexes
    *
    * @returns {Promise<IndexesResults<IndexObject[]>>} Promise returning array of raw index information
    */
@@ -192,11 +192,11 @@ class Client {
    * Get the list of all client tasks
    * @memberof MeiliSearch
    * @method getTasks
-   * @param {TasksQuery} [parameters={}] - Parameters to browse the tasks
+   * @param {TasksQuery} parameters - Parameters to browse the tasks
    *
    * @returns {Promise<TasksResults>} - Promise returning all tasks
    */
-  async getTasks(parameters: TasksQuery = {}): Promise<TasksResults> {
+  async getTasks(parameters: TaskParams = {}): Promise<TasksResults> {
     return await this.tasks.getTasks(parameters)
   }
 
@@ -205,7 +205,7 @@ class Client {
    * @memberof MeiliSearch
    * @method getTask
    * @param {number} taskUid - Task identifier
-   * @returns {Promise<Task>} - Promise returning a task
+   * @returns {Promise<TasksResults>} - Promise returning a task
    */
   async getTask(taskUid: number): Promise<Task> {
     return await this.tasks.getTask(taskUid)
@@ -260,7 +260,7 @@ class Client {
    * Get all API keys
    * @memberof MeiliSearch
    * @method getKeys
-   * @param {KeysQuery} [parameters={}] - Parameters to browse the indexes
+   * @param {KeysQuery} parameters - Parameters to browse the indexes
    *
    * @returns {Promise<KeysResults>} Promise returning an object with keys
    */

src/indexes.ts

@@ -35,7 +35,7 @@ import {
   TypoTolerance,
   WaitOptions,
   DocumentsResults,
-  TasksQuery,
+  TaskParams,
   TasksResults,
 } from './types'
 import { removeUndefinedFromObject } from './utils'
@@ -229,11 +229,11 @@ class Index<T = Record<string, any>> {
    *
    * @memberof Indexes
    * @method getTasks
-   * @param {TasksQuery} [parameters={}] - Parameters to browse the tasks
+   * @param {TasksQuery} parameters - Parameters to browse the tasks
    *
    * @returns {Promise<TasksResults>} - Promise containing all tasks
    */
-  async getTasks(parameters: TasksQuery = {}): Promise<TasksResults> {
+  async getTasks(parameters: TaskParams = {}): Promise<TasksResults> {
     return await this.tasks.getTasks({ ...parameters, indexUid: [this.uid] })
   }
 
@@ -313,7 +313,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method getDocuments
    * @template T
-   * @param {DocumentsQuery<T>} [parameters={}]? Parameters to browse the documents
+   * @param {DocumentsQuery<T>} parameters? Parameters to browse the documents
    * @returns {Promise<DocumentsResults<T>>>} Promise containing Document responses
    */
   async getDocuments<T = Record<string, any>>(

src/task.ts

@@ -4,7 +4,7 @@ import {
   Task,
   WaitOptions,
   TaskStatus,
-  TasksQuery,
+  TaskParams,
   TasksResults,
 } from './types'
 import { HttpRequests } from './http-requests'
@@ -32,11 +32,11 @@ class TaskClient {
   /**
    * Get tasks
    *
-   * @param  {TasksQuery} [parameters={}] - Parameters to browse the tasks
+   * @param  {TaskParams} parameters - Parameters to browse the tasks
    *
    * @returns {Promise<TasksResults>} - Promise containing all tasks
    */
-  async getTasks(parameters: TasksQuery = {}): Promise<TasksResults> {
+  async getTasks(parameters: TaskParams = {}): Promise<TasksResults> {
     const url = `tasks`
 
     const queryParams = {

src/types/types.ts

@@ -199,7 +199,7 @@ export const enum TaskTypes {
   SETTINGS_UPDATE = 'settingsUpdate',
 }
 
-export type TasksQuery = {
+export type TaskParams = {
   indexUid?: string[]
   type?: TaskTypes[]
   status?: TaskStatus[]