Updated Typings for Entry Properties Using Dates Instead of FuzzyDates

AurelicButter · Feb 7, 2024 · 63d5aa7 · 63d5aa7
1 parent ec0e64e
commit 63d5aa7
Show file tree

Hide file tree

Showing 47 changed files with 342 additions and 296 deletions.
diff --git a/docs/AniList.Activity.html b/docs/AniList.Activity.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>

diff --git a/docs/AniList.Lists.html b/docs/AniList.Lists.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>

diff --git a/docs/AniList.Media.html b/docs/AniList.Media.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>

diff --git a/docs/AniList.People.html b/docs/AniList.People.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>

diff --git a/docs/AniList.Recommendation.html b/docs/AniList.Recommendation.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>

diff --git a/docs/AniList.Search.html b/docs/AniList.Search.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>
@@ -965,7 +966,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 
 								<td class="default"></td>
 
-								<td class="description last">Required. The term to lookup. (ie: "Butterstroke")</td>
+								<td class="description last">Required. The term to lookup. (ie: "AurelicButter")</td>
 							</tr>
 
 							<tr>

diff --git a/docs/AniList.Thread.html b/docs/AniList.Thread.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>

diff --git a/docs/AniList.User.html b/docs/AniList.User.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>

diff --git a/docs/AniList.html b/docs/AniList.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>
@@ -804,7 +805,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 								<td class="default"></td>
 
 								<td class="description last">
-									Required. The term to lookup. (ie: "Honzuki no Gekokujou" or "Butterstroke")
+									Required. The term to lookup. (ie: "Honzuki no Gekokujou" or "AurelicButter")
 								</td>
 							</tr>
 

diff --git a/docs/activity.js.html b/docs/activity.js.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>

diff --git a/docs/docDefinition.js.html b/docs/docDefinition.js.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
@@ -37,7 +37,7 @@
 			<h2><a href="index.html">Home</a></h2>
 			<h2>
 				<a
-					href="https://github.com/Butterstroke/AniList-Node"
+					href="https://github.com/AurelicButter/AniList-Node"
 					target="_blank"
 					class="menu-item"
 					id="website_link"
@@ -168,6 +168,7 @@ <h3>Global</h3>
 				<li><a href="global.html#CountryCode">CountryCode</a></li>
 				<li><a href="global.html#EntryStatus">EntryStatus</a></li>
 				<li><a href="global.html#FuzzyDateInt">FuzzyDateInt</a></li>
+				<li><a href="global.html#FuzzyDateObj">FuzzyDateObj</a></li>
 				<li><a href="global.html#InitOptions">InitOptions</a></li>
 				<li><a href="global.html#ListActivity">ListActivity</a></li>
 				<li><a href="global.html#ListEntry">ListEntry</a></li>
@@ -400,7 +401,7 @@ <h1 class="page-title">docDefinition.js</h1>
  * @property { String } coverImage.color - Average hex colour of the cover image
  * @property { String } description - The medias description
  * @property { Number } duration - General length of an episode
- * @property { Date } endDate - Official end date of the media
+ * @property { FuzzyDateObj } endDate - Official end date of the media
  * @property { Number } episodes - Number of episodes
  * @property { String[] } externalLinks - A list of external links associated with the media
  * @property { Number } favourites - Number of users who have favourited it.
@@ -439,7 +440,7 @@ <h1 class="page-title">docDefinition.js</h1>
  * @property { String } siteUrl - The media's AniList page
  * @property { String } source - Source type that the media was adapted from
  * @property { PersonRelation[] } staff - An array of credited staff
- * @property { Date } startDate - Official release date of the media
+ * @property { FuzzyDateObj } startDate - Official release date of the media
  * @property { Object } stats - Statistics on the media
  * @property { Object[] } stats.scoreDistribution - An array of how the users have rated the media. Each object contains a score and amount.
  * @property { Object[] } stats.statusDistribution - An array of the users status with the show. Each object contains a status and amount.
@@ -484,7 +485,7 @@ <h1 class="page-title">docDefinition.js</h1>
  * @property { String } coverImage.small - The small sized cover image
  * @property { String } coverImage.color - Average hex colour of the cover image
  * @property { String } description - The manga's description
- * @property { Date } endDate - Official end date of the media
+ * @property { FuzzyDateObj } endDate - Official end date of the media
  * @property { String[] } externalLinks - A list of external links associated with the media
  * @property { Number } favourites - Number of users who have favourited it.
  * @property { String } format - The format of the manga. (ie: Manga, Novel, etc...)
@@ -517,7 +518,7 @@ <h1 class="page-title">docDefinition.js</h1>
  * @property { String } reviews.body - The review content.
  * @property { String } siteUrl - The media's AniList page
  * @property { PersonRelation[] } staff - An array of credited staff
- * @property { Date } startDate - Official release date of the media
+ * @property { FuzzyDateObj } startDate - Official release date of the media
  * @property { Object } stats - Statistics on the media
  * @property { Object[] } stats.scoreDistribution - An array of how the users have rated the media. Each object contains a score and amount.
  * @property { Object[] } stats.statusDistribution - An array of the users status with the show. Each object contains a status and amount.
@@ -733,14 +734,8 @@ <h1 class="page-title">docDefinition.js</h1>
  * @property { Object[] } media.tags - Tags relating to the media
  * @property { String } media.tags.name - The name of the tag
  * @property { Boolean } media.tags.isMediaSpoiler - Checks if the tag is a spoiler or not.
- * @property {Object} media.startDate  - Starting date
- * @property {Number} media.startDate.year
- * @property {Number} media.startDate.month
- * @property {Number} media.startDate.day
- * @property {Object} media.endDate  - The official end date
- * @property {Number} media.endDate.year
- * @property {Number} media.endDate.month
- * @property {Number} media.endDate.day
+ * @property { FuzzyDateObj } media.startDate  - Starting date
+ * @property { FuzzyDateObj } media.endDate  - The official end date
  * @property { String[] } media.genres - The genres of the media
  * @property { Boolean } media.isFavourite - [Requires Login] Checks if the media is on the user's favourites list
  * @property { Boolean } media.isAdult - Checks if the media is for adult audiences (ie: Hentai)
@@ -835,6 +830,14 @@ <h1 class="page-title">docDefinition.js</h1>
  * @description 8 digit integer (YYYYMMDD). Unknown dates are represented by 0.
  */
 
+/**
+ * @typedef {Object} FuzzyDateObj
+ * @description An object that contains the year, month, and date of an item.
+ * @property { Number | null } year
+ * @property { Number | null } month
+ * @property { Number | null } day 
+ */
+
 /**
  * @typedef {Number} CountryCode
  * @description ISO 3166-1 alpha-2 country code
@@ -1144,31 +1147,31 @@ <h1 class="page-title">docDefinition.js</h1>
 /**
  * @typedef AniListStats
  * @property {Object[]} users - User count over the past seven days
- * @property {Date} users.date - Date recorded
+ * @property {Number} users.date - The date recorded as a timestamp
  * @property {Number} users.count - Count on date
  * @property {Number} users.change - Change from yesterday
  * @property {Object[]} anime - Anime count over the past seven days
- * @property {Date} anime.date - Date recorded
+ * @property {Number} anime.date - The date recorded as a timestamp
  * @property {Number} anime.count - Count on date
  * @property {Number} anime.change - Change from yesterday
  * @property {Object[]} manga - Manga count over the past seven days
- * @property {Date} manga.date - Date recorded
+ * @property {Number} manga.date - The date recorded as a timestamp
  * @property {Number} manga.count - Count on date
  * @property {Number} manga.change - Change from yesterday
  * @property {Object[]} characters - Character entries over the past seven days
- * @property {Date} characters.date - Date recorded
+ * @property {Number} characters.date - The date recorded as a timestamp
  * @property {Number} characters.count - Count on date
  * @property {Number} characters.change - Change from yesterday
  * @property {Object[]} staff - Staff entries over the past seven days
- * @property {Date} staff.date - Date recorded
+ * @property {Number} staff.date - The date recorded as a timestamp
  * @property {Number} staff.count - Count on date
  * @property {Number} staff.change - Change from yesterday
  * @property {Object[]} studios - Studio count over the past seven days
- * @property {Date} studios.date - Date recorded
+ * @property {Number} studios.date - The date recorded as a timestamp
  * @property {Number} studios.count - Count on date
  * @property {Number} studios.change - Change from yesterday
  * @property {Object[]} reviews - Review count over the past seven days
- * @property {Date} reviews.date - Date recorded
+ * @property {Number} reviews.date -  The date recorded as a timestamp
  * @property {Number} reviews.count - Count on date
  * @property {Number} reviews.change - Change from yesterday
  */