Skip to content

Commit

Permalink
Merge pull request #34 from sern-handler/chore/docs
Browse files Browse the repository at this point in the history
chore: update docs
  • Loading branch information
jacoobes authored Apr 19, 2023
2 parents b8be42b + 9eebee8 commit b8377ec
Show file tree
Hide file tree
Showing 60 changed files with 1,629 additions and 2,074 deletions.
4 changes: 2 additions & 2 deletions blog/2022-09-30-mdx-blog-post.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you're using ESM, configure dotenv with `import 'dotenv/config'` instead of `

### And... that's it?

Yes, that's it. Here's a little FAQ to get you started. You can also join the [Discord](https://sern-handler.js.org/discord) for any problems.
Yes, that's it. Here's a little FAQ to get you started. You can also join the [Discord](https://sern.dev/discord) for any problems.

### Extra: Video tutorial!

Expand All @@ -59,4 +59,4 @@ Yes, that's it. Here's a little FAQ to get you started. You can also join the [D
**A**: Yeah, just search `sern Snippets` made by a verified publisher called Sr Izan (haha yeah me funny!)

**Q**: HEEEELLLPPPP!!!!
**A**: Hey, don't panic! We're here to help so, join the [Discord](https://sern-handler.js.org/discord). We're trying to get to 100 members!
**A**: Hey, don't panic! We're here to help so, join the [Discord](https://sern.dev/discord). We're trying to get to 100 members!
4 changes: 2 additions & 2 deletions blog/authors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ jacoobes:
image_url: https://github.com/jacoobes.png
Sr Izan:
name: Sr Izan
title: Contributor
title: Developer
url: https://github.com/SrIzan10
image_url: https://github.com/SrIzan10.png
Murtatrxx:
name: Murtatrxx
title: Developer
url: https://github.com/Murtatrxx
image_url: https://github.com/Murtatrxx.png
image_url: https://github.com/Murtatrxx.png
8 changes: 4 additions & 4 deletions docs/api/classes/CommandExecutable.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Will be refactored / changed in future

#### Defined in

[src/handler/sern.ts:121](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L121)
[src/handler/sern.ts:127](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L127)

___

Expand All @@ -46,7 +46,7 @@ ___

#### Defined in

[src/handler/sern.ts:120](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L120)
[src/handler/sern.ts:126](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L126)

___

Expand All @@ -56,7 +56,7 @@ ___

#### Defined in

[src/handler/sern.ts:119](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L119)
[src/handler/sern.ts:125](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L125)

___

Expand All @@ -66,4 +66,4 @@ ___

#### Defined in

[src/handler/sern.ts:118](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L118)
[src/handler/sern.ts:124](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L124)
35 changes: 19 additions & 16 deletions docs/api/classes/Context.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ sidebar_position: 0
custom_edit_url: null
---

**`Since`**

1.0.0
Provides values shared between
Message and ChatInputCommandInteraction

Expand All @@ -23,7 +26,7 @@ Message and ChatInputCommandInteraction

#### Defined in

[src/handler/structures/context.ts:22](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L22)
[src/handler/structures/context.ts:23](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L23)

## Accessors

Expand All @@ -37,7 +40,7 @@ Message and ChatInputCommandInteraction

#### Defined in

[src/handler/structures/context.ts:45](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L45)
[src/handler/structures/context.ts:46](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L46)

___

Expand All @@ -51,7 +54,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:75](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L75)
[src/handler/structures/context.ts:76](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L76)

___

Expand All @@ -65,7 +68,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L56)
[src/handler/structures/context.ts:57](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L57)

___

Expand All @@ -79,7 +82,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:60](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L60)
[src/handler/structures/context.ts:61](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L61)

___

Expand All @@ -93,7 +96,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:64](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L64)
[src/handler/structures/context.ts:65](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L65)

___

Expand All @@ -107,7 +110,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:41](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L41)
[src/handler/structures/context.ts:42](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L42)

___

Expand All @@ -121,7 +124,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:79](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L79)
[src/handler/structures/context.ts:80](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L80)

___

Expand All @@ -139,7 +142,7 @@ Message

#### Defined in

[src/handler/structures/context.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L37)
[src/handler/structures/context.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L38)

___

Expand All @@ -153,7 +156,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:71](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L71)
[src/handler/structures/context.ts:72](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L72)

___

Expand All @@ -171,7 +174,7 @@ ChatInputCommandInteraction

#### Defined in

[src/handler/structures/context.ts:29](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L29)
[src/handler/structures/context.ts:30](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L30)

___

Expand All @@ -188,7 +191,7 @@ else, interaction.user

#### Defined in

[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L52)
[src/handler/structures/context.ts:53](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L53)

## Methods

Expand All @@ -202,7 +205,7 @@ else, interaction.user

#### Defined in

[src/handler/structures/context.ts:82](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L82)
[src/handler/structures/context.ts:83](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L83)

___

Expand All @@ -216,7 +219,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:86](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L86)
[src/handler/structures/context.ts:87](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L87)

___

Expand All @@ -236,7 +239,7 @@ ___

#### Defined in

[src/handler/structures/context.ts:97](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L97)
[src/handler/structures/context.ts:98](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L98)

___

Expand All @@ -256,4 +259,4 @@ ___

#### Defined in

[src/handler/structures/context.ts:90](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L90)
[src/handler/structures/context.ts:91](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L91)
14 changes: 9 additions & 5 deletions docs/api/classes/DefaultErrorHandling.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---

**`Since`**

2.0.0

## Implements

- [`ErrorHandling`](../interfaces/ErrorHandling.md)
Expand All @@ -30,7 +34,7 @@ Number of times the process should throw an error until crashing and exiting

#### Defined in

[src/handler/contracts/errorHandling.ts:24](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L24)
[src/handler/contracts/errorHandling.ts:29](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L29)

## Methods

Expand All @@ -56,21 +60,21 @@ Utility function to crash

#### Defined in

[src/handler/contracts/errorHandling.ts:25](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L25)
[src/handler/contracts/errorHandling.ts:30](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L30)

___

### updateAlive

**updateAlive**(`e`): `void`
**updateAlive**(`_`): `void`

A function that is called on every crash. Updates keepAlive

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | `Error` |
| `_` | `Error` |

#### Returns

Expand All @@ -82,4 +86,4 @@ A function that is called on every crash. Updates keepAlive

#### Defined in

[src/handler/contracts/errorHandling.ts:28](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L28)
[src/handler/contracts/errorHandling.ts:33](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L33)
14 changes: 9 additions & 5 deletions docs/api/classes/DefaultLogging.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---

**`Since`**

2.0.0

## Implements

- [`Logging`](../interfaces/Logging.md)
Expand All @@ -28,7 +32,7 @@ custom_edit_url: null

#### Defined in

[src/handler/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L11)
[src/handler/contracts/logging.ts:15](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L15)

___

Expand All @@ -52,7 +56,7 @@ ___

#### Defined in

[src/handler/contracts/logging.ts:12](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L12)
[src/handler/contracts/logging.ts:16](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L16)

___

Expand All @@ -76,7 +80,7 @@ ___

#### Defined in

[src/handler/contracts/logging.ts:16](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L16)
[src/handler/contracts/logging.ts:20](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L20)

___

Expand All @@ -100,7 +104,7 @@ ___

#### Defined in

[src/handler/contracts/logging.ts:20](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L20)
[src/handler/contracts/logging.ts:24](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L24)

___

Expand All @@ -124,4 +128,4 @@ ___

#### Defined in

[src/handler/contracts/logging.ts:24](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L24)
[src/handler/contracts/logging.ts:28](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L28)
10 changes: 7 additions & 3 deletions docs/api/classes/DefaultModuleManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---

**`Since`**

2.0.0

## Implements

- [`ModuleManager`](../interfaces/ModuleManager.md)
Expand All @@ -24,7 +28,7 @@ custom_edit_url: null

#### Defined in

[src/handler/contracts/moduleManager.ts:13](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/moduleManager.ts#L13)
[src/handler/contracts/moduleManager.ts:17](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/moduleManager.ts#L17)

## Methods

Expand Down Expand Up @@ -54,7 +58,7 @@ custom_edit_url: null

#### Defined in

[src/handler/contracts/moduleManager.ts:14](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/moduleManager.ts#L14)
[src/handler/contracts/moduleManager.ts:18](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/moduleManager.ts#L18)

___

Expand All @@ -78,4 +82,4 @@ ___

#### Defined in

[src/handler/contracts/moduleManager.ts:20](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/moduleManager.ts#L20)
[src/handler/contracts/moduleManager.ts:24](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/moduleManager.ts#L24)
8 changes: 4 additions & 4 deletions docs/api/classes/EventExecutable.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Will be refactored in future

#### Defined in

[src/handler/sern.ts:130](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L130)
[src/handler/sern.ts:137](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L137)

___

Expand All @@ -46,7 +46,7 @@ ___

#### Defined in

[src/handler/sern.ts:129](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L129)
[src/handler/sern.ts:136](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L136)

___

Expand All @@ -56,7 +56,7 @@ ___

#### Defined in

[src/handler/sern.ts:128](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L128)
[src/handler/sern.ts:135](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L135)

___

Expand All @@ -66,4 +66,4 @@ ___

#### Defined in

[src/handler/sern.ts:127](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L127)
[src/handler/sern.ts:134](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L134)
Loading

0 comments on commit b8377ec

Please sign in to comment.