Skip to content

Commit

Permalink
Merge pull request #59 from Butterstroke/development
Browse files Browse the repository at this point in the history 
Release 1.13.1
  • Loading branch information
@AurelicButter
AurelicButter authored Dec 9, 2022
2 parents 1f8ff82 + 0259981 commit 1faa3a1
Show file tree
Hide file tree
Showing 6 changed files with 295 additions and 357 deletions.
11 changes: 8 additions & 3 deletions docs/docDefinition.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -673,8 +673,14 @@ <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 { Number } media.startDate - The official release date
* @property { Number } media.endDate - The official end date
* @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 { 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)
Expand Down Expand Up @@ -1074,7 +1080,6 @@ <h1 class="page-title">docDefinition.js</h1>
* @property {Number} completedAt.month
* @property {Number} completedAt.day
*/

</code></pre>
</article>
</section>
Expand Down
143 changes: 119 additions & 24 deletions docs/global.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2399,7 +2399,7 @@ <h4 class="name" id="ActivityFilterTypes">ActivityFilterTypes</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line642">line 642</a>
<a href="docDefinition.js.html#line648">line 648</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -3958,7 +3958,7 @@ <h4 class="name" id="CountryCode">CountryCode</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line564">line 564</a>
<a href="docDefinition.js.html#line570">line 570</a>
</li>
</ul>
</dd>
Expand All @@ -3981,7 +3981,7 @@ <h4 class="name" id="FuzzyDateInt">FuzzyDateInt</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line555">line 555</a>
<a href="docDefinition.js.html#line561">line 561</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -4061,7 +4061,7 @@ <h4 class="name" id="ListActivity">ListActivity</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line497">line 497</a>
<a href="docDefinition.js.html#line503">line 503</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -4424,20 +4424,114 @@ <h6>Properties</h6>
<td class="name"><code>startDate</code></td>

<td class="type">
<span class="param-type">Number</span>
<span class="param-type">Object</span>
</td>

<td class="description last">The official release date</td>
<td class="description last">
Starting date
<h6>Properties</h6>

<table class="props">
<thead>
<tr>
<th>Name</th>

<th>Type</th>

<th class="last">Description</th>
</tr>
</thead>

<tbody>
<tr>
<td class="name"><code>year</code></td>

<td class="type">
<span class="param-type">Number</span>
</td>

<td class="description last"></td>
</tr>

<tr>
<td class="name"><code>month</code></td>

<td class="type">
<span class="param-type">Number</span>
</td>

<td class="description last"></td>
</tr>

<tr>
<td class="name"><code>day</code></td>

<td class="type">
<span class="param-type">Number</span>
</td>

<td class="description last"></td>
</tr>
</tbody>
</table>
</td>
</tr>

<tr>
<td class="name"><code>endDate</code></td>

<td class="type">
<span class="param-type">Number</span>
<span class="param-type">Object</span>
</td>

<td class="description last">The official end date</td>
<td class="description last">
The official end date
<h6>Properties</h6>

<table class="props">
<thead>
<tr>
<th>Name</th>

<th>Type</th>

<th class="last">Description</th>
</tr>
</thead>

<tbody>
<tr>
<td class="name"><code>year</code></td>

<td class="type">
<span class="param-type">Number</span>
</td>

<td class="description last"></td>
</tr>

<tr>
<td class="name"><code>month</code></td>

<td class="type">
<span class="param-type">Number</span>
</td>

<td class="description last"></td>
</tr>

<tr>
<td class="name"><code>day</code></td>

<td class="type">
<span class="param-type">Number</span>
</td>

<td class="description last"></td>
</tr>
</tbody>
</table>
</td>
</tr>

<tr>
Expand Down Expand Up @@ -5561,7 +5655,7 @@ <h4 class="name" id="MediaFilterTypes">MediaFilterTypes</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line569">line 569</a>
<a href="docDefinition.js.html#line575">line 575</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -6306,7 +6400,7 @@ <h4 class="name" id="MediaListOptions">MediaListOptions</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line759">line 759</a>
<a href="docDefinition.js.html#line765">line 765</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -6390,7 +6484,7 @@ <h4 class="name" id="MediaListOptionsInput">MediaListOptionsInput</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line710">line 710</a>
<a href="docDefinition.js.html#line716">line 716</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -6553,7 +6647,7 @@ <h4 class="name" id="MediaTag">MediaTag</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line791">line 791</a>
<a href="docDefinition.js.html#line797">line 797</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -6710,7 +6804,7 @@ <h4 class="name" id="MessageActivity">MessageActivity</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line535">line 535</a>
<a href="docDefinition.js.html#line541">line 541</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -6920,7 +7014,7 @@ <h4 class="name" id="NotificationOption">NotificationOption</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line703">line 703</a>
<a href="docDefinition.js.html#line709">line 709</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -7098,7 +7192,7 @@ <h4 class="name" id="RecommendationEntry">RecommendationEntry</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line682">line 682</a>
<a href="docDefinition.js.html#line688">line 688</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -7186,7 +7280,7 @@ <h4 class="name" id="RecommendationList">RecommendationList</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line675">line 675</a>
<a href="docDefinition.js.html#line681">line 681</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -7436,7 +7530,7 @@ <h4 class="name" id="SingleRecommendation">SingleRecommendation</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line692">line 692</a>
<a href="docDefinition.js.html#line698">line 698</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -7869,7 +7963,7 @@ <h4 class="name" id="TextActivity">TextActivity</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line517">line 517</a>
<a href="docDefinition.js.html#line523">line 523</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -8050,13 +8144,14 @@ <h5>Type:</h5>
</ul>

<h4 class="name" id="ThreadComment">ThreadComment</h4>

<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line800">line 800</a>
<a href="docDefinition.js.html#line806">line 806</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -8180,7 +8275,7 @@ <h4 class="name" id="ThreadEntry">ThreadEntry</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line768">line 768</a>
<a href="docDefinition.js.html#line774">line 774</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -8427,7 +8522,7 @@ <h4 class="name" id="UpdatedEntry">UpdatedEntry</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line839">line 839</a>
<a href="docDefinition.js.html#line845">line 845</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -8792,7 +8887,7 @@ <h4 class="name" id="UpdateEntryOptions">UpdateEntryOptions</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line813">line 813</a>
<a href="docDefinition.js.html#line819">line 819</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -9179,7 +9274,7 @@ <h4 class="name" id="UserOptions">UserOptions</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line739">line 739</a>
<a href="docDefinition.js.html#line745">line 745</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -9434,7 +9529,7 @@ <h4 class="name" id="UserOptionsInput">UserOptionsInput</h4>
<ul class="dummy">
<li>
<a href="docDefinition.js.html">docDefinition.js</a>,
<a href="docDefinition.js.html#line721">line 721</a>
<a href="docDefinition.js.html#line727">line 727</a>
</li>
</ul>
</dd>
Expand Down
10 changes: 8 additions & 2 deletions lib/docDefinition.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -465,8 +465,14 @@
* @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 { Number } media.startDate - The official release date
* @property { Number } media.endDate - The official end date
* @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 { 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)
Expand Down
10 changes: 5 additions & 5 deletions lib/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ declare class Lists {
* @returns {UpdatedEntry}
* @since 1.13.0
*/
async addEntry(id: number, options: UpdateEntryOptions): UpdatedEntry;
addEntry(id: number, options: UpdateEntryOptions): Promise<UpdatedEntry>;

/**
* [Requires Login] Update a list entry to a user's list.
Expand All @@ -220,15 +220,15 @@ declare class Lists {
* @returns {UpdatedEntry}
* @since 1.13.0
*/
async updateEntry(id: number, options:UpdateEntryOptions): UpdatedEntry;
updateEntry(id: number, options:UpdateEntryOptions): Promise<UpdatedEntry>;

/**
* [Requires Login] Remove an entry from a user's lists.
* @param {Number} id - The AniList list ID of the entry to remove.
* @returns {Boolean} Returns true if removed, false otherwise.
* @since 1.13.0
*/
async removeEntry(id: number): Boolean;
removeEntry(id: number): Promise<Boolean>;
}


Expand Down Expand Up @@ -983,8 +983,8 @@ export declare interface ListEntry {
description: string,
format: string,
tags: Tags[],
startDate: number,
endDate: number,
startDate: FuzzyDate,
endDate: FuzzyDate,
genres: string[],
isFavourite: boolean,
isAdult: boolean,
Expand Down
Loading

0 comments on commit 1faa3a1

Please sign in to comment.