Skip to content

Commit bd0cb9a

Browse files
committed
Rollback tasks changes
1 parent 28071a6 commit bd0cb9a

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -415,15 +415,15 @@ If you want to know more about the development workflow or want to contribute, p
415415

416416
- [Get all tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks)
417417

418-
`client.getTasks(parameters: TaskParams): Promise<TasksResults>`
418+
`client.getTasks(parameters: TasksQuery): Promise<TasksResults>`
419419

420420
- [Get one task](https://docs.meilisearch.com/reference/api/tasks.html#get-task)
421421

422422
`client.getTask(uid: number): Promise<Task>`
423423

424424
- [Get all tasks of an index](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks-by-index)
425425

426-
`index.getTasks(parameters: TaskParams): Promise<TasksResults>`
426+
`index.getTasks(parameters: TasksQuery): Promise<TasksResults>`
427427

428428
- [Get one task of an index](https://docs.meilisearch.com/reference/api/tasks.html#get-task)
429429

@@ -450,7 +450,7 @@ If you want to know more about the development workflow or want to contribute, p
450450

451451
- [Get all indexes](https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes):
452452

453-
`client.getRawIndexes(parameters: IndexesQuery): Promise<Result<IndexObject[]>>`
453+
`client.getRawIndexes(parameters: IndexesQuery): Promise<IndexesResults<IndexObject[]>>`
454454

455455
- [Create a new index](https://docs.meilisearch.com/reference/api/indexes.html#create-an-index):
456456

src/clients/client.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
Task,
2323
TokenSearchRules,
2424
TokenOptions,
25-
TaskParams,
25+
TasksQuery,
2626
WaitOptions,
2727
KeyUpdate,
2828
IndexesQuery,
@@ -90,7 +90,7 @@ class Client {
9090
* Get all the indexes as Index instances.
9191
* @memberof MeiliSearch
9292
* @method getIndexes
93-
* @param {IndexesQuery} parameters - Parameters to browse the indexes
93+
* @param {IndexesQuery} [parameters={}] - Parameters to browse the indexes
9494
*
9595
* @returns {Promise<IndexesResults<Index[]>>} Promise returning array of raw index information
9696
*/
@@ -108,7 +108,7 @@ class Client {
108108
* Get all the indexes in their raw value (no Index instances).
109109
* @memberof MeiliSearch
110110
* @method getRawIndexes
111-
* @param {IndexesQuery} parameters - Parameters to browse the indexes
111+
* @param {IndexesQuery} [parameters={}] - Parameters to browse the indexes
112112
*
113113
* @returns {Promise<IndexesResults<IndexObject[]>>} Promise returning array of raw index information
114114
*/
@@ -192,11 +192,11 @@ class Client {
192192
* Get the list of all client tasks
193193
* @memberof MeiliSearch
194194
* @method getTasks
195-
* @param {TasksQuery} parameters - Parameters to browse the tasks
195+
* @param {TasksQuery} [parameters={}] - Parameters to browse the tasks
196196
*
197197
* @returns {Promise<TasksResults>} - Promise returning all tasks
198198
*/
199-
async getTasks(parameters: TaskParams = {}): Promise<TasksResults> {
199+
async getTasks(parameters: TasksQuery = {}): Promise<TasksResults> {
200200
return await this.tasks.getTasks(parameters)
201201
}
202202

@@ -260,7 +260,7 @@ class Client {
260260
* Get all API keys
261261
* @memberof MeiliSearch
262262
* @method getKeys
263-
* @param {KeysQuery} parameters - Parameters to browse the indexes
263+
* @param {KeysQuery} [parameters={}] - Parameters to browse the indexes
264264
*
265265
* @returns {Promise<KeysResults>} Promise returning an object with keys
266266
*/

src/task.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {
44
Task,
55
WaitOptions,
66
TaskStatus,
7-
TaskParams,
7+
TasksQuery,
88
TasksResults,
99
} from './types'
1010
import { HttpRequests } from './http-requests'
@@ -32,11 +32,11 @@ class TaskClient {
3232
/**
3333
* Get tasks
3434
*
35-
* @param {TaskParams} parameters - Parameters to browse the tasks
35+
* @param {TasksQuery} [parameters={}] - Parameters to browse the tasks
3636
*
3737
* @returns {Promise<TasksResults>} - Promise containing all tasks
3838
*/
39-
async getTasks(parameters: TaskParams = {}): Promise<TasksResults> {
39+
async getTasks(parameters: TasksQuery = {}): Promise<TasksResults> {
4040
const url = `tasks`
4141

4242
const queryParams = {

src/types/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ export const enum TaskTypes {
199199
SETTINGS_UPDATE = 'settingsUpdate',
200200
}
201201

202-
export type TaskParams = {
202+
export type TasksQuery = {
203203
indexUid?: string[]
204204
type?: TaskTypes[]
205205
status?: TaskStatus[]

0 commit comments

Comments
 (0)