azurlane - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

dist/package.json

 {
     "name": "azurlane",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "description": "Api wrapper for the azur lane api",
     "main": "dist/lib/index.js",
     "types": "dist/lib/*.d.js",
-    "homepage": "https://kurozeropb.github.io/AzurLane/docs/index.html",
+    "homepage": "https://kurozeropb.github.io/AzurLane/index.html",
     "repository": {
@@ -12,2 +12,3 @@ "type": "git",
     },
+    "keywords": ["azurlane", "azur", "lane", "api", "azur-lane", "shipgirls", "waifu"],
     "bugs": {
@@ -31,3 +32,3 @@ "email": "[e-mail]",
         "pretest": "yarn build",
-        "docs": "typedoc --out ./docs ./lib --readme ./README.md",
+        "docs": "typedoc && cp .nojekyll docs/",
         "check": "gts check",
@@ -46,4 +47,5 @@ "clean": "gts clean",
         "typedoc": "^0.14.2",
+        "typedoc-plugin-markdown": "^1.1.27",
         "typescript": "^3.4.1"
     }
 }

docs/assets/js/search.js

 var typedoc = typedoc || {};
             typedoc.search = typedoc.search || {};
-            typedoc.search.data = {"kinds":{"1":"External module","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":1,"name":"\"lib/base\"","url":"modules/_lib_base_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"IBaseResponse","url":"interfaces/_lib_base_.ibaseresponse.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/base\""},{"id":2,"kind":1024,"name":"statusCode","url":"interfaces/_lib_base_.ibaseresponse.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/base\".IBaseResponse"},{"id":3,"kind":1024,"name":"statusMessage","url":"interfaces/_lib_base_.ibaseresponse.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/base\".IBaseResponse"},{"id":4,"kind":1024,"name":"message","url":"interfaces/_lib_base_.ibaseresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/base\".IBaseResponse"},{"id":5,"kind":256,"name":"IErrorResponse","url":"interfaces/_lib_base_.ierrorresponse.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/base\""},{"id":6,"kind":1024,"name":"error","url":"interfaces/_lib_base_.ierrorresponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/base\".IErrorResponse"},{"id":7,"kind":1024,"name":"statusCode","url":"interfaces/_lib_base_.ierrorresponse.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/base\".IErrorResponse"},{"id":8,"kind":1024,"name":"statusMessage","url":"interfaces/_lib_base_.ierrorresponse.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/base\".IErrorResponse"},{"id":9,"kind":1024,"name":"message","url":"interfaces/_lib_base_.ierrorresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/base\".IErrorResponse"},{"id":10,"kind":128,"name":"ApiError","url":"classes/_lib_base_.apierror.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"lib/base\""},{"id":11,"kind":1024,"name":"statusCode","url":"classes/_lib_base_.apierror.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"lib/base\".ApiError"},{"id":12,"kind":1024,"name":"statusMessage","url":"classes/_lib_base_.apierror.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"lib/base\".ApiError"},{"id":13,"kind":1024,"name":"message","url":"classes/_lib_base_.apierror.html#message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite","parent":"\"lib/base\".ApiError"},{"id":14,"kind":1024,"name":"error","url":"classes/_lib_base_.apierror.html#error","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"lib/base\".ApiError"},{"id":15,"kind":512,"name":"constructor","url":"classes/_lib_base_.apierror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"lib/base\".ApiError"},{"id":16,"kind":1024,"name":"name","url":"classes/_lib_base_.apierror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"lib/base\".ApiError"},{"id":17,"kind":1024,"name":"stack","url":"classes/_lib_base_.apierror.html#stack","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"\"lib/base\".ApiError"},{"id":18,"kind":1024,"name":"Error","url":"classes/_lib_base_.apierror.html#error-1","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"\"lib/base\".ApiError"},{"id":19,"kind":1,"name":"\"lib/build\"","url":"modules/_lib_build_.html","classes":"tsd-kind-external-module"},{"id":20,"kind":256,"name":"IConstruction","url":"interfaces/_lib_build_.iconstruction.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/build\""},{"id":21,"kind":1024,"name":"time","url":"interfaces/_lib_build_.iconstruction.html#time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/build\".IConstruction"},{"id":22,"kind":1024,"name":"ships","url":"interfaces/_lib_build_.iconstruction.html#ships","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/build\".IConstruction"},{"id":23,"kind":256,"name":"IBuildResponse","url":"interfaces/_lib_build_.ibuildresponse.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/build\""},{"id":24,"kind":1024,"name":"construction","url":"interfaces/_lib_build_.ibuildresponse.html#construction","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/build\".IBuildResponse"},{"id":25,"kind":1024,"name":"statusCode","url":"interfaces/_lib_build_.ibuildresponse.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/build\".IBuildResponse"},{"id":26,"kind":1024,"name":"statusMessage","url":"interfaces/_lib_build_.ibuildresponse.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/build\".IBuildResponse"},{"id":27,"kind":1024,"name":"message","url":"interfaces/_lib_build_.ibuildresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/build\".IBuildResponse"},{"id":28,"kind":1,"name":"\"lib/ship\"","url":"modules/_lib_ship_.html","classes":"tsd-kind-external-module"},{"id":29,"kind":256,"name":"INames","url":"interfaces/_lib_ship_.inames.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/ship\""},{"id":30,"kind":1024,"name":"full","url":"interfaces/_lib_ship_.inames.html#full","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".INames"},{"id":31,"kind":1024,"name":"en","url":"interfaces/_lib_ship_.inames.html#en","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".INames"},{"id":32,"kind":1024,"name":"cn","url":"interfaces/_lib_ship_.inames.html#cn","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".INames"},{"id":33,"kind":1024,"name":"jp","url":"interfaces/_lib_ship_.inames.html#jp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".INames"},{"id":34,"kind":256,"name":"ISkins","url":"interfaces/_lib_ship_.iskins.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/ship\""},{"id":35,"kind":1024,"name":"title","url":"interfaces/_lib_ship_.iskins.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".ISkins"},{"id":36,"kind":1024,"name":"image","url":"interfaces/_lib_ship_.iskins.html#image","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".ISkins"},{"id":37,"kind":256,"name":"IStars","url":"interfaces/_lib_ship_.istars.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/ship\""},{"id":38,"kind":1024,"name":"value","url":"interfaces/_lib_ship_.istars.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IStars"},{"id":39,"kind":1024,"name":"count","url":"interfaces/_lib_ship_.istars.html#count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IStars"},{"id":40,"kind":256,"name":"IShip","url":"interfaces/_lib_ship_.iship.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/ship\""},{"id":41,"kind":1024,"name":"id","url":"interfaces/_lib_ship_.iship.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":42,"kind":1024,"name":"names","url":"interfaces/_lib_ship_.iship.html#names","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":43,"kind":1024,"name":"thumbnail","url":"interfaces/_lib_ship_.iship.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":44,"kind":1024,"name":"skins","url":"interfaces/_lib_ship_.iship.html#skins","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":45,"kind":1024,"name":"buildTime","url":"interfaces/_lib_ship_.iship.html#buildtime","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":46,"kind":1024,"name":"rarity","url":"interfaces/_lib_ship_.iship.html#rarity","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":47,"kind":1024,"name":"stars","url":"interfaces/_lib_ship_.iship.html#stars","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":48,"kind":1024,"name":"class","url":"interfaces/_lib_ship_.iship.html#class","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":49,"kind":1024,"name":"nationality","url":"interfaces/_lib_ship_.iship.html#nationality","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":50,"kind":1024,"name":"hullType","url":"interfaces/_lib_ship_.iship.html#hulltype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShip"},{"id":51,"kind":256,"name":"IShipResponse","url":"interfaces/_lib_ship_.ishipresponse.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/ship\""},{"id":52,"kind":1024,"name":"ship","url":"interfaces/_lib_ship_.ishipresponse.html#ship","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/ship\".IShipResponse"},{"id":53,"kind":1024,"name":"statusCode","url":"interfaces/_lib_ship_.ishipresponse.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/ship\".IShipResponse"},{"id":54,"kind":1024,"name":"statusMessage","url":"interfaces/_lib_ship_.ishipresponse.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/ship\".IShipResponse"},{"id":55,"kind":1024,"name":"message","url":"interfaces/_lib_ship_.ishipresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"lib/ship\".IShipResponse"},{"id":56,"kind":1,"name":"\"lib/index\"","url":"modules/_lib_index_.html","classes":"tsd-kind-external-module"},{"id":57,"kind":256,"name":"IOptions","url":"interfaces/_lib_index_.ioptions.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"lib/index\""},{"id":58,"kind":1024,"name":"userAgent","url":"interfaces/_lib_index_.ioptions.html#useragent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"lib/index\".IOptions"},{"id":59,"kind":128,"name":"AzurLane","url":"classes/_lib_index_.azurlane.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"lib/index\""},{"id":60,"kind":1024,"name":"baseUrl","url":"classes/_lib_index_.azurlane.html#baseurl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"\"lib/index\".AzurLane"},{"id":61,"kind":1024,"name":"options","url":"classes/_lib_index_.azurlane.html#options","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"lib/index\".AzurLane"},{"id":62,"kind":512,"name":"constructor","url":"classes/_lib_index_.azurlane.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"lib/index\".AzurLane"},{"id":63,"kind":2048,"name":"ship","url":"classes/_lib_index_.azurlane.html#ship","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"lib/index\".AzurLane"},{"id":64,"kind":2048,"name":"buildInfo","url":"classes/_lib_index_.azurlane.html#buildinfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"lib/index\".AzurLane"}]};
+            typedoc.search.data = {"kinds":{"128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":256,"name":"IBaseResponse","url":"interfaces/ibaseresponse.html","classes":"tsd-kind-interface"},{"id":1,"kind":1024,"name":"statusCode","url":"interfaces/ibaseresponse.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IBaseResponse"},{"id":2,"kind":1024,"name":"statusMessage","url":"interfaces/ibaseresponse.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IBaseResponse"},{"id":3,"kind":1024,"name":"message","url":"interfaces/ibaseresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IBaseResponse"},{"id":4,"kind":256,"name":"IErrorResponse","url":"interfaces/ierrorresponse.html","classes":"tsd-kind-interface"},{"id":5,"kind":1024,"name":"error","url":"interfaces/ierrorresponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IErrorResponse"},{"id":6,"kind":1024,"name":"statusCode","url":"interfaces/ierrorresponse.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IErrorResponse"},{"id":7,"kind":1024,"name":"statusMessage","url":"interfaces/ierrorresponse.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IErrorResponse"},{"id":8,"kind":1024,"name":"message","url":"interfaces/ierrorresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IErrorResponse"},{"id":9,"kind":128,"name":"ApiError","url":"classes/apierror.html","classes":"tsd-kind-class"},{"id":10,"kind":1024,"name":"statusCode","url":"classes/apierror.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ApiError"},{"id":11,"kind":1024,"name":"statusMessage","url":"classes/apierror.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ApiError"},{"id":12,"kind":1024,"name":"message","url":"classes/apierror.html#message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite","parent":"ApiError"},{"id":13,"kind":1024,"name":"error","url":"classes/apierror.html#error","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ApiError"},{"id":14,"kind":512,"name":"constructor","url":"classes/apierror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ApiError"},{"id":15,"kind":1024,"name":"name","url":"classes/apierror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"ApiError"},{"id":16,"kind":1024,"name":"stack","url":"classes/apierror.html#stack","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"ApiError"},{"id":17,"kind":1024,"name":"Error","url":"classes/apierror.html#error-1","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"ApiError"},{"id":18,"kind":256,"name":"IConstruction","url":"interfaces/iconstruction.html","classes":"tsd-kind-interface"},{"id":19,"kind":1024,"name":"time","url":"interfaces/iconstruction.html#time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IConstruction"},{"id":20,"kind":1024,"name":"ships","url":"interfaces/iconstruction.html#ships","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IConstruction"},{"id":21,"kind":256,"name":"IBuildResponse","url":"interfaces/ibuildresponse.html","classes":"tsd-kind-interface"},{"id":22,"kind":1024,"name":"construction","url":"interfaces/ibuildresponse.html#construction","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IBuildResponse"},{"id":23,"kind":1024,"name":"statusCode","url":"interfaces/ibuildresponse.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IBuildResponse"},{"id":24,"kind":1024,"name":"statusMessage","url":"interfaces/ibuildresponse.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IBuildResponse"},{"id":25,"kind":1024,"name":"message","url":"interfaces/ibuildresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IBuildResponse"},{"id":26,"kind":256,"name":"INames","url":"interfaces/inames.html","classes":"tsd-kind-interface"},{"id":27,"kind":1024,"name":"full","url":"interfaces/inames.html#full","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"INames"},{"id":28,"kind":1024,"name":"en","url":"interfaces/inames.html#en","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"INames"},{"id":29,"kind":1024,"name":"cn","url":"interfaces/inames.html#cn","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"INames"},{"id":30,"kind":1024,"name":"jp","url":"interfaces/inames.html#jp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"INames"},{"id":31,"kind":256,"name":"ISkins","url":"interfaces/iskins.html","classes":"tsd-kind-interface"},{"id":32,"kind":1024,"name":"title","url":"interfaces/iskins.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ISkins"},{"id":33,"kind":1024,"name":"image","url":"interfaces/iskins.html#image","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ISkins"},{"id":34,"kind":256,"name":"IStars","url":"interfaces/istars.html","classes":"tsd-kind-interface"},{"id":35,"kind":1024,"name":"value","url":"interfaces/istars.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IStars"},{"id":36,"kind":1024,"name":"count","url":"interfaces/istars.html#count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IStars"},{"id":37,"kind":256,"name":"IShip","url":"interfaces/iship.html","classes":"tsd-kind-interface"},{"id":38,"kind":1024,"name":"id","url":"interfaces/iship.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":39,"kind":1024,"name":"names","url":"interfaces/iship.html#names","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":40,"kind":1024,"name":"thumbnail","url":"interfaces/iship.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":41,"kind":1024,"name":"skins","url":"interfaces/iship.html#skins","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":42,"kind":1024,"name":"buildTime","url":"interfaces/iship.html#buildtime","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":43,"kind":1024,"name":"rarity","url":"interfaces/iship.html#rarity","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":44,"kind":1024,"name":"stars","url":"interfaces/iship.html#stars","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":45,"kind":1024,"name":"class","url":"interfaces/iship.html#class","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":46,"kind":1024,"name":"nationality","url":"interfaces/iship.html#nationality","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":47,"kind":1024,"name":"hullType","url":"interfaces/iship.html#hulltype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShip"},{"id":48,"kind":256,"name":"IShipResponse","url":"interfaces/ishipresponse.html","classes":"tsd-kind-interface"},{"id":49,"kind":1024,"name":"ship","url":"interfaces/ishipresponse.html#ship","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IShipResponse"},{"id":50,"kind":1024,"name":"statusCode","url":"interfaces/ishipresponse.html#statuscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IShipResponse"},{"id":51,"kind":1024,"name":"statusMessage","url":"interfaces/ishipresponse.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IShipResponse"},{"id":52,"kind":1024,"name":"message","url":"interfaces/ishipresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"IShipResponse"},{"id":53,"kind":256,"name":"IOptions","url":"interfaces/ioptions.html","classes":"tsd-kind-interface"},{"id":54,"kind":1024,"name":"userAgent","url":"interfaces/ioptions.html#useragent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"IOptions"},{"id":55,"kind":128,"name":"AzurLane","url":"classes/azurlane.html","classes":"tsd-kind-class"},{"id":56,"kind":1024,"name":"options","url":"classes/azurlane.html#options","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AzurLane"},{"id":57,"kind":512,"name":"constructor","url":"classes/azurlane.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"AzurLane"},{"id":58,"kind":2048,"name":"ship","url":"classes/azurlane.html#ship","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AzurLane"},{"id":59,"kind":2048,"name":"buildInfo","url":"classes/azurlane.html#buildinfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AzurLane"}]};

package.json

 {
   "name": "azurlane",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Api wrapper for the azur lane api",
   "main": "dist/lib/index.js",
   "types": "dist/lib/*.d.js",
-  "homepage": "https://kurozeropb.github.io/AzurLane/docs/index.html",
+  "homepage": "https://kurozeropb.github.io/AzurLane/index.html",
   "repository": {
@@ -12,2 +12,3 @@ "type": "git",
   },
+  "keywords": ["azurlane", "azur", "lane", "api", "azur-lane", "shipgirls", "waifu"],
   "bugs": {
@@ -31,3 +32,3 @@ "email": "[e-mail]",
     "pretest": "yarn build",
-    "docs": "typedoc --out ./docs ./lib --readme ./README.md",
+    "docs": "typedoc && cp .nojekyll docs/",
     "check": "gts check",
@@ -46,4 +47,5 @@ "clean": "gts clean",
     "typedoc": "^0.14.2",
+    "typedoc-plugin-markdown": "^1.1.27",
     "typescript": "^3.4.1"
   }
 }

README.md

@@ -7,50 +7,69 @@ # AzurLane
 const AzurLane = require("azurlane");
-const al = new AzurLane();
+const azurlane = new AzurLane();
 
 async function main() {
-    const data = await al.ship("Akagi");
-    console.log(data);
-    /* example response
-    {   
-        id: '224',
-        names: {
-            full: 'IJN Akagi (cn: 凰; jp: 赤城)',
-            en: 'IJN Akagi',
-            cn: '凰',
-            jp: '赤城'
+    const ship = await azurlane.ship("Akagi");
+    console.log(`${ship.names.en}'s rarity is ${ship.rarity}`); // IJN Akagi's rarity is Super Rare
+
+    const build = await azurlane.buildInfo("00:24:00");
+    console.log(`Ships matching time ${build.time}: ${build.ships.join(", ")}`); // Ships matching time 00:24:00: Foxhound, Fortune, Dace, Albacore
+}
+
+// Also catches any api errors that might occur like 400, 429, 500 http errors
+// Api errors extend the default error class, have a look at https://kurozeropb.github.io/AzurLane/classes/apierror.html for information
+main().catch(console.error);
+```
+
+## Ship Data
+```json
+{   
+    "id": "224",
+    "names": {
+        "full": "IJN Akagi (cn: 凰; jp: 赤城)",
+        "en": "IJN Akagi",
+        "cn": "凰",
+        "jp": "赤城"
+    },
+    "thumbnail": "https://azurlane.koumakan.jp/w/images/3/3f/AkagiIcon.png",
+    "skins": [
+        { 
+            "title": "Default",
+            "image": "https://azurlane.koumakan.jp/w/images/thumb/0/06/Akagi.png/600px-Akagi.png"
         },
-        thumbnail: 'https://azurlane.koumakan.jp/w/images/3/3f/AkagiIcon.png',
-        skins:
-        [
-            { 
-                title: 'Default',
-                image: 'https://azurlane.koumakan.jp/w/images/thumb/0/06/Akagi.png/600px-Akagi.png'
-            },
-            {
-                title: 'Paradise Amaryllis',
-                image: 'https://azurlane.koumakan.jp/w/images/thumb/3/39/AkagiSummer.png/600px-AkagiSummer.png'
-            },
-            {
-                title: 'Plum and Snow',
-                image: 'https://azurlane.koumakan.jp/w/images/thumb/d/d0/AkagiNew_Year.png/533px-AkagiNew_Year.png'
-            },
-            {
-                title: 'Deep Crimson Poppy',
-                image: 'https://azurlane.koumakan.jp/w/images/thumb/6/65/AkagiPledge.png/505px-AkagiPledge.png'
-            } 
-        ],
-        buildTime: 'Drop Only',
-        rarity: 'Super Rare',
-        stars: {
-            value: '★★★☆☆☆',
-            count: 3
+        {
+            "title": "Paradise Amaryllis",
+            "image": "https://azurlane.koumakan.jp/w/images/thumb/3/39/AkagiSummer.png/600px-AkagiSummer.png"
         },
-        class: 'Akagi',
-        nationality: 'Sakura Empire',
-        hullType: 'Aircraft Carrier'
-    }
-   */
+        {
+            "title": "Plum and Snow",
+            "image": "https://azurlane.koumakan.jp/w/images/thumb/d/d0/AkagiNew_Year.png/533px-AkagiNew_Year.png"
+        },
+        {
+            "title": "Deep Crimson Poppy",
+            "image": "https://azurlane.koumakan.jp/w/images/thumb/6/65/AkagiPledge.png/505px-AkagiPledge.png"
+        } 
+    ],
+    "buildTime": "Drop Only",
+    "rarity": "Super Rare",
+    "stars": {
+        "value": "★★★☆☆☆",
+        "count": 3
+    },
+    "class": "Akagi",
+    "nationality": "Sakura Empire",
+    "hullType": "Aircraft Carrier"
 }
+```
 
-main().catch(console.error);
+## Build Time Data
+```json
+{
+    "time": "00:24:00",
+    "ships": [
+        "Foxhound",
+        "Fortune",
+        "Dace",
+        "Albacore"
+    ]
+}
 ```

test/test.js

 const assert = require("assert");
 const AzurLane = require("../dist/lib/index");
 
-const Akagi = {   
-    id: "224",
-    names: {
-        full: "IJN Akagi (cn: 凰; jp: 赤城)",
-        en: "IJN Akagi",
-        cn: "凰",
-        jp: "赤城"
-    },
-    thumbnail: "https://azurlane.koumakan.jp/w/images/3/3f/AkagiIcon.png",
-    skins:
-    [
-        { 
-            title: "Default",
-            image: "https://azurlane.koumakan.jp/w/images/thumb/0/06/Akagi.png/600px-Akagi.png"
-        },
-        {
-            title: "Paradise Amaryllis",
-            image: "https://azurlane.koumakan.jp/w/images/thumb/3/39/AkagiSummer.png/600px-AkagiSummer.png"
-        },
-        {
-            title: "Plum and Snow",
-            image: "https://azurlane.koumakan.jp/w/images/thumb/d/d0/AkagiNew_Year.png/533px-AkagiNew_Year.png"
-        },
-        {
-            title: "Deep Crimson Poppy",
-            image: "https://azurlane.koumakan.jp/w/images/thumb/6/65/AkagiPledge.png/505px-AkagiPledge.png"
-        } 
-    ],
-    buildTime: "Drop Only",
-    rarity: "Super Rare",
-    stars: {
-        value: "★★★☆☆☆",
-        count: 3
-    },
-    class: "Akagi",
-    nationality: "Sakura Empire",
-    hullType: "Aircraft Carrier"
-};
-
-const BuiltTest = {
-    time: "00:24:00",
-    ships: [
-        "Foxhound",
-        "Fortune",
-        "Dace",
-        "Albacore"
-    ]
-};
-
 describe("AzurLane", function() {
@@ -57,5 +8,5 @@ const azurlane = new AzurLane();
     describe("#ship()", function() {
-        it("should be equal to Akagi", async function() {
+        it("should resolve to an object", async function() {
             const data = await azurlane.ship("Akagi");
-            assert.deepEqual(data, Akagi);
+            assert.strictEqual(typeof data, "object", "ship did not resolved to an object");
         });
@@ -65,7 +16,7 @@ });
     describe("#buildInfo()", function() {
-        it("should be equal to BuiltTest", async function() {
+        it("should resolve to an object", async function() {
             const data = await azurlane.buildInfo("00:24:00");
-            assert.deepEqual(data, BuiltTest);
+            assert.strictEqual(typeof data, "object", "buildInfo did not resolved to an object");
         });
     });
 });

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

No website

Quality

Package does not have a website.

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

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

74

increased by34.55%

Number of medium supply chain risk alerts

3

decreased by-25%

Worsened metrics

Total package byte prevSize

505443

decreased by-9.09%

Dev dependency count

7

increased by16.67%

Number of package files

46

decreased by-6.12%

Lines of code

1574

decreased by-1.93%

No dependency changes