docs: add example for searchSchool method. Ref #12

maelgangloff · Apr 25, 2023 · 948b3bb · 948b3bb
1 parent a7076f9
commit 948b3bb
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -498,6 +498,14 @@ Skolengo.searchSchool({ text: 'Lycée Louise Weiss' }).then(schools => {
   console.log(schools)
 })
 ```
+**Example**  
+```js
+const {Skolengo} = require('scolengo-api')
+
+Skolengo.searchSchool({ lat: 48.0, lon: 7.0 }).then(schools => {
+  console.log(schools)
+})
+```
 <a name="Skolengo.getOIDClient"></a>
 
 ### Skolengo.getOIDClient(school, redirectUri)

diff --git a/src/index.ts b/src/index.ts
@@ -127,6 +127,13 @@ export class Skolengo {
    *   console.log(schools)
    * })
    * ```
+   * @example ```js
+   * const {Skolengo} = require('scolengo-api')
+   *
+   * Skolengo.searchSchool({ lat: 48.0, lon: 7.0 }).then(schools => {
+   *   console.log(schools)
+   * })
+   * ```
    * @async
    */
   public static async searchSchool (filter: SchoolFilter, limit = 10, offset = 0): Promise<SkolengoResponseData<School[]>> {

diff --git a/tests/School/Schools.test.ts b/tests/School/Schools.test.ts
@@ -210,5 +210,25 @@ describe('Test Schools', () => {
       responseType: 'json'
     })
   })
+
+  it('should searchSchool make the right request with GPS', async () => {
+    await Skolengo.searchSchool({lat: 48.0, lon: 7.0}, 10, 0)
+    expect(mockedAxios.request).toBeCalledWith({
+      baseURL: 'https://api.skolengo.com/api/v1/bff-sko-app',
+      url: '/schools',
+      method: 'get',
+      params: {
+        filter: {
+          lat: 48.0,
+          lon: 7.0
+        },
+        page: {
+          limit: 10,
+          offset: 0
+        }
+      },
+      responseType: 'json'
+    })
+  })
 })