doc update

This commit is contained in:
Jacob Nguyen
2024-05-31 00:52:52 -05:00
parent b524fa7008
commit 2e769800dd
75 changed files with 371 additions and 296 deletions

View File

@@ -0,0 +1,21 @@
---
editUrl: false
next: false
prev: false
title: "Presence"
---
## Index
### Interfaces
- [Result](/v3/api/namespacespresenceinterfaces/result/)
### Type Aliases
- [Config](/v3/api/namespacespresencetype-aliases/config/)
### Functions
- [module](/v3/api/namespacespresencefunctions/module/)
- [of](/v3/api/namespacespresencefunctions/of/)

View File

@@ -5,7 +5,7 @@ prev: false
title: "module"
---
> **module**\<`T`\>(`conf`): [`Config`](/v3/api/namespaces/presence/type-aliases/config/)\<`T`\>
> **module**\<`T`\>(`conf`): [`Config`](/v3/api/namespacespresencetype-aliases/config/)\<`T`\>
A small wrapper to provide type inference.
Create a Presence module which **MUST** be put in a file called presence.(language-extension)
@@ -17,11 +17,11 @@ adjacent to the file where **Sern.init** is CALLED.
## Parameters
**conf**: [`Config`](/v3/api/namespaces/presence/type-aliases/config/)\<`T`\>
**conf**: [`Config`](/v3/api/namespacespresencetype-aliases/config/)\<`T`\>
## Returns
[`Config`](/v3/api/namespaces/presence/type-aliases/config/)\<`T`\>
[`Config`](/v3/api/namespacespresencetype-aliases/config/)\<`T`\>
## Source

View File

@@ -13,7 +13,7 @@ Create a Presence body which can be either:
## Parameters
**root**: `Omit`\<[`Result`](/v3/api/namespaces/presence/interfaces/result/), `"repeat"` \| `"onRepeat"`\>
**root**: `Omit`\<[`Result`](/v3/api/namespacespresenceinterfaces/result/), `"repeat"` \| `"onRepeat"`\>
## Returns
@@ -21,7 +21,7 @@ Create a Presence body which can be either:
### once()
> **once**: () => `Omit`\<[`Result`](/v3/api/namespaces/presence/interfaces/result/), `"repeat"` \| `"onRepeat"`\>
> **once**: () => `Omit`\<[`Result`](/v3/api/namespacespresenceinterfaces/result/), `"repeat"` \| `"onRepeat"`\>
#### Example
@@ -37,7 +37,7 @@ Presence
#### Returns
`Omit`\<[`Result`](/v3/api/namespaces/presence/interfaces/result/), `"repeat"` \| `"onRepeat"`\>
`Omit`\<[`Result`](/v3/api/namespacespresenceinterfaces/result/), `"repeat"` \| `"onRepeat"`\>
### repeated()

View File

@@ -29,15 +29,15 @@ title: "Result"
### onRepeat()?
> `optional` **onRepeat**: (`previous`) => [`Result`](/v3/api/namespaces/presence/interfaces/result/)
> `optional` **onRepeat**: (`previous`) => [`Result`](/v3/api/namespacespresenceinterfaces/result/)
#### Parameters
**previous**: [`Result`](/v3/api/namespaces/presence/interfaces/result/)
**previous**: [`Result`](/v3/api/namespacespresenceinterfaces/result/)
#### Returns
[`Result`](/v3/api/namespaces/presence/interfaces/result/)
[`Result`](/v3/api/namespacespresenceinterfaces/result/)
#### Source

View File

@@ -15,7 +15,7 @@ title: "Config"
### execute()
> **execute**: (...`v`) => [`Result`](/v3/api/namespaces/presence/interfaces/result/)
> **execute**: (...`v`) => [`Result`](/v3/api/namespacespresenceinterfaces/result/)
#### Parameters
@@ -23,7 +23,7 @@ title: "Config"
#### Returns
[`Result`](/v3/api/namespaces/presence/interfaces/result/)
[`Result`](/v3/api/namespacespresenceinterfaces/result/)
### inject?

View File

@@ -0,0 +1,12 @@
---
editUrl: false
next: false
prev: false
title: "Sern"
---
## Index
### Functions
- [init](/v3/api/namespacessernfunctions/init/)