mirror of
https://github.com/sern-handler/website
synced 2026-06-21 15:22:24 +00:00
chore: update api documentation
This commit is contained in:
93
docs/api/namespaces/Presence.md
Normal file
93
docs/api/namespaces/Presence.md
Normal file
@@ -0,0 +1,93 @@
|
||||
---
|
||||
id: "Presence"
|
||||
title: "Namespace: Presence"
|
||||
sidebar_label: "Presence"
|
||||
sidebar_position: 0
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [Result](../interfaces/Presence.Result.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### Config
|
||||
|
||||
Ƭ **Config**<`T`\>: `Object`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends keyof `Dependencies`[] |
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `execute` | (...`v`: `IntoDependencies`<`T`\>) => [`Result`](../interfaces/Presence.Result.md) |
|
||||
| `inject?` | [...T] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:17](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L17)
|
||||
|
||||
## Functions
|
||||
|
||||
### module
|
||||
|
||||
▸ **module**<`T`\>(`conf`): [`Config`](Presence.md#config)<`T`\>
|
||||
|
||||
A small wrapper to provide type inference.
|
||||
Create a Presence module which **MUST** be put in a file called presence.<language-extension>
|
||||
adjacent to the file where **Sern.init** is CALLED.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends keyof `Dependencies`[] |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `conf` | [`Config`](Presence.md#config)<`T`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Config`](Presence.md#config)<`T`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:28](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### of
|
||||
|
||||
▸ **of**(`root`): `Object`
|
||||
|
||||
Create a Presence body which can be either:
|
||||
- once, the presence is activated only once.
|
||||
- repeated, per cycle or event, the presence can be changed.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `root` | `Omit`<[`Result`](../interfaces/Presence.Result.md), ``"repeat"`` \| ``"onRepeat"``\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Object`
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `once` | () => `Omit`<[`Result`](../interfaces/Presence.Result.md), ``"repeat"`` \| ``"onRepeat"``\> |
|
||||
| `repeated` | (`onRepeat`: `PresenceReduce`, `repeat`: `number` \| [[`Emitter`](../interfaces/Emitter.md), `string`]) => \{ `activities?`: `ActivitiesOptions`[] ; `afk?`: `boolean` ; `onRepeat`: `PresenceReduce` ; `repeat`: `number` \| [[`Emitter`](../interfaces/Emitter.md), `string`] ; `shardId?`: `number`[] ; `status?`: `Status` } |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:39](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L39)
|
||||
@@ -6,28 +6,6 @@ sidebar_position: 0
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
## Variables
|
||||
|
||||
### controller
|
||||
|
||||
• `Const` **controller**: `Object`
|
||||
|
||||
**`Since`**
|
||||
|
||||
1.0.0
|
||||
The object passed into every plugin to control a command's behavior
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `next` | () => `OkImpl`<`void`\> |
|
||||
| `stop` | () => `ErrImpl`<`void`\> |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/sern.ts:63](https://github.com/sern-handler/handler/blob/504cdee/src/sern.ts#L63)
|
||||
|
||||
## Functions
|
||||
|
||||
### init
|
||||
@@ -59,4 +37,4 @@ Sern.init({
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/sern.ts:24](https://github.com/sern-handler/handler/blob/504cdee/src/sern.ts#L24)
|
||||
[src/sern.ts:27](https://github.com/sern-handler/handler/blob/b0399f9/src/sern.ts#L27)
|
||||
|
||||
Reference in New Issue
Block a user