MickSlash
/
F95API
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Format code with prettier 

This commit fixes the style issues introduced in 34b0575 according to the output
from prettier.

Details: https://deepsource.io/gh/MillenniumEarl/F95API/transform/e37e93a7-8f87-4b2f-8c2f-a6141abb7e72/
pull/45/head
deepsource-autofix[bot] 2020-11-02 15:30:49 +00:00 committed by GitHub
parent 34b05752a1
commit 3f1a8bdaef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -15,6 +15,7 @@ A simple usage example can be found in [app/example.js](https://github.com/Mille
**Attention**: Two-factor authentication is not supported **Attention**: Two-factor authentication is not supported
# Data scraping # Data scraping
Games/mods can be obtained by name or URL Games/mods can be obtained by name or URL
```javascript ```javascript
@ -25,7 +26,7 @@ let listOfFoundMods = await F95API.getGameData("your mod name", true);
let specificGame = await F95API.getGameDataFromURL("the URL of your game"); let specificGame = await F95API.getGameDataFromURL("the URL of your game");
``` ```
While user data (after authenticating) with While user data (after authenticating) with
```javascript ```javascript
let authResult = await F95API.login(username, password); let authResult = await F95API.login(username, password);
@ -34,7 +35,9 @@ let loggedUserData = await F95API.getUserData();
``` ```
# Classes # Classes
## Games and mods ## Games and mods
Information about games and mods is stored in a GameInfo object with the following fields: Information about games and mods is stored in a GameInfo object with the following fields:
``` ```
@ -58,6 +61,7 @@ changelog: Latest changelog available
The serialization in JSON format of this object is possible through `JSON.stringfy()` while the deserialization must happen through the static method `GameInfo.fromJSON()`. The serialization in JSON format of this object is possible through `JSON.stringfy()` while the deserialization must happen through the static method `GameInfo.fromJSON()`.
## User data ## User data
User data (after authentication) can be stored in a UserData object, consisting of the following fields: User data (after authentication) can be stored in a UserData object, consisting of the following fields:
``` ```
@ -67,6 +71,7 @@ watchedThreads: List of URLs of threads followed by the user
``` ```
## Login results ## Login results
The outcome of the authentication process is represented by the LoginResult object: The outcome of the authentication process is represented by the LoginResult object:
``` ```
@ -75,6 +80,7 @@ message: Possible error message (unrecognized user, wrong password ...) or authe
``` ```
# Logging # Logging
To log the behavior of the application [log4js](https://github.com/log4js-node/log4js-node) is used with a default level of "warn". This option can be changed with the `loggerLevel` property. To log the behavior of the application [log4js](https://github.com/log4js-node/log4js-node) is used with a default level of "warn". This option can be changed with the `loggerLevel` property.
# Guidelines for errors # Guidelines for errors