acb-api - npm Package Compare versions

Comparing version 1.3.2 to 1.3.4

package.json

 {
   "name": "acb-api",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "description": "a api that uses the animecharacterdatabase and access information from there",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -19,2 +19,110 @@ # ACB Information Api
 }); // returns an array of anime with that name
+```
+
+## Returns
+
+```json
+get_character_by_id returns:
+{
+  "id": 55,
+  "anime_id": 6,
+  "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/5688-1445174767.jpg",
+  "character_image": "http://ami.animecharactersdatabase.com/uploads/chars/thumbs/200/1-235056510.jpg",
+  "origin": "Clannad",
+  "gender": "Female",
+  "name": "Kotomi Ichinose",
+  "desc": "Kotomi Ichinose is a character from the visual novel Clannad."
+}
+
+get_character_by_search returns:
+{
+  [
+    {
+      "anime_id": 101471,
+      "anime_name": "Yurikago yori Tenshi made",
+      "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/4758-1426381234.jpg",
+      "character_image": "http://ami.animecharactersdatabase.com/uploads/chars/thumbs/200/4758-975182425.jpg",
+
+      "id": 33217,
+      "gender": "Male",
+      "name": "Hiro Kiritooshi",
+      "desc": "Hiro Kiritooshi is a character from the eroge Yurikago yori Tenshi made."
+    },
+    {
+      "anime_id": 477,
+      "anime_name": "Nukenin ~ Hokaku, Soshite Choukyou e ~",
+      "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/5688-539624452.jpg",
+      "character_image": "http://ami.animecharactersdatabase.com/./images/nukeninhokaku/Kirito_thumb.jpg",
+
+      "id": 3286,
+      "gender": "Male",
+      "name": "Kirito",
+      "desc": "Kirito is a character from the eroge Nukenin ~ Hokaku, Soshite Choukyou e ~."
+    },
+    {
+      "anime_id": 102399,
+      "anime_name": "Sword Art Online",
+      "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/6186-1304975494.jpg",
+      "character_image": "http://ami.animecharactersdatabase.com/uploads/chars/thumbs/200/6186-2121647960.jpg",
+
+      "id": 45455,
+      "gender": "Male",
+      "name": "Kirito",
+      "desc": "Kirito is a character from the anime Sword Art Online."
+    },...
+  ]
+}
+
+get_anime_by_id returns:
+{
+  "anime_name": "Kamitama",
+  "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/5688-2111247850.jpg",
+  "anime_id": "2220",
+  "characters": [
+    {
+      "id": 19498,
+      "character_image": "http://ami.animecharactersdatabase.com/./images/2220/Cyamu_thumb.jpg",
+      "gender": "Female",
+      "name": "Cyamu",
+      "desc": "Cyamu is a character from the eroge Kamitama."
+    },
+    {
+      "id": 19499,
+      "character_image": "http://ami.animecharactersdatabase.com/./images/2220/Setsuna_thumb.jpg",
+      "gender": "Female",
+      "name": "Setsuna",
+      "desc": "Setsuna is a character from the eroge Kamitama."
+    }
+  ]
+}
+
+get_anime_by_search returns:
+{
+  [
+    {
+      "characters_url": "https://www.animecharactersdatabase.com/api_series_characters.php?anime_id=102399",
+      "anime_id": 102399,
+      "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/6186-1304975494.jpg",
+      "anime_name": "Sword Art Online"
+    },
+    {
+      "characters_url": "https://www.animecharactersdatabase.com/api_series_characters.php?anime_id=104917",
+      "anime_id": 104917,
+      "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/5688-822941656.png",
+      "anime_name": "Sword Art Online (Series)"
+    },
+    {
+      "characters_url": "https://www.animecharactersdatabase.com/api_series_characters.php?anime_id=104106",
+      "anime_id": 104106,
+      "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/5688-86245494.jpg",
+      "anime_name": "Sword Art Online 2"
+    },
+    {
+      "characters_url": "https://www.animecharactersdatabase.com/api_series_characters.php?anime_id=105821",
+      "anime_id": 105821,
+      "anime_image": "http://ami.animecharactersdatabase.com/productimages/u/29946-1282047024.jpg",
+      "anime_name": "Sword Art Online Alternative: Gun Gale Online"
+    },...
+  ]
+}
 ```

test.js

@@ -8,3 +8,3 @@ const a = require('./index');
 });
-a.get_anime_by_id(10002).then(res => {
+a.get_anime_by_id(2220).then(res => {
   console.log(res);
@@ -11,0 +11,0 @@ });

No alert changes

Improved metrics

Total package byte prevSize

6701

increased by135.45%

Number of lines in readme file

127

increased by568.42%

No dependency changes