Skip to content

Commit 6a7c074

Browse files
authored
Rename Meilisearch class into MeiliSearch (#467)
1 parent ca08d85 commit 6a7c074

File tree

4 files changed

+25
-25
lines changed

4 files changed

+25
-25
lines changed

src/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
2-
* Bundle: Meilisearch / Indexes
3-
* Project: Meilisearch - Javascript API
2+
* Bundle: MeiliSearch / Indexes
3+
* Project: MeiliSearch - Javascript API
44
* Author: Quentin de Quelen <[email protected]>
5-
* Copyright: 2019, Meilisearch
5+
* Copyright: 2019, MeiliSearch
66
*/
77

88
'use strict'

src/meili-axios-wrapper.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
2-
* Bundle: Meilisearch
3-
* Project: Meilisearch - Javascript API
2+
* Bundle: MeiliSearch
3+
* Project: MeiliSearch - Javascript API
44
* Author: Quentin de Quelen <[email protected]>
5-
* Copyright: 2019, Meilisearch
5+
* Copyright: 2019, MeiliSearch
66
*/
77

88
'use strict'

src/meilisearch.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
2-
* Bundle: Meilisearch
3-
* Project: Meilisearch - Javascript API
2+
* Bundle: MeiliSearch
3+
* Project: MeiliSearch - Javascript API
44
* Author: Quentin de Quelen <[email protected]>
5-
* Copyright: 2019, Meilisearch
5+
* Copyright: 2019, MeiliSearch
66
*/
77

88
'use strict'
@@ -11,7 +11,7 @@ import { Index } from './index'
1111
import MeiliAxiosWrapper from './meili-axios-wrapper'
1212
import * as Types from './types'
1313

14-
class Meilisearch extends MeiliAxiosWrapper
14+
class MeiliSearch extends MeiliAxiosWrapper
1515
implements Types.MeiliSearchInterface {
1616
config: Types.Config
1717
constructor(config: Types.Config) {
@@ -21,7 +21,7 @@ class Meilisearch extends MeiliAxiosWrapper
2121

2222
/**
2323
* Return an Index instance
24-
* @memberof Meilisearch
24+
* @memberof MeiliSearch
2525
* @method getIndex
2626
*/
2727
getIndex<T = any>(indexUid: string): Index<T> {
@@ -30,7 +30,7 @@ class Meilisearch extends MeiliAxiosWrapper
3030

3131
/**
3232
* Get an index or create it if it does not exist
33-
* @memberof Meilisearch
33+
* @memberof MeiliSearch
3434
* @method getOrCreateIndex
3535
*/
3636
async getOrCreateIndex<T = any>(
@@ -50,7 +50,7 @@ class Meilisearch extends MeiliAxiosWrapper
5050

5151
/**
5252
* List all indexes in the database
53-
* @memberof Meilisearch
53+
* @memberof MeiliSearch
5454
* @method listIndexes
5555
*/
5656
async listIndexes(): Promise<Types.IndexResponse[]> {
@@ -61,7 +61,7 @@ class Meilisearch extends MeiliAxiosWrapper
6161

6262
/**
6363
* Create a new index
64-
* @memberof Meilisearch
64+
* @memberof MeiliSearch
6565
* @method createIndex
6666
*/
6767
async createIndex<T = any>(
@@ -80,7 +80,7 @@ class Meilisearch extends MeiliAxiosWrapper
8080

8181
/**
8282
* Get private and public key
83-
* @memberof Meilisearch
83+
* @memberof MeiliSearch
8484
* @method getKey
8585
*/
8686
async getKeys(): Promise<Types.Keys> {
@@ -95,7 +95,7 @@ class Meilisearch extends MeiliAxiosWrapper
9595

9696
/**
9797
* Check if the server is healhty
98-
* @memberof Meilisearch
98+
* @memberof MeiliSearch
9999
* @method isHealthy
100100
*/
101101
async isHealthy(): Promise<boolean> {
@@ -106,7 +106,7 @@ class Meilisearch extends MeiliAxiosWrapper
106106

107107
/**
108108
* Change the healthyness to healthy
109-
* @memberof Meilisearch
109+
* @memberof MeiliSearch
110110
* @method setHealthy
111111
*/
112112
async setHealthy(): Promise<void> {
@@ -119,7 +119,7 @@ class Meilisearch extends MeiliAxiosWrapper
119119

120120
/**
121121
* Change the healthyness to unhealthy
122-
* @memberof Meilisearch
122+
* @memberof MeiliSearch
123123
* @method setUnhealthy
124124
*/
125125
async setUnhealthy(): Promise<void> {
@@ -132,7 +132,7 @@ class Meilisearch extends MeiliAxiosWrapper
132132

133133
/**
134134
* Set the healthyness to health value
135-
* @memberof Meilisearch
135+
* @memberof MeiliSearch
136136
* @method changeHealthTo
137137
*/
138138
async changeHealthTo(health: boolean): Promise<void> {
@@ -149,7 +149,7 @@ class Meilisearch extends MeiliAxiosWrapper
149149

150150
/**
151151
* Get the stats of all the database
152-
* @memberof Meilisearch
152+
* @memberof MeiliSearch
153153
* @method stats
154154
*/
155155
async stats(): Promise<Types.Stats> {
@@ -160,7 +160,7 @@ class Meilisearch extends MeiliAxiosWrapper
160160

161161
/**
162162
* Get the version of MeiliSearch
163-
* @memberof Meilisearch
163+
* @memberof MeiliSearch
164164
* @method version
165165
*/
166166
async version(): Promise<Types.Version> {
@@ -171,7 +171,7 @@ class Meilisearch extends MeiliAxiosWrapper
171171

172172
/**
173173
* Get the server consuption, RAM / CPU / Network
174-
* @memberof Meilisearch
174+
* @memberof MeiliSearch
175175
* @method sysInfo
176176
*/
177177
async sysInfo(): Promise<Types.SysInfo> {
@@ -182,7 +182,7 @@ class Meilisearch extends MeiliAxiosWrapper
182182

183183
/**
184184
* Get the server consuption, RAM / CPU / Network. All information as human readable
185-
* @memberof Meilisearch
185+
* @memberof MeiliSearch
186186
* @method prettySysInfo
187187
*/
188188
async prettySysInfo(): Promise<Types.SysInfoPretty> {
@@ -192,4 +192,4 @@ class Meilisearch extends MeiliAxiosWrapper
192192
}
193193
}
194194

195-
export default Meilisearch
195+
export default MeiliSearch

src/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Type definitions for meilisearch 0.10.0
1+
// Type definitions for meilisearch
22
// Project: https://github.com/meilisearch/meilisearch-js
33
// Definitions by: qdequele <[email protected]> <https://github.com/meilisearch>
44
// Definitions: https://github.com/meilisearch/meilisearch-js

0 commit comments

Comments
 (0)