Skip to content

Commit

Permalink
docs: added reference docs for all plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
Pkmmte committed Nov 13, 2024
1 parent 2b9d2dd commit 26fdbe6
Show file tree
Hide file tree
Showing 55 changed files with 2,452 additions and 16 deletions.
16 changes: 16 additions & 0 deletions docs/docs/ref/@robojs/ai-voice/Function.textToSpeech.md
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`\>
5 changes: 5 additions & 0 deletions docs/docs/ref/@robojs/ai-voice/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# @robojs/ai-voice

## Functions

- [textToSpeech](Function.textToSpeech.md)
4 changes: 4 additions & 0 deletions docs/docs/ref/@robojs/ai-voice/typedoc-sidebar.cjs
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;
20 changes: 20 additions & 0 deletions docs/docs/ref/@robojs/ai/Function.selectOne.md
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`\>
70 changes: 70 additions & 0 deletions docs/docs/ref/@robojs/ai/Variable.AI.md
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`
9 changes: 9 additions & 0 deletions docs/docs/ref/@robojs/ai/_index.md
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)
4 changes: 4 additions & 0 deletions docs/docs/ref/@robojs/ai/typedoc-sidebar.cjs
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;
73 changes: 73 additions & 0 deletions docs/docs/ref/@robojs/analytics/Class.GoogleAnalytics.md
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`
73 changes: 73 additions & 0 deletions docs/docs/ref/@robojs/analytics/Class.ManyEngines.md
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 docs/docs/ref/@robojs/analytics/Class.PlausibleAnalytics.md
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`
Loading

0 comments on commit 26fdbe6

Please sign in to comment.