Skip to content
This repository was archived by the owner on Jun 13, 2022. It is now read-only.

Commit 361fe34

Browse files
artrixdotdevartrixdotdev
authored
Merge pull request #11 from MattPlays/dev
v2.0.7
2 parents f39d9ef + 21ee588 commit 361fe34

24 files changed

+2191
-247
lines changed

‎.github/workflows/docs.yml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Gen Docs
2+
3+
on:
4+
push:
5+
branches: [main, dev, nightly]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
11+
strategy:
12+
matrix:
13+
node-version: [17.x]
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
18+
- name: Use Node.js ${{ matrix.node-version }}
19+
uses: actions/setup-node@v1
20+
with:
21+
node-version: ${{ matrix.node-version }}
22+
23+
- name: Build docs
24+
run: |
25+
sudo npm install
26+
sudo npm docs
27+
- name: setup git config
28+
run: |
29+
git config user.name "GitHub Actions Bot"
30+
git config user.email "<>"
31+
- name: commit
32+
run: |
33+
git pull
34+
git add .
35+
git commit -m "Gen Docs"
36+
git push

‎.github/workflows/npm-publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
33

4-
name: Node.js Package
4+
name: Change Name
55

66
on:
77
push:

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,5 @@ typings/
7979

8080
old-*
8181
test.js
82-
dist
82+
dist
83+
docs/README.md

‎README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,11 @@ Maintained by: @Artrix9095 @MattPlays
99
npm i @mattplays/aniapi
1010
```
1111

12-
# Documentation
13-
WIP
12+
Useful Links:
13+
14+
- [Docs](docs/modules.md)
15+
- [AniAPI](https://aniapi.com/)
16+
- [AniAPI Docs](https://aniapi.com/docs/)
1417

1518
# License
1619

‎docs/.nojekyll

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
[@mattplays/aniapi](../README.md) / [Exports](../modules.md) / API
2+
3+
# Class: API
4+
5+
## Table of contents
6+
7+
### Constructors
8+
9+
- [constructor](API.md#constructor)
10+
11+
### Properties
12+
13+
- [Anime](API.md#anime)
14+
- [Episode](API.md#episode)
15+
- [Resource](API.md#resource)
16+
- [Song](API.md#song)
17+
- [User](API.md#user)
18+
- [UserStory](API.md#userstory)
19+
- [validateToken](API.md#validatetoken)
20+
21+
## Constructors
22+
23+
### constructor
24+
25+
• **new API**(`jwt`)
26+
27+
#### Parameters
28+
29+
| Name | Type |
30+
| :------ | :------ |
31+
| `jwt` | `string` |
32+
33+
#### Defined in
34+
35+
[API/handlers/index.ts:23](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L23)
36+
37+
## Properties
38+
39+
### Anime
40+
41+
• **Anime**: `Object`
42+
43+
#### Type declaration
44+
45+
| Name | Type |
46+
| :------ | :------ |
47+
| `Get` | (`filters`: `AnimeFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<[`Page`](../modules.md#page)<`Anime`\>\>\> |
48+
| `GetByID` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Anime`\>\> |
49+
| `Random` | (`count`: `number`, `nsfw`: `boolean`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Anime`[]\>\> |
50+
51+
#### Defined in
52+
53+
[API/handlers/index.ts:26](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L26)
54+
55+
___
56+
57+
### Episode
58+
59+
• **Episode**: `Object`
60+
61+
#### Type declaration
62+
63+
| Name | Type |
64+
| :------ | :------ |
65+
| `Get` | (`filters`: `EpisodeFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<[`Page`](../modules.md#page)<`Episode`\>\>\> |
66+
| `GetByID` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Episode`\>\> |
67+
68+
#### Defined in
69+
70+
[API/handlers/index.ts:63](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L63)
71+
72+
___
73+
74+
### Resource
75+
76+
• **Resource**: `Object`
77+
78+
#### Type declaration
79+
80+
| Name | Type |
81+
| :------ | :------ |
82+
| `GetGenres` | (`version`: `string`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Resource`\>\> |
83+
| `GetLocalizations` | (`version`: `string`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Resource`\>\> |
84+
85+
#### Defined in
86+
87+
[API/handlers/index.ts:236](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L236)
88+
89+
___
90+
91+
### Song
92+
93+
• **Song**: `Object`
94+
95+
#### Type declaration
96+
97+
| Name | Type |
98+
| :------ | :------ |
99+
| `Get` | (`filters`: `SongFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<[`Page`](../modules.md#page)<`Song`\>\>\> |
100+
| `GetByID` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Song`\>\> |
101+
| `Random` | (`count`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`Song`[]\>\> |
102+
103+
#### Defined in
104+
105+
[API/handlers/index.ts:91](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L91)
106+
107+
___
108+
109+
### User
110+
111+
• **User**: `Object`
112+
113+
#### Type declaration
114+
115+
| Name | Type |
116+
| :------ | :------ |
117+
| `Delete` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<``""``\>\> |
118+
| `Get` | (`filters`: `UserFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<[`Page`](../modules.md#page)<`User`\>\>\> |
119+
| `GetByID` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`User`\>\> |
120+
| `Update` | (`changes`: { `id`: `string` \| `number` } & `UserChanges`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`User`\>\> |
121+
122+
#### Defined in
123+
124+
[API/handlers/index.ts:128](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L128)
125+
126+
___
127+
128+
### UserStory
129+
130+
• **UserStory**: `Object`
131+
132+
#### Type declaration
133+
134+
| Name | Type |
135+
| :------ | :------ |
136+
| `Create` | (`changes`: `UserStoryChanges`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`UserStory`\>\> |
137+
| `Delete` | (`id`: `string` \| `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<``""``\>\> |
138+
| `Get` | (`filters`: `UserStoryFilters`, `page`: `number`, `per_page`: `number`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`UserStory`[]\>\> |
139+
| `Update` | (`changes`: { `id`: `string` \| `number` } & `UserChanges`) => `Promise`<[`APIResponse`](../interfaces/APIResponse.md)<`UserStory`\>\> |
140+
141+
#### Defined in
142+
143+
[API/handlers/index.ts:181](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L181)
144+
145+
___
146+
147+
### validateToken
148+
149+
• **validateToken**: (`jwt`: `string`) => `Promise`<`boolean`\> = `validateToken`
150+
151+
#### Type declaration
152+
153+
▸ (`jwt`): `Promise`<`boolean`\>
154+
155+
##### Parameters
156+
157+
| Name | Type |
158+
| :------ | :------ |
159+
| `jwt` | `string` |
160+
161+
##### Returns
162+
163+
`Promise`<`boolean`\>
164+
165+
#### Defined in
166+
167+
[API/handlers/index.ts:25](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/handlers/index.ts#L25)

‎docs/enums/AnimeFormat.md

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
[@mattplays/aniapi](../README.md) / [Exports](../modules.md) / AnimeFormat
2+
3+
# Enumeration: AnimeFormat
4+
5+
## Table of contents
6+
7+
### Enumeration members
8+
9+
- [MOVIE](AnimeFormat.md#movie)
10+
- [MUSIC](AnimeFormat.md#music)
11+
- [ONA](AnimeFormat.md#ona)
12+
- [OVA](AnimeFormat.md#ova)
13+
- [SPECIAL](AnimeFormat.md#special)
14+
- [TV](AnimeFormat.md#tv)
15+
- [TV\_SHORT](AnimeFormat.md#tv_short)
16+
17+
## Enumeration members
18+
19+
### MOVIE
20+
21+
• **MOVIE** = `2`
22+
23+
#### Defined in
24+
25+
[API/types/Anime.ts:50](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L50)
26+
27+
___
28+
29+
### MUSIC
30+
31+
• **MUSIC** = `6`
32+
33+
#### Defined in
34+
35+
[API/types/Anime.ts:54](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L54)
36+
37+
___
38+
39+
### ONA
40+
41+
• **ONA** = `5`
42+
43+
#### Defined in
44+
45+
[API/types/Anime.ts:53](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L53)
46+
47+
___
48+
49+
### OVA
50+
51+
• **OVA** = `4`
52+
53+
#### Defined in
54+
55+
[API/types/Anime.ts:52](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L52)
56+
57+
___
58+
59+
### SPECIAL
60+
61+
• **SPECIAL** = `3`
62+
63+
#### Defined in
64+
65+
[API/types/Anime.ts:51](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L51)
66+
67+
___
68+
69+
### TV
70+
71+
• **TV** = `0`
72+
73+
#### Defined in
74+
75+
[API/types/Anime.ts:48](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L48)
76+
77+
___
78+
79+
### TV\_SHORT
80+
81+
• **TV\_SHORT** = `1`
82+
83+
#### Defined in
84+
85+
[API/types/Anime.ts:49](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L49)

‎docs/enums/AnimeSeasonPeriod.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
[@mattplays/aniapi](../README.md) / [Exports](../modules.md) / AnimeSeasonPeriod
2+
3+
# Enumeration: AnimeSeasonPeriod
4+
5+
## Table of contents
6+
7+
### Enumeration members
8+
9+
- [FALL](AnimeSeasonPeriod.md#fall)
10+
- [SPRING](AnimeSeasonPeriod.md#spring)
11+
- [SUMMER](AnimeSeasonPeriod.md#summer)
12+
- [UNKNOWN](AnimeSeasonPeriod.md#unknown)
13+
- [WINTER](AnimeSeasonPeriod.md#winter)
14+
15+
## Enumeration members
16+
17+
### FALL
18+
19+
• **FALL** = `3`
20+
21+
#### Defined in
22+
23+
[API/types/Anime.ts:66](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L66)
24+
25+
___
26+
27+
### SPRING
28+
29+
• **SPRING** = `1`
30+
31+
#### Defined in
32+
33+
[API/types/Anime.ts:64](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L64)
34+
35+
___
36+
37+
### SUMMER
38+
39+
• **SUMMER** = `2`
40+
41+
#### Defined in
42+
43+
[API/types/Anime.ts:65](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L65)
44+
45+
___
46+
47+
### UNKNOWN
48+
49+
• **UNKNOWN** = `4`
50+
51+
#### Defined in
52+
53+
[API/types/Anime.ts:67](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L67)
54+
55+
___
56+
57+
### WINTER
58+
59+
• **WINTER** = `0`
60+
61+
#### Defined in
62+
63+
[API/types/Anime.ts:63](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Anime.ts#L63)

0 commit comments

Comments
 (0)