ts-igdb - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

lib/igdb-endpoint.d.ts

@@ -70,3 +70,3 @@ import { IGDBOptions } from '../interface/igdb';
      */
-    external_review(options: IGDBOptions): Promise<ExternalReviewEndpointResponse[]>;
+    externalReview(options: IGDBOptions): Promise<ExternalReviewEndpointResponse[]>;
     /**
@@ -77,3 +77,3 @@ * Fetch data using EXTERNAL REVIEW SOURCE endpoint
      */
-    external_review_source(options: IGDBOptions): Promise<ExternalReviewSourceEndpointResponse[]>;
+    externalReviewSource(options: IGDBOptions): Promise<ExternalReviewSourceEndpointResponse[]>;
     /**
@@ -96,3 +96,3 @@ * Fetch data using FRANCHISE endpoint
      */
-    game_engine(options: IGDBOptions): Promise<GameEngineEndpointResponse[]>;
+    gameEngine(options: IGDBOptions): Promise<GameEngineEndpointResponse[]>;
     /**
@@ -103,3 +103,3 @@ * Fetch data using GAME MODE endpoint
      */
-    game_mode(options: IGDBOptions): Promise<GameModeEndpointResponse[]>;
+    gameMode(options: IGDBOptions): Promise<GameModeEndpointResponse[]>;
     /**
@@ -140,3 +140,3 @@ * Fetch data using GENRE endpoint
      */
-    player_perspective(options: IGDBOptions): Promise<PlayerPerspecitveEndpointResponse[]>;
+    playerPerspective(options: IGDBOptions): Promise<PlayerPerspecitveEndpointResponse[]>;
     /**
@@ -153,3 +153,3 @@ * Fetch data using PULSE endpoint
      */
-    pulse_group(options: IGDBOptions): Promise<PulseGroupEndpointResponse[]>;
+    pulseGroup(options: IGDBOptions): Promise<PulseGroupEndpointResponse[]>;
     /**
@@ -160,3 +160,3 @@ * Fetch data using PULSE SOURCE endpoint
      */
-    pulse_source(options: IGDBOptions): Promise<PulseSourceEndpointResponse[]>;
+    pulseSource(options: IGDBOptions): Promise<PulseSourceEndpointResponse[]>;
     /**
@@ -167,3 +167,3 @@ * Fetch data using RELEASE DATE endpoint
      */
-    release_date(options: IGDBOptions): Promise<ReleaseDateEndpointResponse[]>;
+    releaseDate(options: IGDBOptions): Promise<ReleaseDateEndpointResponse[]>;
     /**
@@ -192,3 +192,3 @@ * Fetch data using REVIEW endpoint
      */
-    user_profile(options: IGDBOptions): Promise<UserProfileEndpointResponse[]>;
+    userProfile(options: IGDBOptions): Promise<UserProfileEndpointResponse[]>;
     /**
@@ -199,3 +199,3 @@ * Fetch data using VERSIONS endpoint
      */
-    game_version(options: IGDBOptions): Promise<GameVersionEndpointResponse[]>;
+    gameVersion(options: IGDBOptions): Promise<GameVersionEndpointResponse[]>;
 }

lib/igdb-endpoint.js

@@ -91,3 +91,3 @@ "use strict";
      */
-    external_review(options) { return this.asPromise('external_reviews', options); }
+    externalReview(options) { return this.asPromise('external_reviews', options); }
     /**
@@ -98,3 +98,3 @@ * Fetch data using EXTERNAL REVIEW SOURCE endpoint
      */
-    external_review_source(options) { return this.asPromise('external_review_sources', options); }
+    externalReviewSource(options) { return this.asPromise('external_review_sources', options); }
     /**
@@ -117,3 +117,3 @@ * Fetch data using FRANCHISE endpoint
      */
-    game_engine(options) { return this.asPromise('game_engines', options); }
+    gameEngine(options) { return this.asPromise('game_engines', options); }
     /**
@@ -124,3 +124,3 @@ * Fetch data using GAME MODE endpoint
      */
-    game_mode(options) { return this.asPromise('game_modes', options); }
+    gameMode(options) { return this.asPromise('game_modes', options); }
     /**
@@ -161,3 +161,3 @@ * Fetch data using GENRE endpoint
      */
-    player_perspective(options) { return this.asPromise('player_perspectives', options); }
+    playerPerspective(options) { return this.asPromise('player_perspectives', options); }
     /**
@@ -174,3 +174,3 @@ * Fetch data using PULSE endpoint
      */
-    pulse_group(options) { return this.asPromise('pulse_groups', options); }
+    pulseGroup(options) { return this.asPromise('pulse_groups', options); }
     /**
@@ -181,3 +181,3 @@ * Fetch data using PULSE SOURCE endpoint
      */
-    pulse_source(options) { return this.asPromise('pulse_sources', options); }
+    pulseSource(options) { return this.asPromise('pulse_sources', options); }
     /**
@@ -188,3 +188,3 @@ * Fetch data using RELEASE DATE endpoint
      */
-    release_date(options) { return this.asPromise('release_dates', options); }
+    releaseDate(options) { return this.asPromise('release_dates', options); }
     /**
@@ -213,3 +213,3 @@ * Fetch data using REVIEW endpoint
      */
-    user_profile(options) { return this.asPromise('me', options); }
+    userProfile(options) { return this.asPromise('me', options); }
     /**
@@ -220,4 +220,4 @@ * Fetch data using VERSIONS endpoint
      */
-    game_version(options) { return this.asPromise('game_versions', options); }
+    gameVersion(options) { return this.asPromise('game_versions', options); }
 }
 exports.IGDBEndpoint = IGDBEndpoint;

package.json

 {
   "name": "ts-igdb",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Node.js module for IGDB written in TypeScript",
@@ -31,3 +31,3 @@ "main": "index.js",
     "@types/node": "^10.12.10",
-    "nodemon": "^1.18.4",
+    "nodemon": "^1.18.10",
     "ts-node": "^7.0.1",
@@ -34,0 +34,0 @@ "typescript": "^3.1.3"

README.md

@@ -16,10 +16,10 @@ # Node.js wrapper for IGDB API
     + [credit](#credit)
-    + [external_review](#external_review)
-    + [external_review_source](#external_review_source)
+    + [externalReview](#externalreview)
+    + [externalReviewSource](#externalreviewsource)
     + [feed](#feed)
     + [franchise](#franchise)
     + [game](#game)
-    + [game_engine](#game_engine)
-    + [game_mode](#game_mode)
-    + [game_version](#game_version)
+    + [gameEngine](#gameengine)
+    + [gameMode](#gamemode)
+    + [gameVersion](#gameversion)
     + [genre](#genre)
@@ -30,11 +30,11 @@ + [keyword](#keyword)
     + [platform](#platform)
-    + [player_perspecitve](#player_perspecitve)
+    + [playerPerspecitve](#playerperspecitve)
     + [pulse](#pulse)
-    + [pulse_group](#pulse_group)
-    + [pulse_source](#pulse_source)
-    + [release_date](#release_date)
+    + [pulseGroup](#pulsegroup)
+    + [pulseSource](#pulsesource)
+    + [releaseDate](#releasedate)
     + [review](#review)
     + [theme](#theme)
     + [title](#title)
-    + [user_profile](#user_profile)
+    + [userProfile](#userprofile)
   * [IGDB url](#igdb-url)
@@ -60,2 +60,4 @@ + [Query String](#query-string)
   * [Get the parent game for a version](#get-the-parent-game-for-a-version)
+- [Changelog](#changelog)
+  * [2019.03.02 - v1.1.3](#20190302---v113)
 
@@ -153,3 +155,3 @@ <!-- tocstop -->
  - ``expand [optional]``: The expander feature is used to combine multiple requests. Have to be provided as an array of strings.
- - ``filters [optional]``: Filters are used to swift through results to get what you want. You can exclude and include results based on their properties. The parameter have to be provided as an array. The elements have to contain an object with the following parameters (these are not optional, all three parameters are required):
+ - ``filters [optional]``: Filters are used to swift through results to get what you want. You can exclude and include results based on their properties. The parameter have to be provided as an array. The elements have to be objects with the following parameters (these are not optional, all three parameters are required):
    - ``field``: The name of the field you want to apply the filter to
@@ -224,5 +226,5 @@ - ``postfix``: The postfix you want to use with the filter. The values can be
 
-#### external_review
+#### externalReview
 
-``IGDB.endpoint.externalreview(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``ExternalReviewEndpointResponse``](interface/endpoint-response/external-review-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.externalReview(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``ExternalReviewEndpointResponse``](interface/endpoint-response/external-review-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -232,5 +234,5 @@ For more information check the [IGDB External Review Endpoint Documentation](https://igdb.github.io/api/endpoints/external-review).
 
-#### external_review_source
+#### externalReviewSource
 
-``IGDB.endpoint.externalreviewsource(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``ExternalReviewSourceEndpointResponse``](interface/endpoint-response/external-review-source-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.externalReviewSource(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``ExternalReviewSourceEndpointResponse``](interface/endpoint-response/external-review-source-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -261,5 +263,5 @@ For more information check the [IGDB External Review Source Endpoint Documentation](https://igdb.github.io/api/endpoints/external-review-source).
 
-#### game_engine
+#### gameEngine
 
-``IGDB.endpoint.gameengine(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``GameEngineEndpointResponse``](interface/endpoint-response/game-engine-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.gameEngine(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``GameEngineEndpointResponse``](interface/endpoint-response/game-engine-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -269,5 +271,5 @@ For more information check the [IGDB Game Engine Endpoint Documentation](https://igdb.github.io/api/endpoints/game-engine).
 
-#### game_mode
+#### gameMode
 
-``IGDB.endpoint.gamemode(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``GameModeEndpointResponse``](interface/endpoint-response/game-mode-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.gameMode(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``GameModeEndpointResponse``](interface/endpoint-response/game-mode-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -277,5 +279,5 @@ For more information check the [IGDB Game Mode Endpoint Documentation](https://igdb.github.io/api/endpoints/game-mode).
 
-#### game_version
+#### gameVersion
 
-``IGDB.endpoint.game_version(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``GameVersionEndpointResponse``](interface/endpoint-response/versions-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.gameVersion(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``GameVersionEndpointResponse``](interface/endpoint-response/versions-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -320,5 +322,5 @@ For more information check the [IGDB Game Version Endpoint Documentation](https://igdb.github.io/api/endpoints/versions).
 
-#### player_perspecitve
+#### playerPerspecitve
 
-``IGDB.endpoint.playerperspecitve(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``PlayerPerspecitveEndpointResponse``](interface/endpoint-response/player-perspective-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.playerPerspecitve(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``PlayerPerspecitveEndpointResponse``](interface/endpoint-response/player-perspective-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -335,5 +337,5 @@ For more information check the [IGDB Player Perspecitve Endpoint Documentation](https://igdb.github.io/api/endpoints/player-perspective).
 
-#### pulse_group
+#### pulseGroup
 
-``IGDB.endpoint.pulsegroup(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``PulseGroupEndpointResponse``](interface/endpoint-response/pulse-group-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.pulseGroup(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``PulseGroupEndpointResponse``](interface/endpoint-response/pulse-group-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -343,5 +345,5 @@ For more information check the [IGDB Pulse Group Endpoint Documentation](https://igdb.github.io/api/endpoints/pulse-group).
 
-#### pulse_source
+#### pulseSource
 
-``IGDB.endpoint.pulsesource(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``PulseSourceEndpointResponse``](interface/endpoint-response/pulse-source-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.pulseSource(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``PulseSourceEndpointResponse``](interface/endpoint-response/pulse-source-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -351,5 +353,5 @@ For more information check the [IGDB Pulse Source Endpoint Documentation](https://igdb.github.io/api/endpoints/pulse-source).
 
-#### release_date
+#### releaseDate
 
-``IGDB.endpoint.releasedate(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``ReleaseDateEndpointResponse``](interface/endpoint-response/release-date-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.releaseDate(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``ReleaseDateEndpointResponse``](interface/endpoint-response/release-date-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -380,5 +382,5 @@ For more information check the [IGDB Release Date Endpoint Documentation](https://igdb.github.io/api/endpoints/release-date).
 
-#### user_profile
+#### userProfile
 
-``IGDB.endpoint.user_profile(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``UserProfileEndpointResponse``](interface/endpoint-response/me-endpoint-response.interface.ts)``[]>``
+``IGDB.endpoint.userProfile(options: ``[``IGDBOptions``](interface/igdb/igdb-options.interface.ts)``): Promise<``[``UserProfileEndpointResponse``](interface/endpoint-response/me-endpoint-response.interface.ts)``[]>``
 <br/><br/>
@@ -522,6 +524,6 @@ For more information check the [IGDB User Profile Endpoint Documentation](https://igdb.github.io/api/endpoints/me).
 ```
-import { IGDBOptions } from 'ts-igdb/interface/igdb';
+import { <INTERFACES> } from 'ts-igdb/interface/igdb';
 ```
 
-These are declaring the types of the options object. It is enough to import only the IGDBOptions interface. OrderOption and FilterOption interfaces are part of IGDBOptions.
+IGDBOptions can be imported from here which is declaring the type of the options object. It is enough to import only the IGDBOptions interface, since FilterOption and OrderOption is part of the IGDB object. However you can import them if required.
 
@@ -967,2 +969,17 @@ - [IGDBOptions](interface/igdb/igdb-options.interface.ts)
 )
-```
+```
+
+## Changelog
+### 2019.03.02 - v1.1.3
+ - Updated dependencies: nodemon had a potential security vulnerability
+ - Updated endpoint method names: converted method names to Camel Case
+   - external_review => [externalReview](#externalreview)
+   - external_review_source => [externalReviewSource](#externalreviewsource)
+   - game_engine => [gameEngine](#gameengine)
+   - game_mode => [gameMode](#gameMode)
+   - game_version => [gameVersion](#gameversion)
+   - player_perspective => [playerPerspecitve](#playerperspecitve)
+   - pulse_group => [pulseGroup](#pulsegroup)
+   - pulse_source => [pulseSource](#pulsesource)
+   - release_date => [releaseDate](#releasedate)
+   - user_profile => [userProfile](#userprofile)

New alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

96897

increased by0.84%

Number of lines in readme file

969

increased by1.79%

Worsened metrics

Number of high maintenance alerts

1

increased byInfinity%

No dependency changes