Skip to content

Commit 20afc0e

Browse files
committed
add more code samples
1 parent 1518d89 commit 20afc0e

File tree

1 file changed

+181
-0
lines changed

1 file changed

+181
-0
lines changed

.code-samples.meilisearch.yaml

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,184 @@ get_pretty_sys_info_1: |-
159159
client.systemInformationPretty()
160160
get_sys_info_1: |-
161161
client.systemInformation()
162+
distinct_attribute_guide_1: |-
163+
client.getindex('jackets').settings({ distinctAttribute: 'product_id' })
164+
field_properties_guide_searchable_1: |-
165+
client.getindex('movies').settings({
166+
searchableAttributes: [
167+
'uid',
168+
'movie_id',
169+
'title',
170+
'description',
171+
'poster',
172+
'release_date',
173+
'rank'
174+
]
175+
})
176+
field_properties_guide_displayed_1: |-
177+
client.getindex('movies').settings({
178+
displayedAttributes: [
179+
'title',
180+
'description',
181+
'poster',
182+
'release_date',
183+
'rank'
184+
]
185+
})
186+
filtering_guide_1: |-
187+
client.getIndex('movies').search('Avengers', {
188+
filters: 'release_date > 795484800'
189+
})
190+
filtering_guide_2: |-
191+
client.getIndex('movies').search('Batman', {
192+
filters: 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan"'
193+
})
194+
filtering_guide_3: |-
195+
client.getIndex('movies').search('horror', {
196+
filters: 'director = "Jordan Peele"'
197+
})
198+
filtering_guide_4: |-
199+
client.getIndex('movies').search('Planet of the Apes', {
200+
filters: 'rating >= 3 AND (NOT director = "Tim Burton"'
201+
})
202+
search_parameter_guide_query_1: |-
203+
client.getIndex('movies').search('shifu')
204+
search_parameter_guide_offset_1: |-
205+
client.getIndex('movies').search('shifu', {
206+
offset: 1
207+
})
208+
search_parameter_guide_limit_1: |-
209+
client.getIndex('movies').search('shifu', {
210+
limit: 2
211+
})
212+
search_parameter_guide_retrieve_1: |-
213+
client.getIndex('movies').search('shifu', {
214+
attributesToRetrieve: ['overview', 'title']
215+
})
216+
search_parameter_guide_crop_1: |-
217+
client.getIndex('movies').search('shifu', {
218+
attributesToCrop: 'overview',
219+
cropLength: 10
220+
})
221+
search_parameter_guide_highlight_1: |-
222+
client.getIndex('movies').search('shifu', {
223+
attributesToHighlight: ['overview']
224+
})
225+
search_parameter_guide_filter_1: |-
226+
client.getIndex('movies').search('n', {
227+
filters: 'title = Nightshift'
228+
})
229+
search_parameter_guide_filter_2: |-
230+
client.getIndex('movies').search('n', {
231+
filters: 'title="Kung Fu Panda"'
232+
})
233+
search_parameter_guide_matches_1: |-
234+
client.getIndex('movies').search('n', {
235+
filters: 'title="Kung Fu Panda"',
236+
attributesToHighlight: ['overview'],
237+
matches: true
238+
})
239+
settings_guide_synonyms_1: |-
240+
client.getindex('tops').settings({
241+
synonyms: {
242+
sweater: ['jumper'],
243+
jumper: ['sweater']
244+
})
245+
settings_guide_stop_words_1: |-
246+
client.getindex('movies').settings({
247+
stopWords: [
248+
'the',
249+
'a',
250+
'an'
251+
]
252+
})
253+
settings_guide_ranking_rules_1: |-
254+
client.getindex('movies').settings({
255+
rankingRules: [
256+
'typo',
257+
'words',
258+
'proximity',
259+
'attribute',
260+
'wordsPosition',
261+
'exactness',
262+
'asc(release_date)',
263+
'desc(rank)'
264+
]
265+
})
266+
settings_guide_distinct_1: |-
267+
client.getindex('movies').settings({
268+
distinctAttribute: 'product_id'
269+
})
270+
settings_guide_searchable_1: |-
271+
client.getindex('movies').settings({
272+
searchableAttributes: [
273+
'uid',
274+
'movie_id',
275+
'title',
276+
'description',
277+
'poster',
278+
'release_date',
279+
'rank'
280+
]
281+
})
282+
settings_guide_displayed_1: |-
283+
client.getindex('movies').settings({
284+
displayedAttributes: [
285+
'title',
286+
'description',
287+
'poster',
288+
'release_date',
289+
'rank'
290+
]
291+
})
292+
settings_guide_accept_new_fields_1: |-
293+
client.getindex('movies').settings({
294+
acceptNewFields: false
295+
})
296+
add_movies_json_1: |-
297+
const movies = require('./movies.json')
298+
index.addDocuments(movies).then((res) => console.log(res))
299+
documents_guide_add_movie_1: |-
300+
index.addDocuments([{
301+
"movie_id": "123sq178",
302+
"title": "Amelie Poulain"
303+
}])
304+
search_guide_1: |-
305+
client.getIndex('movies').search('shifu', {
306+
limit: 5,
307+
offset: 10
308+
})
309+
search_guide_2: |-
310+
client.getIndex('movies').search('Avengers', {
311+
filters: 'release_date > 795484800',
312+
})
313+
getting_started_create_index_md: |-
314+
```bash
315+
$ npm install meilisearch
316+
# or
317+
$ yarn add meilisearch
318+
```
319+
320+
```javascript
321+
const MeiliSearch = require('meilisearch')
322+
323+
var client = new MeiliSearch({ host: 'http://127.0.0.1:7700' })
324+
const index = client
325+
.createIndex({ uid: 'movies' })
326+
.then((res) => console.log(res))
327+
```
328+
329+
[About this package](https://github.com/meilisearch/meilisearch-js/)
330+
getting_started_add_documents_md: |-
331+
```js
332+
const movies = require('./movies.json')
333+
index.addDocuments(movies).then((res) => console.log(res))
334+
```
335+
336+
[About this package](https://github.com/meilisearch/meilisearch-js/)
337+
getting_started_search_md: |-
338+
```js
339+
index.search('botman').then((res) => console.log(res))
340+
```
341+
342+
[About this package](https://github.com/meilisearch/meilisearch-js/)

0 commit comments

Comments
 (0)