1.1.6: add key for disable or change userAgent

kravetsone · Nov 10, 2022 · fde6dd4 · fde6dd4
1 parent bc1d71f
commit fde6dd4
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -38,10 +38,11 @@ import { EnkaNetwork } from "enkanetwork"; //const { EnkaNetwork } = require("en
 const enka = new EnkaNetwork({ language: "EN", caching: true });
 ```
 
-| Key      | In API | Type    | Description                                                                                           | Required? |
-| -------- | ------ | ------- | ----------------------------------------------------------------------------------------------------- | --------- |
-| language | -      | number  | The language to be used in the localization of names (characters, artifacts, etc.). Default is «`EN`» | -         |
-| caching  | -      | boolean | Cache responses? Default is `true`                                                                    | -         |
+| Key       | In API | Type              | Description                                                                                           | Required? |
+| --------- | ------ | ----------------- | ----------------------------------------------------------------------------------------------------- | --------- |
+| language  | -      | number            | The language to be used in the localization of names (characters, artifacts, etc.). Default is «`EN`» | -         |
+| caching   | -      | boolean           | Cache responses? Default is `true`                                                                    | -         |
+| userAgent | -      | string or boolean | Disable or change the header `User-Agent`. (`false` for disable)                                      | -         |
 
 ## Fetch user by uid from the game (response is [FetchUserUID](#fetchuseruid))
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "enkanetwork",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "NodeJS/TypeScript api wrapper data from https://enka.network/",
   "main": "./dist/index.js",
   "module": "./dist/index.js",

diff --git a/src/index.ts b/src/index.ts
@@ -7,14 +7,23 @@ export class EnkaNetwork {
     language: TLanguage;
     private readonly request: Axios;
     private readonly cache?: NodeCache;
-    constructor(data: { language?: TLanguage; caching: boolean }) {
+    constructor(data: {
+        language?: TLanguage;
+        caching: boolean;
+        userAgent?: string | boolean;
+    }) {
         this.language = data.language || "EN";
         this.request = new Axios({
             baseURL: "https://enka.network",
             timeout: 10 * 1000,
             headers: {
                 Accept: "application/json",
-                "User-Agent": "enkaNetwork@1.1.5",
+                ...(data.userAgent !== false && {
+                    "User-Agent":
+                        typeof data.userAgent == "string"
+                            ? data.userAgent
+                            : "enkaNetwork@1.1.6",
+                }),
             },
         });
         this.cache =