-
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added reference docs for all plugins
- Loading branch information
Showing
55 changed files
with
2,452 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Function: textToSpeech() | ||
|
||
```ts | ||
function textToSpeech(text, filePath): Promise<string> | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `text` | `string` | | ||
| `filePath` | `string` | | ||
|
||
## Returns | ||
|
||
`Promise`\<`string`\> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# @robojs/ai-voice | ||
|
||
## Functions | ||
|
||
- [textToSpeech](Function.textToSpeech.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
// @ts-check | ||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ | ||
const typedocSidebar = { items: [{"type":"category","label":"Functions","items":[{"type":"doc","id":"ref/@robojs/ai-voice/Function.textToSpeech","label":"textToSpeech"}]}]}; | ||
module.exports = typedocSidebar.items; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Function: selectOne() | ||
|
||
```ts | ||
function selectOne( | ||
selection, | ||
choices, | ||
options?): Promise<string | null> | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `selection` | `string` | | ||
| `choices` | `string`[] | | ||
| `options`? | `SelectOneOptions` | | ||
|
||
## Returns | ||
|
||
`Promise`\<`string` \| `null`\> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Variable: AI | ||
|
||
```ts | ||
const AI: object; | ||
``` | ||
|
||
The core AI interface. | ||
Use this to call AI features programatically. | ||
|
||
## Type declaration | ||
|
||
### chat() | ||
|
||
```ts | ||
chat: (messages, options) => Promise<void>; | ||
``` | ||
|
||
#### Parameters | ||
|
||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `messages` | `ChatMessage`[] | | ||
| `options` | `ChatOptions` | | ||
|
||
#### Returns | ||
|
||
`Promise`\<`void`\> | ||
|
||
### chatSync() | ||
|
||
```ts | ||
chatSync: (messages, options) => Promise<ChatReply>; | ||
``` | ||
|
||
#### Parameters | ||
|
||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `messages` | `ChatMessage`[] | | ||
| `options` | `Omit`\<`ChatOptions`, `"onReply"`\> | | ||
|
||
#### Returns | ||
|
||
`Promise`\<`ChatReply`\> | ||
|
||
### generateImage() | ||
|
||
```ts | ||
generateImage: (options) => Promise<GenerateImageResult>; | ||
``` | ||
|
||
#### Parameters | ||
|
||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `options` | `GenerateImageOptions` | | ||
|
||
#### Returns | ||
|
||
`Promise`\<`GenerateImageResult`\> | ||
|
||
### isReady() | ||
|
||
```ts | ||
isReady: () => boolean; | ||
``` | ||
|
||
#### Returns | ||
|
||
`boolean` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# @robojs/ai | ||
|
||
## Variables | ||
|
||
- [AI](Variable.AI.md) | ||
|
||
## Functions | ||
|
||
- [selectOne](Function.selectOne.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
// @ts-check | ||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ | ||
const typedocSidebar = { items: [{"type":"category","label":"Variables","items":[{"type":"doc","id":"ref/@robojs/ai/Variable.AI","label":"AI"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"ref/@robojs/ai/Function.selectOne","label":"selectOne"}]}]}; | ||
module.exports = typedocSidebar.items; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Class: GoogleAnalytics | ||
|
||
## Extends | ||
|
||
- `BaseEngine` | ||
|
||
## Constructors | ||
|
||
### new GoogleAnalytics() | ||
|
||
```ts | ||
new GoogleAnalytics(options?): GoogleAnalytics | ||
``` | ||
#### Parameters | ||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `options`? | `GoogleAnalyticsOptions` | | ||
#### Returns | ||
[`GoogleAnalytics`](Class.GoogleAnalytics.md) | ||
#### Overrides | ||
`BaseEngine.constructor` | ||
## Methods | ||
### event() | ||
```ts | ||
event(name, options?): Promise<void> | ||
``` | ||
#### Parameters | ||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `name` | `string` | | ||
| `options`? | `EventOptions` | | ||
#### Returns | ||
`Promise`\<`void`\> | ||
#### Overrides | ||
`BaseEngine.event` | ||
*** | ||
### view() | ||
```ts | ||
view(page, options?): Promise<void> | ||
``` | ||
#### Parameters | ||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `page` | `string` | | ||
| `options`? | `ViewOptions` | | ||
#### Returns | ||
`Promise`\<`void`\> | ||
#### Overrides | ||
`BaseEngine.view` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Class: ManyEngines | ||
|
||
## Extends | ||
|
||
- `BaseEngine` | ||
|
||
## Constructors | ||
|
||
### new ManyEngines() | ||
|
||
```ts | ||
new ManyEngines(...engines): ManyEngines | ||
``` | ||
|
||
#### Parameters | ||
|
||
| Parameter | Type | | ||
| ------ | ------ | | ||
| ...`engines` | `BaseEngine`[] | | ||
|
||
#### Returns | ||
|
||
[`ManyEngines`](Class.ManyEngines.md) | ||
|
||
#### Overrides | ||
|
||
`BaseEngine.constructor` | ||
|
||
## Methods | ||
|
||
### event() | ||
|
||
```ts | ||
event(name, options?): Promise<void> | ||
``` | ||
#### Parameters | ||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `name` | `string` | | ||
| `options`? | `EventOptions` | | ||
#### Returns | ||
`Promise`\<`void`\> | ||
#### Overrides | ||
`BaseEngine.event` | ||
*** | ||
### view() | ||
```ts | ||
view(page, options?): Promise<void> | ||
``` | ||
#### Parameters | ||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `page` | `string` | | ||
| `options`? | `ViewOptions` | | ||
#### Returns | ||
`Promise`\<`void`\> | ||
#### Overrides | ||
`BaseEngine.view` |
73 changes: 73 additions & 0 deletions
73
docs/docs/ref/@robojs/analytics/Class.PlausibleAnalytics.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Class: PlausibleAnalytics | ||
|
||
## Extends | ||
|
||
- `BaseEngine` | ||
|
||
## Constructors | ||
|
||
### new PlausibleAnalytics() | ||
|
||
```ts | ||
new PlausibleAnalytics(domain?): PlausibleAnalytics | ||
``` | ||
#### Parameters | ||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `domain`? | `string` | | ||
#### Returns | ||
[`PlausibleAnalytics`](Class.PlausibleAnalytics.md) | ||
#### Overrides | ||
`BaseEngine.constructor` | ||
## Methods | ||
### event() | ||
```ts | ||
event(name, options): Promise<void> | ||
``` | ||
#### Parameters | ||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `name` | `string` | | ||
| `options` | `EventOptions` | | ||
#### Returns | ||
`Promise`\<`void`\> | ||
#### Overrides | ||
`BaseEngine.event` | ||
*** | ||
### view() | ||
```ts | ||
view(page, options): Promise<void> | ||
``` | ||
#### Parameters | ||
| Parameter | Type | | ||
| ------ | ------ | | ||
| `page` | `string` | | ||
| `options` | `ViewOptions` | | ||
#### Returns | ||
`Promise`\<`void`\> | ||
#### Overrides | ||
`BaseEngine.view` |
Oops, something went wrong.