Refactor: Alias getCalamities to getDisruptions

README.md

@@ -120,25 +120,6 @@ ns.getArrivals( {
 [API documentation](https://apiportal.ns.nl/docs/services/reisinformatie-api/operations/getArrivals)
 
 
-### getCalamities
-**( [object] ) : array**
-
-List of all current calamities
-
-| parameter  | type           | description   |
-|:-----------|:---------------|:--------------|
-| [lang]     | string         | Text language |
-
-```js
-ns.getArrivals( { lang: 'en' } )
-  .then( console.log )
-  .catch( console.error )
-;
-```
-
-[API documentation](https://apiportal.ns.nl/docs/services/reisinformatie-api/operations/getCalamities)
-
-
 ### getDepartures
 **( object ) : array**
 

nsapi.js

@@ -40,7 +40,7 @@
    * @return  {Promise<object>}
    */
 
   async _request ( { path, parameters } ) {
     let url = `https://gateway.apiportal.ns.nl${path}`;
     const params = new URLSearchParams( parameters );
 
@@ -135,19 +135,15 @@
 
 
   /**
-   * Get calamities
+   * Get calamities - DEPRECATED
    *
    * @param   {object}          [parameters]  Request parameters
    * @return  {Promise<array>}
    */
 
   async getCalamities ( parameters = {} ) {
-    const data = await this._request( {
-      path: '/reisinformatie-api/api/v1/calamities',
-      parameters,
-    } );
-
-    return data.meldingen;
+    console.trace( 'DEPRECATED - getCalamities is deprecated by the API, use getDisruptions' );
+    return this.getDisruptions( parameters );
   }
 
 

test.js

@@ -22,7 +22,7 @@
 
 
 // ! Basic tests
 dotest.add( 'Module', async test => {
   test()
     .isClass( 'fail', 'exports', app )
     .isAsyncFunction( 'fail', '.getAllStations', ns?.getAllStations )
@@ -189,26 +189,6 @@
 } );
 
 
-dotest.add( 'Method .getCalamities', async test => {
-  let data;
-  let error;
-
-  try {
-    data = await ns.getCalamities();
-  }
-  catch ( err ) {
-    error = err;
-  }
-  finally {
-    test( error )
-      .isArray( 'fail', 'data', data )
-      .isNotEmpty( 'warn', 'data', data )
-      .done()
-    ;
-  }
-} );
-
-
 dotest.add( 'Method .getDepartures - Without dateTime', async test => {
   let data;
   let error;
@@ -356,6 +336,26 @@
 } );
 
 
+dotest.add( 'Method .getCalamities (alias)', async test => {
+  let data;
+  let error;
+
+  try {
+    data = await ns.getCalamities();
+  }
+  catch ( err ) {
+    error = err;
+  }
+  finally {
+    test( error )
+      .isArray( 'fail', 'data', data )
+      .isNotEmpty( 'warn', 'data', data )
+      .done()
+    ;
+  }
+} );
+
+
 dotest.add( 'Method .getTrips - Without dateTime', async test => {
   let data;
   let error;