Skip to content

Commit 6898fef

Browse files
daniloff200daniloff200
committed
fix review comments
2 parents ba77b65 + 5612a53 commit 6898fef

File tree

13 files changed

+107
-115
lines changed

13 files changed

+107
-115
lines changed

‎.code-samples.meilisearch.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
---
66
get_one_index_1: |-
77
client.index('movies').getRawInfo()
8-
list_all_indexes_1: |-
9-
client.listIndexes()
8+
get_all_indexes_1: |-
9+
client.getIndexes()
1010
create_an_index_1: |-
1111
client.createIndex('movies', { primaryKey: 'movie_id' })
1212
update_an_index_1: |-

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,5 +126,6 @@ cypress/fixtures
126126
dist
127127
package
128128
.vscode
129+
.idea
129130
dist_default_export_in_index
130131
no_default_export_in_index

‎README.md‎

Lines changed: 64 additions & 73 deletions
Large diffs are not rendered by default.

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "meilisearch",
3-
"version": "0.21.0",
3+
"version": "0.22.0",
44
"description": "The MeiliSearch JS client for Node.js and the browser.",
55
"keywords": [
66
"meilisearch",
@@ -65,7 +65,7 @@
6565
"devDependencies": {
6666
"@babel/preset-env": "^7.15.6",
6767
"@rollup/plugin-babel": "^5.3.0",
68-
"@rollup/plugin-commonjs": "20.0.0",
68+
"@rollup/plugin-commonjs": "21.0.0",
6969
"@rollup/plugin-json": "^4.0.2",
7070
"@rollup/plugin-node-resolve": "13.0.5",
7171
"@types/jest": "^27.0.2",

‎src/lib/meilisearch.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ class MeiliSearch {
7777
}
7878

7979
/**
80-
* List all indexes in the database
80+
* Get all indexes in the database
8181
* @memberof MeiliSearch
82-
* @method listIndexes
82+
* @method getIndexes
8383
*/
84-
async listIndexes(): Promise<IndexResponse[]> {
84+
async getIndexes(): Promise<IndexResponse[]> {
8585
const url = `indexes`
8686
return await this.httpRequest.get<IndexResponse[]>(url)
8787
}

‎tests/client_tests.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ describe.each([
177177
const health = await client.isHealthy()
178178
expect(health).toBe(true)
179179
await client.getOrCreateIndex('test')
180-
const indexes = await client.listIndexes()
180+
const indexes = await client.getIndexes()
181181
expect(indexes.length).toBe(1)
182182
})
183183

@@ -229,7 +229,7 @@ describe.each([
229229

230230
test(`${permission} key: get all indexes when not empty`, async () => {
231231
await client.createIndex(indexPk.uid)
232-
await client.listIndexes().then((response: IndexResponse[]) => {
232+
await client.getIndexes().then((response: IndexResponse[]) => {
233233
const indexes = response.map((index) => index.uid)
234234
expect(indexes).toEqual(expect.arrayContaining([indexPk.uid]))
235235
expect(indexes.length).toEqual(1)
@@ -279,7 +279,7 @@ describe.each([
279279
await client.deleteIndex(indexNoPk.uid).then((response: void) => {
280280
expect(response).toBe(undefined)
281281
})
282-
await expect(client.listIndexes()).resolves.toHaveLength(0)
282+
await expect(client.getIndexes()).resolves.toHaveLength(0)
283283
})
284284

285285
test(`${permission} key: create index with already existing uid should fail`, async () => {
@@ -311,7 +311,7 @@ describe.each([
311311
})
312312

313313
test(`${permission} key: delete index if exists on index that does not exist`, async () => {
314-
const indexes = await client.listIndexes()
314+
const indexes = await client.getIndexes()
315315
await client
316316
.deleteIndexIfExists('badIndex')
317317
.then((response: boolean) => {
@@ -321,7 +321,7 @@ describe.each([
321321
'errorCode',
322322
ErrorStatusCode.INDEX_NOT_FOUND
323323
)
324-
await expect(client.listIndexes()).resolves.toHaveLength(indexes.length)
324+
await expect(client.getIndexes()).resolves.toHaveLength(indexes.length)
325325
})
326326

327327
test(`${permission} key: fetch deleted index should fail`, async () => {
@@ -384,7 +384,7 @@ describe.each([{ client: publicClient, permission: 'Public' }])(
384384

385385
describe('Test on indexes methods', () => {
386386
test(`${permission} key: try to get all indexes and be denied`, async () => {
387-
await expect(client.listIndexes()).rejects.toHaveProperty(
387+
await expect(client.getIndexes()).rejects.toHaveProperty(
388388
'errorCode',
389389
ErrorStatusCode.INVALID_TOKEN
390390
)
@@ -471,7 +471,7 @@ describe.each([{ client: anonymousClient, permission: 'No' }])(
471471

472472
describe('Test on indexes methods', () => {
473473
test(`${permission} key: try to get all indexes and be denied`, async () => {
474-
await expect(client.listIndexes()).rejects.toHaveProperty(
474+
await expect(client.getIndexes()).rejects.toHaveProperty(
475475
'errorCode',
476476
ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
477477
)
@@ -612,11 +612,11 @@ describe.each([
612612
)
613613
})
614614

615-
test(`Test listIndexes route`, async () => {
615+
test(`Test getIndexes route`, async () => {
616616
const route = `indexes`
617617
const client = new MeiliSearch({ host })
618618
const strippedHost = trailing ? host.slice(0, -1) : host
619-
await expect(client.listIndexes()).rejects.toHaveProperty(
619+
await expect(client.getIndexes()).rejects.toHaveProperty(
620620
'message',
621621
`request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace(
622622
'http://',

‎tests/documents_tests.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -469,42 +469,42 @@ describe.each([{ client: publicClient, permission: 'Public' }])(
469469
})
470470

471471
test(`${permission} key: Try to add documents and be denied`, async () => {
472-
await expect(client.listIndexes()).rejects.toHaveProperty(
472+
await expect(client.getIndexes()).rejects.toHaveProperty(
473473
'errorCode',
474474
ErrorStatusCode.INVALID_TOKEN
475475
)
476476
})
477477

478478
test(`${permission} key: Try to update documents and be denied`, async () => {
479-
await expect(client.listIndexes()).rejects.toHaveProperty(
479+
await expect(client.getIndexes()).rejects.toHaveProperty(
480480
'errorCode',
481481
ErrorStatusCode.INVALID_TOKEN
482482
)
483483
})
484484

485485
test(`${permission} key: Try to get documents and be denied`, async () => {
486-
await expect(client.listIndexes()).rejects.toHaveProperty(
486+
await expect(client.getIndexes()).rejects.toHaveProperty(
487487
'errorCode',
488488
ErrorStatusCode.INVALID_TOKEN
489489
)
490490
})
491491

492492
test(`${permission} key: Try to delete one document and be denied`, async () => {
493-
await expect(client.listIndexes()).rejects.toHaveProperty(
493+
await expect(client.getIndexes()).rejects.toHaveProperty(
494494
'errorCode',
495495
ErrorStatusCode.INVALID_TOKEN
496496
)
497497
})
498498

499499
test(`${permission} key: Try to delete some documents and be denied`, async () => {
500-
await expect(client.listIndexes()).rejects.toHaveProperty(
500+
await expect(client.getIndexes()).rejects.toHaveProperty(
501501
'errorCode',
502502
ErrorStatusCode.INVALID_TOKEN
503503
)
504504
})
505505

506506
test(`${permission} key: Try to delete all documents and be denied`, async () => {
507-
await expect(client.listIndexes()).rejects.toHaveProperty(
507+
await expect(client.getIndexes()).rejects.toHaveProperty(
508508
'errorCode',
509509
ErrorStatusCode.INVALID_TOKEN
510510
)
@@ -520,42 +520,42 @@ describe.each([{ client: anonymousClient, permission: 'No' }])(
520520
})
521521

522522
test(`${permission} key: Try to add documents and be denied`, async () => {
523-
await expect(client.listIndexes()).rejects.toHaveProperty(
523+
await expect(client.getIndexes()).rejects.toHaveProperty(
524524
'errorCode',
525525
ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
526526
)
527527
})
528528

529529
test(`${permission} key: Try to update documents and be denied`, async () => {
530-
await expect(client.listIndexes()).rejects.toHaveProperty(
530+
await expect(client.getIndexes()).rejects.toHaveProperty(
531531
'errorCode',
532532
ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
533533
)
534534
})
535535

536536
test(`${permission} key: Try to get documents and be denied`, async () => {
537-
await expect(client.listIndexes()).rejects.toHaveProperty(
537+
await expect(client.getIndexes()).rejects.toHaveProperty(
538538
'errorCode',
539539
ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
540540
)
541541
})
542542

543543
test(`${permission} key: Try to delete one document and be denied`, async () => {
544-
await expect(client.listIndexes()).rejects.toHaveProperty(
544+
await expect(client.getIndexes()).rejects.toHaveProperty(
545545
'errorCode',
546546
ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
547547
)
548548
})
549549

550550
test(`${permission} key: Try to delete some documents and be denied`, async () => {
551-
await expect(client.listIndexes()).rejects.toHaveProperty(
551+
await expect(client.getIndexes()).rejects.toHaveProperty(
552552
'errorCode',
553553
ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
554554
)
555555
})
556556

557557
test(`${permission} key: Try to delete all documents and be denied`, async () => {
558-
await expect(client.listIndexes()).rejects.toHaveProperty(
558+
await expect(client.getIndexes()).rejects.toHaveProperty(
559559
'errorCode',
560560
ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
561561
)

‎tests/env/browser/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
host: 'http://127.0.0.1:7700',
1818
apiKey: 'masterKey',
1919
})
20-
client.listIndexes().then(res => {
20+
client.getIndexes().then(res => {
2121
console.log({ res });
2222
res.map(index => document.querySelector('#indexes').innerHTML = `<div>${index.name}</div>`)
2323
})

‎tests/env/typescript-browser/src/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ function greeter(person: string) {
1313
}
1414

1515
;(async () => {
16-
const indexes = await client.listIndexes()
16+
const indexes = await client.getIndexes()
1717
console.log({ indexes }, 'hello')
1818
const uids = indexes.map((index: IndexResponse) => index.uid)
1919
document.body.innerHTML = `${greeter(

‎tests/env/typescript-node/src/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const client = new MeiliSearch(config)
2323
;(async () => {
2424
const index = await client.getOrCreateIndex<Movie>('movies')
2525

26-
const indexes = await client.listIndexes()
26+
const indexes = await client.getIndexes()
2727
indexes.map((index: IndexResponse) => {
2828
console.log(index.uid)
2929
// console.log(index.something) -> ERROR

0 commit comments

Comments
 (0)