Skip to content

Commit

Permalink
Merge pull request #66 from Butterstroke/development
Browse files Browse the repository at this point in the history 
Release 1.13.2
  • Loading branch information
@AurelicButter
AurelicButter authored Mar 31, 2023
2 parents 1faa3a1 + 17de619 commit d012c84
Show file tree
Hide file tree
Showing 55 changed files with 1,842 additions and 931 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Anilist.media.anime(21708).then(data => {
});
```

For a more in-depth guide on getting started, check out our [Getting Started](https://katsurin.com/docs/anilist-node/tutorial-Getting%20Started.html) guide on our site or on the static HTML site under the docs directory.

## Documentation
Documentation is provided in two locations. A static HTML site is avalible with the package under the docs directory. Or users can view the same site online here: [katsurin.com/docs/anilist-node](https://www.katsurin.com/docs/anilist-node/index.html).

Expand Down
92 changes: 60 additions & 32 deletions docs/AniList.Activity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

<meta name="description" content="Documentation for the AniList-Node NPM package." />

<meta property="og:title" content="AniList-Node Documentation" />
<meta property="og:type" content="website" />
<meta property="og:image" content="" />
<meta property="og:site_name" content="AniList-Node Documentation" />
<meta property="og:url" content="https://katsurin.com/docs/anilist-node/" />

<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
Expand All @@ -14,6 +20,7 @@
<link type="text/css" rel="stylesheet" href="styles/prettify.css" />
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css" />
<script src="scripts/nav.js" defer></script>

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
Expand Down Expand Up @@ -154,7 +161,6 @@ <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#headerBuilder">headerBuilder</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>
Expand Down Expand Up @@ -188,8 +194,8 @@ <h3>Global</h3>
<li><a href="global.html#TextActivity">TextActivity</a></li>
<li><a href="global.html#ThreadComment">ThreadComment</a></li>
<li><a href="global.html#ThreadEntry">ThreadEntry</a></li>
<li><a href="global.html#UpdatedEntry">UpdatedEntry</a></li>
<li><a href="global.html#UpdateEntryOptions">UpdateEntryOptions</a></li>
<li><a href="global.html#UpdatedEntry">UpdatedEntry</a></li>
<li><a href="global.html#UserList">UserList</a></li>
<li><a href="global.html#UserOptions">UserOptions</a></li>
<li><a href="global.html#UserOptionsInput">UserOptionsInput</a></li>
Expand All @@ -198,6 +204,7 @@ <h3>Global</h3>
<li><a href="global.html#UserStaffNameLanguage">UserStaffNameLanguage</a></li>
<li><a href="global.html#UserStats">UserStats</a></li>
<li><a href="global.html#UserTitleLanguage">UserTitleLanguage</a></li>
<li><a href="global.html#headerBuilder">headerBuilder</a></li>
</ul>
</nav>

Expand All @@ -219,11 +226,19 @@ <h2>
<h3 class="subsection-title">Methods</h3>

<h4 class="name" id="delete">
<span class="type-signature">(async) </span>delete<span class="signature">(id)</span
<span class="type-signature type-signature-async">(async) </span>delete<span class="signature"
>(id)</span
><span class="type-signature"> &rarr; {Boolean}</span>
</h4>

<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>[Require Login] Delete the current authorized user's activity post</li>
</ul>
</dd>

<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
Expand All @@ -242,11 +257,7 @@ <h4 class="name" id="delete">
</dd>
</dl>

<div class="description usertext">
[Require Login] Delete the current authorized user's activity post
</div>

<h5>Parameters:</h5>
<h5 class="h5-parameters">Parameters:</h5>

<table class="params">
<thead>
Expand All @@ -272,7 +283,7 @@ <h5>Parameters:</h5>
</tbody>
</table>

<h5>Returns:</h5>
<h5 class="h5-returns">Returns:</h5>

<div class="param-desc">Returns true if successful</div>

Expand All @@ -294,6 +305,13 @@ <h4 class="name" id="get">
</h4>

<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>Get a specific AniList activity by its ID.</li>
</ul>
</dd>

<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
Expand All @@ -312,9 +330,7 @@ <h4 class="name" id="get">
</dd>
</dl>

<div class="description usertext">Get a specific AniList activity by its ID.</div>

<h5>Parameters:</h5>
<h5 class="h5-parameters">Parameters:</h5>

<table class="params">
<thead>
Expand All @@ -340,7 +356,7 @@ <h5>Parameters:</h5>
</tbody>
</table>

<h5>Returns:</h5>
<h5 class="h5-returns">Returns:</h5>

<div class="param-desc">
Returns the activity information. Activity will either appear as:
Expand Down Expand Up @@ -370,6 +386,13 @@ <h4 class="name" id="getUserActivity">
</h4>

<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>Fetch activities from a user.</li>
</ul>
</dd>

<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
Expand All @@ -388,9 +411,7 @@ <h4 class="name" id="getUserActivity">
</dd>
</dl>

<div class="description usertext">Fetch activities from a user.</div>

<h5>Parameters:</h5>
<h5 class="h5-parameters">Parameters:</h5>

<table class="params">
<thead>
Expand Down Expand Up @@ -450,7 +471,7 @@ <h5>Parameters:</h5>
</tbody>
</table>

<h5>Returns:</h5>
<h5 class="h5-returns">Returns:</h5>

<div class="param-desc">
Returns a list of user activities based on the page & perPage values Contains any number of
Expand All @@ -468,14 +489,22 @@ <h5>Returns:</h5>
</dl>

<h4 class="name" id="postMessage">
<span class="type-signature">(async) </span>postMessage<span class="signature"
<span class="type-signature type-signature-async">(async) </span>postMessage<span
class="signature"
>(text, recipientId, isPrivate, id<span class="signature-attributes">nullable</span>)</span
><span class="type-signature">
&rarr; {<a href="global.html#MessageActivity">MessageActivity</a>}</span
>
</h4>

<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>[Require Login] Post a new message activity or update the activity with its ID</li>
</ul>
</dd>

<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
Expand All @@ -494,11 +523,7 @@ <h4 class="name" id="postMessage">
</dd>
</dl>

<div class="description usertext">
[Require Login] Post a new message activity or update the activity with its ID
</div>

<h5>Parameters:</h5>
<h5 class="h5-parameters">Parameters:</h5>

<table class="params">
<thead>
Expand Down Expand Up @@ -576,7 +601,7 @@ <h5>Parameters:</h5>
</tbody>
</table>

<h5>Returns:</h5>
<h5 class="h5-returns">Returns:</h5>

<dl class="param-type">
<dt>Type</dt>
Expand All @@ -586,14 +611,21 @@ <h5>Returns:</h5>
</dl>

<h4 class="name" id="postText">
<span class="type-signature">(async) </span>postText<span class="signature"
<span class="type-signature type-signature-async">(async) </span>postText<span class="signature"
>(text, id<span class="signature-attributes">nullable</span>)</span
><span class="type-signature">
&rarr; {<a href="global.html#TextActivity">TextActivity</a>}</span
>
</h4>

<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description">
<ul class="dummy">
<li>[Require Login] Post a new text activity or update the activity with its ID</li>
</ul>
</dd>

<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
Expand All @@ -612,11 +644,7 @@ <h4 class="name" id="postText">
</dd>
</dl>

<div class="description usertext">
[Require Login] Post a new text activity or update the activity with its ID
</div>

<h5>Parameters:</h5>
<h5 class="h5-parameters">Parameters:</h5>

<table class="params">
<thead>
Expand Down Expand Up @@ -660,7 +688,7 @@ <h5>Parameters:</h5>
</tbody>
</table>

<h5>Returns:</h5>
<h5 class="h5-returns">Returns:</h5>

<dl class="param-type">
<dt>Type</dt>
Expand All @@ -675,7 +703,7 @@ <h5>Returns:</h5>
<br class="clear" />

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> using the
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> using the
<a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

Expand Down
Loading

0 comments on commit d012c84

Please sign in to comment.