Merge pull request #11 from MattPlays/dev

v2.0.7

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Gen Docs
+
+on:
+    push:
+        branches: [main, dev, nightly]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [17.x]
+
+        steps:
+            - uses: actions/checkout@v2
+
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v1
+              with:
+                  node-version: ${{ matrix.node-version }}
+
+            - name: Build docs
+              run: |
+                  sudo npm install
+                  sudo npm docs
+            - name: setup git config
+              run: |
+                  git config user.name "GitHub Actions Bot"
+                  git config user.email "<>"
+            - name: commit
+              run: |
+                  git pull
+                  git add .
+                  git commit -m "Gen Docs"
+                  git push

.github/workflows/npm-publish.yml

@@ -1,7 +1,7 @@
 # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
 # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
 
-name: Node.js Package
+name: Change Name
 
 on:
   push:

.gitignore

@@ -79,4 +79,5 @@ typings/
 
 old-*
 test.js
-dist
+dist
+docs/README.md

README.md

@@ -9,8 +9,11 @@ Maintained by: @Artrix9095 @MattPlays
 npm i @mattplays/aniapi
 ```
 
-# Documentation
-WIP
+Useful Links:
+
+-   [Docs](docs/modules.md)
+-   [AniAPI](https://aniapi.com/)
+-   [AniAPI Docs](https://aniapi.com/docs/)
 
 # License
 

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/classes/API.md

@@ -0,0 +1,167 @@
+[@mattplays/aniapi](../README.md) / [Exports](../modules.md) / API
+
+# Class: API
+
+## Table of contents
+
+### Constructors
+
+- [constructor](API.md#constructor)
+
+### Properties
+
+- [Anime](API.md#anime)
+- [Episode](API.md#episode)
+- [Resource](API.md#resource)
+- [Song](API.md#song)
+- [User](API.md#user)
+- [UserStory](API.md#userstory)
+- [validateToken](API.md#validatetoken)
+
+## Constructors
+
+### constructor
+
+• **new API**(`jwt`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `jwt` | `string` |
+
+#### Defined in
+
+[API/handlers/index.ts:23](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L23)
+
+## Properties
+
+### Anime
+
+• **Anime**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Get` | (`filters`: `AnimeFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<[`Page`](../modules.md#page)<`Anime`\>\>\> |
+| `GetByID` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Anime`\>\> |
+| `Random` | (`count`: `number`, `nsfw`: `boolean`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Anime`[]\>\> |
+
+#### Defined in
+
+[API/handlers/index.ts:26](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L26)
+
+___
+
+### Episode
+
+• **Episode**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Get` | (`filters`: `EpisodeFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<[`Page`](../modules.md#page)<`Episode`\>\>\> |
+| `GetByID` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Episode`\>\> |
+
+#### Defined in
+
+[API/handlers/index.ts:63](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L63)
+
+___
+
+### Resource
+
+• **Resource**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `GetGenres` | (`version`: `string`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Resource`\>\> |
+| `GetLocalizations` | (`version`: `string`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Resource`\>\> |
+
+#### Defined in
+
+[API/handlers/index.ts:236](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L236)
+
+___
+
+### Song
+
+• **Song**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Get` | (`filters`: `SongFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<[`Page`](../modules.md#page)<`Song`\>\>\> |
+| `GetByID` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Song`\>\> |
+| `Random` | (`count`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Song`[]\>\> |
+
+#### Defined in
+
+[API/handlers/index.ts:91](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L91)
+
+___
+
+### User
+
+• **User**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Delete` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<``""``\>\> |
+| `Get` | (`filters`: `UserFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<[`Page`](../modules.md#page)<`User`\>\>\> |
+| `GetByID` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`User`\>\> |
+| `Update` | (`changes`: { `id`: `string` \| `number`  } & `UserChanges`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`User`\>\> |
+
+#### Defined in
+
+[API/handlers/index.ts:128](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L128)
+
+___
+
+### UserStory
+
+• **UserStory**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Create` | (`changes`: `UserStoryChanges`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`UserStory`\>\> |
+| `Delete` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<``""``\>\> |
+| `Get` | (`filters`: `UserStoryFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`UserStory`[]\>\> |
+| `Update` | (`changes`: { `id`: `string` \| `number`  } & `UserChanges`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`UserStory`\>\> |
+
+#### Defined in
+
+[API/handlers/index.ts:181](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L181)
+
+___
+
+### validateToken
+
+• **validateToken**: (`jwt`: `string`) => `Promise`<`boolean`\> = `validateToken`
+
+#### Type declaration
+
+▸ (`jwt`): `Promise`<`boolean`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `jwt` | `string` |
+
+##### Returns
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+[API/handlers/index.ts:25](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L25)

docs/enums/AnimeFormat.md

@@ -0,0 +1,85 @@
+[@mattplays/aniapi](../README.md) / [Exports](../modules.md) / AnimeFormat
+
+# Enumeration: AnimeFormat
+
+## Table of contents
+
+### Enumeration members
+
+- [MOVIE](AnimeFormat.md#movie)
+- [MUSIC](AnimeFormat.md#music)
+- [ONA](AnimeFormat.md#ona)
+- [OVA](AnimeFormat.md#ova)
+- [SPECIAL](AnimeFormat.md#special)
+- [TV](AnimeFormat.md#tv)
+- [TV\_SHORT](AnimeFormat.md#tv_short)
+
+## Enumeration members
+
+### MOVIE
+
+• **MOVIE** = `2`
+
+#### Defined in
+
+[API/types/Anime.ts:50](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L50)
+
+___
+
+### MUSIC
+
+• **MUSIC** = `6`
+
+#### Defined in
+
+[API/types/Anime.ts:54](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L54)
+
+___
+
+### ONA
+
+• **ONA** = `5`
+
+#### Defined in
+
+[API/types/Anime.ts:53](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L53)
+
+___
+
+### OVA
+
+• **OVA** = `4`
+
+#### Defined in
+
+[API/types/Anime.ts:52](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L52)
+
+___
+
+### SPECIAL
+
+• **SPECIAL** = `3`
+
+#### Defined in
+
+[API/types/Anime.ts:51](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L51)
+
+___
+
+### TV
+
+• **TV** = `0`
+
+#### Defined in
+
+[API/types/Anime.ts:48](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L48)
+
+___
+
+### TV\_SHORT
+
+• **TV\_SHORT** = `1`
+
+#### Defined in
+
+[API/types/Anime.ts:49](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L49)

docs/enums/AnimeSeasonPeriod.md

@@ -0,0 +1,63 @@
+[@mattplays/aniapi](../README.md) / [Exports](../modules.md) / AnimeSeasonPeriod
+
+# Enumeration: AnimeSeasonPeriod
+
+## Table of contents
+
+### Enumeration members
+
+- [FALL](AnimeSeasonPeriod.md#fall)
+- [SPRING](AnimeSeasonPeriod.md#spring)
+- [SUMMER](AnimeSeasonPeriod.md#summer)
+- [UNKNOWN](AnimeSeasonPeriod.md#unknown)
+- [WINTER](AnimeSeasonPeriod.md#winter)
+
+## Enumeration members
+
+### FALL
+
+• **FALL** = `3`
+
+#### Defined in
+
+[API/types/Anime.ts:66](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L66)
+
+___
+
+### SPRING
+
+• **SPRING** = `1`
+
+#### Defined in
+
+[API/types/Anime.ts:64](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L64)
+
+___
+
+### SUMMER
+
+• **SUMMER** = `2`
+
+#### Defined in
+
+[API/types/Anime.ts:65](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L65)
+
+___
+
+### UNKNOWN
+
+• **UNKNOWN** = `4`
+
+#### Defined in
+
+[API/types/Anime.ts:67](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L67)
+
+___
+
+### WINTER
+
+• **WINTER** = `0`
+
+#### Defined in
+
+[API/types/Anime.ts:63](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L63)