Merge branch 'main' into bump-meilisearch-v0.21.0

Author: curquiza

.github/dependabot.yml

@@ -1,17 +1,17 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: weekly
-    time: "04:00"
-  open-pull-requests-limit: 10
-  labels:
-  - skip-changelog
-  - dependencies
-  versioning-strategy: increase
-  rebase-strategy: disabled
-  ignore:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: weekly
+      time: "04:00"
+    open-pull-requests-limit: 10
+    labels:
+      - skip-changelog
+      - dependencies
+    versioning-strategy: increase
+    rebase-strategy: disabled
+    ignore:
       - dependency-name: "eslint*"
       - dependency-name: "babel-eslint"
       - dependency-name: "*prettier*"

.github/workflows/pre-release-tests.yml

@@ -17,6 +17,12 @@ jobs:
     name: integration-tests-against-rc (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v2
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: |
+            ./node_modules
+          key: ${{ hashFiles('yarn.lock') }}
       - name: Setup node
         uses: actions/setup-node@v1
         with:

.github/workflows/tests.yml

@@ -22,6 +22,12 @@ jobs:
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v2
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: |
+            ./node_modules
+          key: ${{ hashFiles('yarn.lock') }}
       - name: Setup node
         uses: actions/setup-node@v1
         with:
@@ -50,9 +56,19 @@ jobs:
     name: linter-check
     steps:
       - uses: actions/checkout@v2
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: |
+            ./node_modules
+          key: ${{ hashFiles('yarn.lock') }}
       - name: Setup node
         uses: actions/setup-node@v1
       - name: Install dependencies
         run: yarn --dev
       - name: Run style check
         run: yarn style
+      - name: yaml-lint
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          config_file: .yamllint.yml

.yamllint.yml

@@ -0,0 +1,9 @@
+extends: default
+ignore: |
+  node_modules
+
+rules:
+  line-length: disable
+  document-start: disable
+  brackets: disable
+  truthy: disable

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://res.cloudinary.com/meilisearch/image/upload/v1587402338/SDKs/meilisearch_js.svg" alt="MeiliSearch-JavaScript" width="200" height="200" />
+  <img src="https://images.meilisearch.workers.dev/v1587402338/SDKs/meilisearch_js.svg" alt="MeiliSearch-JavaScript" width="200" height="200" />
 </p>
 
 <h1 align="center">MeiliSearch JavaScript</h1>
@@ -118,6 +118,20 @@ const client = new MeiliSearch({
 
 To make this package work with React Native, please add the [react-native-url-polyfill](https://www.npmjs.com/package/react-native-url-polyfill).
 
+#### Deno<!-- omit in toc -->
+
+Usage in a back-end deno environment
+
+```ts
+import { MeiliSearch } from "https://esm.sh/meilisearch"
+
+const client = new MeiliSearch({
+  host: 'http://127.0.0.1:7700',
+  apiKey: 'masterKey',
+})
+```
+
+
 ## 🎬 Getting Started
 
 #### Add Documents <!-- omit in toc -->
@@ -328,7 +342,7 @@ If you want to know more about the development workflow or want to contribute, p
 
 - Get an index:
 
-`client.getIndex<T>(uid: string): Index<T>`
+`client.getIndex<T>(uid: string): Promise<Index<T>>`
 
 - Get or create index if it does not exist
 
@@ -340,7 +354,7 @@ If you want to know more about the development workflow or want to contribute, p
 
 - Update Index:
 
-`client.updateIndex(uid): Promise<Index>`
+`client.updateIndex(uid: string, options: IndexOptions): Promise<Index>`
 Or using the index object:
 `index.update(data: IndexOptions): Promise<Index>`