stan-api - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

dist/index.js

@@ -27,3 +27,3 @@ "use strict";
     * ```
-    * @returns {Promise<Ligne[]>}
+    * @returns {Promise<Ligne[]>} Une liste contenant les lignes du réseau
     */
@@ -61,3 +61,3 @@ static async getLignes() {
      * ```
-     * @returns {Promise<Arret[]>}
+     * @returns {Promise<Arret[]>} Une liste contenant les arrêts de la ligne
      */
@@ -117,3 +117,3 @@ static async getArrets(ligne) {
      * ```
-     * @returns {Promise<Passage[]>}
+     * @returns {Promise<Passage[]>} Les prochains passages d'un arrêt
      */
@@ -180,3 +180,3 @@ static async getProchainsPassages(arret) {
      * ```
-     * @returns {Promise<Direction[]>}
+     * @returns {Promise<Direction[]>} Une liste contenant les directions d'une ligne
      */
@@ -210,3 +210,3 @@ static async getDirections(ligne) {
      * @param {Direction} direction Direction d'une ligne
-     * @returns {Promise<Arret[]>}
+     * @returns {Promise<Arret[]>} Les arrêts de la direction
      */
@@ -242,2 +242,18 @@ static async getArretsDirection(direction) {
     }
+    /**
+     * Rechercher un arrêt et obtenir l'identifiant associé (OSMID) nécessaire pour obtenir les prochains passages
+     * @param {string} request Le nom d'un arrêt à chercher
+     * @returns Une liste contenant les arrêts et les identifiants associés
+     */
+    static async getArretOsmid(request) {
+        return (await Stan.getClient().request({
+            method: 'POST',
+            data: qs_1.default.stringify({
+                requete: 'autocomplete_places',
+                requete_val: {
+                    request
+                }
+            })
+        })).data.filter((place) => place.value.startsWith('stop_area:')).map(place => ({ osmid: place.value, libelle: place.label }));
+    }
     static getClient() {
@@ -244,0 +260,0 @@ return axios_1.default.create({

package.json

 {
   "name": "stan-api",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "author": {
@@ -5,0 +5,0 @@ "name": "Maël Gangloff",

README.md

@@ -61,3 +61,4 @@ <a name="Stan"></a>
 ### Stan.getProchainsPassages(arret) ⇒ <code>Promise.&lt;Array.&lt;Passage&gt;&gt;</code>
-Lister les prochains passages d'un arrêt avec le temps d'attente estimé
+Lister les prochains passages d'un arrêt avec le temps d'attente estimé.
+Il n'est pas nécessaire de préciser une ligne, on récupère alors tous les passages des lignes desservants l'arrêt
 
@@ -64,0 +65,0 @@ **Kind**: static method of [<code>Stan</code>](#Stan)

types/index.d.ts

@@ -23,3 +23,3 @@ import { Arret } from './Ligne/Arret';
     * ```
-    * @returns {Promise<Ligne[]>}
+    * @returns {Promise<Ligne[]>} Une liste contenant les lignes du réseau
     */
@@ -43,3 +43,3 @@ static getLignes(): Promise<Ligne[]>;
      * ```
-     * @returns {Promise<Arret[]>}
+     * @returns {Promise<Arret[]>} Une liste contenant les arrêts de la ligne
      */
@@ -80,3 +80,3 @@ static getArrets(ligne: Partial<Ligne> & {
      * ```
-     * @returns {Promise<Passage[]>}
+     * @returns {Promise<Passage[]>} Les prochains passages d'un arrêt
      */
@@ -101,3 +101,3 @@ static getProchainsPassages(arret: Partial<Arret> & {
      * ```
-     * @returns {Promise<Direction[]>}
+     * @returns {Promise<Direction[]>} Une liste contenant les directions d'une ligne
      */
@@ -111,6 +111,15 @@ static getDirections(ligne: Partial<Ligne> & {
      * @param {Direction} direction Direction d'une ligne
-     * @returns {Promise<Arret[]>}
+     * @returns {Promise<Arret[]>} Les arrêts de la direction
      */
     static getArretsDirection(direction: Direction): Promise<Arret[]>;
+    /**
+     * Rechercher un arrêt et obtenir l'identifiant associé (OSMID) nécessaire pour obtenir les prochains passages
+     * @param {string} request Le nom d'un arrêt à chercher
+     * @returns Une liste contenant les arrêts et les identifiants associés
+     */
+    static getArretOsmid(request: string): Promise<{
+        osmid: string;
+        libelle: string;
+    }[]>;
     private static getClient;
 }

No alert changes

Improved metrics

Total package byte prevSize

56446

3.21%

Number of package files

15

15.38%

Lines of code

433

7.71%

Number of lines in readme file

131

0.77%

No dependency changes