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

Commit

Permalink
docs, i give up on the workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Artrix9095 committed Mar 31, 2022
1 parent e795ab7 commit a698913
Show file tree
Hide file tree
Showing 17 changed files with 1,555 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/.nojekyll
Original file line number Diff line number Diff line change
@@ -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.
167 changes: 167 additions & 0 deletions docs/classes/API.md
Original file line number Diff line number Diff line change
@@ -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)
85 changes: 85 additions & 0 deletions docs/enums/AnimeFormat.md
Original file line number Diff line number Diff line change
@@ -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)
63 changes: 63 additions & 0 deletions docs/enums/AnimeSeasonPeriod.md
Original file line number Diff line number Diff line change
@@ -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)
41 changes: 41 additions & 0 deletions docs/enums/AnimeSongType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[@mattplays/aniapi](../README.md) / [Exports](../modules.md) / AnimeSongType

# Enumeration: AnimeSongType

## Table of contents

### Enumeration members

- [ENDING](AnimeSongType.md#ending)
- [NONE](AnimeSongType.md#none)
- [OPENING](AnimeSongType.md#opening)

## Enumeration members

### ENDING

**ENDING** = `1`

#### Defined in

[API/types/Song.ts:20](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Song.ts#L20)

___

### NONE

**NONE** = `2`

#### Defined in

[API/types/Song.ts:21](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Song.ts#L21)

___

### OPENING

**OPENING** = `0`

#### Defined in

[API/types/Song.ts:19](https://github.com/MattPlays/AniAPI.js/blob/e795ab7/src/API/types/Song.ts#L19)
Loading

0 comments on commit a698913

Please sign in to comment.