fpl-api-node - npm Package Compare versions

Comparing version 1.0.7 to 1.0.8

package.json

 {
   "name": "fpl-api-node",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "A simple node wrapper for the Fantasy Premier League (fantasy.premierleague.com) restful web api",
-  "main": "lib/index.js",
-  "typings": "lib/index",
+  "main": "dist/index.js",
+  "typings": "dist/index",
   "files": [
-    "lib/"
+    "dist/"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "docs": "typedoc --out docs --mode file --readme none --hideGenerator"
+    "docs": "typedoc --out docs --mode file --excludePrivate --readme none --hideGenerator",
+    "lint": "tslint --project tsconfig.json"
   },
@@ -30,6 +31,10 @@ "repository": {
   "dependencies": {
-    "@types/node-fetch": "^1.6.6",
     "node-fetch": "^1.6.3"
   },
-  "devDependencies": {}
+  "devDependencies": {
+    "@types/node-fetch": "^1.6.7",
+    "tslint": "^5.1.0",
+    "typedoc": "^0.5.10",
+    "typescript": "^2.2.2"
+  }
 }

README.md

@@ -16,17 +16,10 @@ # fpl-api-node
 
-Typescript:
 ```js
-import * as fplapi from 'fpl-api-node';
+const { FplDataApi } = require('fpl-api-node');
 ```
 
-Javascript:
-
-```js
-const fplapi = require('fpl-api-node');
-```
-
 ### Example
 
 ```js
-fplapi.getEntry(123456).then((data) => {
+FplDataApi.getEntry(123456).then((data) => {
 
@@ -41,104 +34,4 @@ // do something with our data
 
-## Documentation
+## API
 
-### Typescript
-
-Typescript docs can be found at <a href="https://tgreyuk.github.io/fpl-api-node">https://tgreyuk.github.io/fpl-api-node</a>
-
-### API
-
-<a name="module_fplApiNode"></a>
-
-* [fplApiNode](#module_fplApiNode)
-    * [~getEntry(entryId)](#module_fplApiNode..getEntry) ⇒ <code>Promise</code>
-    * [~getEntryEvent(entryId, eventNumber)](#module_fplApiNode..getEntryEvent) ⇒ <code>Promise</code>
-    * [~getEntryTransfers(entryId)](#module_fplApiNode..getEntryTransfers) ⇒ <code>Promise</code>
-    * [~getAllStaticData()](#module_fplApiNode..getAllStaticData) ⇒ <code>Promise</code>
-    * [~getTeams()](#module_fplApiNode..getTeams) ⇒ <code>Promise</code>
-    * [~getElements()](#module_fplApiNode..getElements) ⇒ <code>Promise</code>
-    * [~getElementTypes()](#module_fplApiNode..getElementTypes) ⇒ <code>Promise</code>
-    * [~getGameSettings()](#module_fplApiNode..getGameSettings) ⇒ <code>Promise</code>
-    * [~getEvent()](#module_fplApiNode..getEvent) ⇒ <code>Promise</code>
-    * [~getClassicLeagueStandings(leagueId)](#module_fplApiNode..getClassicLeagueStandings) ⇒ <code>Promise</code>
-
-<a name="module_fplApiNode..getEntry"></a>
-
-### fplApiNode~getEntry(entryId) ⇒ <code>Promise</code>
-Entry (Fpl manager team): A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/entry/${id}/history
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-
-| Param | Description |
-| --- | --- |
-| entryId | Entry id |
-
-<a name="module_fplApiNode..getEntryEvent"></a>
-
-### fplApiNode~getEntryEvent(entryId, eventNumber) ⇒ <code>Promise</code>
-Entry event. Details of a particular event (or gameweek): A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/entry/${id}/event/${eventNumber}
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-
-| Param | Description |
-| --- | --- |
-| entryId | Entry id |
-| eventNumber | The event / gameweek number |
-
-<a name="module_fplApiNode..getEntryTransfers"></a>
-
-### fplApiNode~getEntryTransfers(entryId) ⇒ <code>Promise</code>
-Entry transfers: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/entry/${id}/transfers
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-
-| Param | Description |
-| --- | --- |
-| entryId | Entry id |
-
-<a name="module_fplApiNode..getAllStaticData"></a>
-
-### fplApiNode~getAllStaticData() ⇒ <code>Promise</code>
-All static game data: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/bootstrap-static
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-<a name="module_fplApiNode..getTeams"></a>
-
-### fplApiNode~getTeams() ⇒ <code>Promise</code>
-Teams (Premier Leaugue clubs): A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/teams
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-<a name="module_fplApiNode..getElements"></a>
-
-### fplApiNode~getElements() ⇒ <code>Promise</code>
-Elements (players): A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/elements
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-<a name="module_fplApiNode..getElementTypes"></a>
-
-### fplApiNode~getElementTypes() ⇒ <code>Promise</code>
-Element types: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/elements-types
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-<a name="module_fplApiNode..getGameSettings"></a>
-
-### fplApiNode~getGameSettings() ⇒ <code>Promise</code>
-Game settings: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/game-settings
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-<a name="module_fplApiNode..getEvent"></a>
-
-### fplApiNode~getEvent() ⇒ <code>Promise</code>
-Event /gameweek details: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/event/${eventNumber}/live
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-<a name="module_fplApiNode..getClassicLeagueStandings"></a>
-
-### fplApiNode~getClassicLeagueStandings(leagueId) ⇒ <code>Promise</code>
-Classic league standings: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/leagues-classic-standings/${id}
-
-**Kind**: inner method of <code>[fplApiNode](#module_fplApiNode)</code>
-
-| Param | Description |
-| --- | --- |
-| leagueId | League id |
-
+API docs can be found at <a href="https://tgreyuk.github.io/fpl-api-node">https://tgreyuk.github.io/fpl-api-node</a>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dependency count

1

decreased by-50%

Number of package files

6

increased by20%

Lines of code

752

increased by1.76%

Worsened metrics

Total package byte prevSize

25980

decreased by-9.61%

Dev dependency count

4

increased byInfinity%

Number of lines in readme file

36

decreased by-74.83%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removed@types/node-fetch@^1.6.6

• - Removed@types/node@22.10.2(transitive)

• - Removed@types/node-fetch@1.6.9(transitive)

• - Removedundici-types@6.20.0(transitive)