diff --git a/docs/docs/ref/@robojs/ai-voice/Function.textToSpeech.md b/docs/docs/ref/@robojs/ai-voice/Function.textToSpeech.md new file mode 100644 index 00000000..dd9fa082 --- /dev/null +++ b/docs/docs/ref/@robojs/ai-voice/Function.textToSpeech.md @@ -0,0 +1,16 @@ +# Function: textToSpeech() + +```ts +function textToSpeech(text, filePath): Promise +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `text` | `string` | +| `filePath` | `string` | + +## Returns + +`Promise`\<`string`\> diff --git a/docs/docs/ref/@robojs/ai-voice/_index.md b/docs/docs/ref/@robojs/ai-voice/_index.md new file mode 100644 index 00000000..acb4b0b4 --- /dev/null +++ b/docs/docs/ref/@robojs/ai-voice/_index.md @@ -0,0 +1,5 @@ +# @robojs/ai-voice + +## Functions + +- [textToSpeech](Function.textToSpeech.md) diff --git a/docs/docs/ref/@robojs/ai-voice/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/ai-voice/typedoc-sidebar.cjs new file mode 100644 index 00000000..bb4bab20 --- /dev/null +++ b/docs/docs/ref/@robojs/ai-voice/typedoc-sidebar.cjs @@ -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; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/ai/Function.selectOne.md b/docs/docs/ref/@robojs/ai/Function.selectOne.md new file mode 100644 index 00000000..b471dbe2 --- /dev/null +++ b/docs/docs/ref/@robojs/ai/Function.selectOne.md @@ -0,0 +1,20 @@ +# Function: selectOne() + +```ts +function selectOne( + selection, + choices, +options?): Promise +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `selection` | `string` | +| `choices` | `string`[] | +| `options`? | `SelectOneOptions` | + +## Returns + +`Promise`\<`string` \| `null`\> diff --git a/docs/docs/ref/@robojs/ai/Variable.AI.md b/docs/docs/ref/@robojs/ai/Variable.AI.md new file mode 100644 index 00000000..84b6fb7e --- /dev/null +++ b/docs/docs/ref/@robojs/ai/Variable.AI.md @@ -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; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `messages` | `ChatMessage`[] | +| `options` | `ChatOptions` | + +#### Returns + +`Promise`\<`void`\> + +### chatSync() + +```ts +chatSync: (messages, options) => Promise; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `messages` | `ChatMessage`[] | +| `options` | `Omit`\<`ChatOptions`, `"onReply"`\> | + +#### Returns + +`Promise`\<`ChatReply`\> + +### generateImage() + +```ts +generateImage: (options) => Promise; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options` | `GenerateImageOptions` | + +#### Returns + +`Promise`\<`GenerateImageResult`\> + +### isReady() + +```ts +isReady: () => boolean; +``` + +#### Returns + +`boolean` diff --git a/docs/docs/ref/@robojs/ai/_index.md b/docs/docs/ref/@robojs/ai/_index.md new file mode 100644 index 00000000..8f256c82 --- /dev/null +++ b/docs/docs/ref/@robojs/ai/_index.md @@ -0,0 +1,9 @@ +# @robojs/ai + +## Variables + +- [AI](Variable.AI.md) + +## Functions + +- [selectOne](Function.selectOne.md) diff --git a/docs/docs/ref/@robojs/ai/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/ai/typedoc-sidebar.cjs new file mode 100644 index 00000000..e5cda2d3 --- /dev/null +++ b/docs/docs/ref/@robojs/ai/typedoc-sidebar.cjs @@ -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; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/analytics/Class.GoogleAnalytics.md b/docs/docs/ref/@robojs/analytics/Class.GoogleAnalytics.md new file mode 100644 index 00000000..30ead2c9 --- /dev/null +++ b/docs/docs/ref/@robojs/analytics/Class.GoogleAnalytics.md @@ -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 +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `options`? | `EventOptions` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseEngine.event` + +*** + +### view() + +```ts +view(page, options?): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | `string` | +| `options`? | `ViewOptions` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseEngine.view` diff --git a/docs/docs/ref/@robojs/analytics/Class.ManyEngines.md b/docs/docs/ref/@robojs/analytics/Class.ManyEngines.md new file mode 100644 index 00000000..2e56e545 --- /dev/null +++ b/docs/docs/ref/@robojs/analytics/Class.ManyEngines.md @@ -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 +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `options`? | `EventOptions` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseEngine.event` + +*** + +### view() + +```ts +view(page, options?): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | `string` | +| `options`? | `ViewOptions` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseEngine.view` diff --git a/docs/docs/ref/@robojs/analytics/Class.PlausibleAnalytics.md b/docs/docs/ref/@robojs/analytics/Class.PlausibleAnalytics.md new file mode 100644 index 00000000..bb5c9570 --- /dev/null +++ b/docs/docs/ref/@robojs/analytics/Class.PlausibleAnalytics.md @@ -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 +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `options` | `EventOptions` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseEngine.event` + +*** + +### view() + +```ts +view(page, options): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | `string` | +| `options` | `ViewOptions` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseEngine.view` diff --git a/docs/docs/ref/@robojs/analytics/Variable.Analytics.md b/docs/docs/ref/@robojs/analytics/Variable.Analytics.md new file mode 100644 index 00000000..d3715664 --- /dev/null +++ b/docs/docs/ref/@robojs/analytics/Variable.Analytics.md @@ -0,0 +1,51 @@ +# Variable: Analytics + +```ts +const Analytics: Readonly; +``` + +## Type declaration + +### event() + +```ts +event: (name, options?) => void | Promise; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `options`? | `EventOptions` | + +#### Returns + +`void` \| `Promise`\<`void`\> + +### isReady() + +```ts +isReady: () => boolean; +``` + +#### Returns + +`boolean` + +### view() + +```ts +view: (page, options?) => void | Promise; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `page` | `string` | +| `options`? | `ViewOptions` | + +#### Returns + +`void` \| `Promise`\<`void`\> diff --git a/docs/docs/ref/@robojs/analytics/_index.md b/docs/docs/ref/@robojs/analytics/_index.md new file mode 100644 index 00000000..9224150a --- /dev/null +++ b/docs/docs/ref/@robojs/analytics/_index.md @@ -0,0 +1,11 @@ +# @robojs/analytics + +## Classes + +- [GoogleAnalytics](Class.GoogleAnalytics.md) +- [ManyEngines](Class.ManyEngines.md) +- [PlausibleAnalytics](Class.PlausibleAnalytics.md) + +## Variables + +- [Analytics](Variable.Analytics.md) diff --git a/docs/docs/ref/@robojs/analytics/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/analytics/typedoc-sidebar.cjs new file mode 100644 index 00000000..4f8b569a --- /dev/null +++ b/docs/docs/ref/@robojs/analytics/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Classes","items":[{"type":"doc","id":"ref/@robojs/analytics/Class.GoogleAnalytics","label":"GoogleAnalytics"},{"type":"doc","id":"ref/@robojs/analytics/Class.ManyEngines","label":"ManyEngines"},{"type":"doc","id":"ref/@robojs/analytics/Class.PlausibleAnalytics","label":"PlausibleAnalytics"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"ref/@robojs/analytics/Variable.Analytics","label":"Analytics"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/better-stack/Function.createLogtailDrain.md b/docs/docs/ref/@robojs/better-stack/Function.createLogtailDrain.md new file mode 100644 index 00000000..ecc3a2c0 --- /dev/null +++ b/docs/docs/ref/@robojs/better-stack/Function.createLogtailDrain.md @@ -0,0 +1,15 @@ +# Function: createLogtailDrain() + +```ts +function createLogtailDrain(sourceToken): LogDrain +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `sourceToken` | `string` | + +## Returns + +`LogDrain` diff --git a/docs/docs/ref/@robojs/better-stack/_index.md b/docs/docs/ref/@robojs/better-stack/_index.md new file mode 100644 index 00000000..c293e80f --- /dev/null +++ b/docs/docs/ref/@robojs/better-stack/_index.md @@ -0,0 +1,5 @@ +# @robojs/better-stack + +## Functions + +- [createLogtailDrain](Function.createLogtailDrain.md) diff --git a/docs/docs/ref/@robojs/better-stack/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/better-stack/typedoc-sidebar.cjs new file mode 100644 index 00000000..4ee464ea --- /dev/null +++ b/docs/docs/ref/@robojs/better-stack/typedoc-sidebar.cjs @@ -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/better-stack/Function.createLogtailDrain","label":"createLogtailDrain"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/cron/Function.Cron.md b/docs/docs/ref/@robojs/cron/Function.Cron.md new file mode 100644 index 00000000..54a7eedd --- /dev/null +++ b/docs/docs/ref/@robojs/cron/Function.Cron.md @@ -0,0 +1,16 @@ +# Function: Cron() + +```ts +function Cron(cronExpression, jobFunction): CronJob +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `cronExpression` | `string` | +| `jobFunction` | `string` \| () => `void` | + +## Returns + +`CronJob` diff --git a/docs/docs/ref/@robojs/cron/Variable.Patterns.md b/docs/docs/ref/@robojs/cron/Variable.Patterns.md new file mode 100644 index 00000000..63ebbbe5 --- /dev/null +++ b/docs/docs/ref/@robojs/cron/Variable.Patterns.md @@ -0,0 +1,601 @@ +# Variable: Patterns + +```ts +const Patterns: object; +``` + +## Type declaration + +### EVERY\_10\_HOURS + +```ts +EVERY_10_HOURS: EVERY_10_HOURS = '0 0-23/10 * * *'; +``` + +### EVERY\_10\_MINUTES + +```ts +EVERY_10_MINUTES: EVERY_10_MINUTES = '0 */10 * * * *'; +``` + +### EVERY\_10\_SECONDS + +```ts +EVERY_10_SECONDS: EVERY_10_SECONDS = '*/10 * * * * *'; +``` + +### EVERY\_11\_HOURS + +```ts +EVERY_11_HOURS: EVERY_11_HOURS = '0 0-23/11 * * *'; +``` + +### EVERY\_12\_HOURS + +```ts +EVERY_12_HOURS: EVERY_12_HOURS = '0 0-23/12 * * *'; +``` + +### EVERY\_1ST\_DAY\_OF\_MONTH\_AT\_MIDNIGHT + +```ts +EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT: EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT = '0 0 1 * *'; +``` + +### EVERY\_1ST\_DAY\_OF\_MONTH\_AT\_NOON + +```ts +EVERY_1ST_DAY_OF_MONTH_AT_NOON: EVERY_1ST_DAY_OF_MONTH_AT_NOON = '0 12 1 * *'; +``` + +### EVERY\_2\_HOURS + +```ts +EVERY_2_HOURS: EVERY_2_HOURS = '0 0-23/2 * * *'; +``` + +### EVERY\_2ND\_HOUR + +```ts +EVERY_2ND_HOUR: EVERY_2ND_HOUR = '0 */2 * * *'; +``` + +### EVERY\_2ND\_HOUR\_FROM\_1AM\_THROUGH\_11PM + +```ts +EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM: EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM = '0 1-23/2 * * *'; +``` + +### EVERY\_2ND\_MONTH + +```ts +EVERY_2ND_MONTH: EVERY_2ND_MONTH = '0 0 1 */2 *'; +``` + +### EVERY\_3\_HOURS + +```ts +EVERY_3_HOURS: EVERY_3_HOURS = '0 0-23/3 * * *'; +``` + +### EVERY\_30\_MINUTES + +```ts +EVERY_30_MINUTES: EVERY_30_MINUTES = '0 */30 * * * *'; +``` + +### EVERY\_30\_MINUTES\_BETWEEN\_10AM\_AND\_7PM + +```ts +EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM: EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM = '0 */30 10-19 * * *'; +``` + +### EVERY\_30\_MINUTES\_BETWEEN\_9AM\_AND\_5PM + +```ts +EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM: EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM = '0 */30 9-17 * * *'; +``` + +### EVERY\_30\_MINUTES\_BETWEEN\_9AM\_AND\_6PM + +```ts +EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM: EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM = '0 */30 9-18 * * *'; +``` + +### EVERY\_30\_SECONDS + +```ts +EVERY_30_SECONDS: EVERY_30_SECONDS = '*/30 * * * * *'; +``` + +### EVERY\_4\_HOURS + +```ts +EVERY_4_HOURS: EVERY_4_HOURS = '0 0-23/4 * * *'; +``` + +### EVERY\_5\_HOURS + +```ts +EVERY_5_HOURS: EVERY_5_HOURS = '0 0-23/5 * * *'; +``` + +### EVERY\_5\_MINUTES + +```ts +EVERY_5_MINUTES: EVERY_5_MINUTES = '0 */5 * * * *'; +``` + +### EVERY\_5\_SECONDS + +```ts +EVERY_5_SECONDS: EVERY_5_SECONDS = '*/5 * * * * *'; +``` + +### EVERY\_6\_HOURS + +```ts +EVERY_6_HOURS: EVERY_6_HOURS = '0 0-23/6 * * *'; +``` + +### EVERY\_6\_MONTHS + +```ts +EVERY_6_MONTHS: EVERY_6_MONTHS = '0 0 1 */6 *'; +``` + +### EVERY\_7\_HOURS + +```ts +EVERY_7_HOURS: EVERY_7_HOURS = '0 0-23/7 * * *'; +``` + +### EVERY\_8\_HOURS + +```ts +EVERY_8_HOURS: EVERY_8_HOURS = '0 0-23/8 * * *'; +``` + +### EVERY\_9\_HOURS + +```ts +EVERY_9_HOURS: EVERY_9_HOURS = '0 0-23/9 * * *'; +``` + +### EVERY\_DAY\_AT\_10AM + +```ts +EVERY_DAY_AT_10AM: EVERY_DAY_AT_10AM = '0 10 * * *'; +``` + +### EVERY\_DAY\_AT\_10PM + +```ts +EVERY_DAY_AT_10PM: EVERY_DAY_AT_10PM = '0 22 * * *'; +``` + +### EVERY\_DAY\_AT\_11AM + +```ts +EVERY_DAY_AT_11AM: EVERY_DAY_AT_11AM = '0 11 * * *'; +``` + +### EVERY\_DAY\_AT\_11PM + +```ts +EVERY_DAY_AT_11PM: EVERY_DAY_AT_11PM = '0 23 * * *'; +``` + +### EVERY\_DAY\_AT\_1AM + +```ts +EVERY_DAY_AT_1AM: EVERY_DAY_AT_1AM = '0 01 * * *'; +``` + +### EVERY\_DAY\_AT\_1PM + +```ts +EVERY_DAY_AT_1PM: EVERY_DAY_AT_1PM = '0 13 * * *'; +``` + +### EVERY\_DAY\_AT\_2AM + +```ts +EVERY_DAY_AT_2AM: EVERY_DAY_AT_2AM = '0 02 * * *'; +``` + +### EVERY\_DAY\_AT\_2PM + +```ts +EVERY_DAY_AT_2PM: EVERY_DAY_AT_2PM = '0 14 * * *'; +``` + +### EVERY\_DAY\_AT\_3AM + +```ts +EVERY_DAY_AT_3AM: EVERY_DAY_AT_3AM = '0 03 * * *'; +``` + +### EVERY\_DAY\_AT\_3PM + +```ts +EVERY_DAY_AT_3PM: EVERY_DAY_AT_3PM = '0 15 * * *'; +``` + +### EVERY\_DAY\_AT\_4AM + +```ts +EVERY_DAY_AT_4AM: EVERY_DAY_AT_4AM = '0 04 * * *'; +``` + +### EVERY\_DAY\_AT\_4PM + +```ts +EVERY_DAY_AT_4PM: EVERY_DAY_AT_4PM = '0 16 * * *'; +``` + +### EVERY\_DAY\_AT\_5AM + +```ts +EVERY_DAY_AT_5AM: EVERY_DAY_AT_5AM = '0 05 * * *'; +``` + +### EVERY\_DAY\_AT\_5PM + +```ts +EVERY_DAY_AT_5PM: EVERY_DAY_AT_5PM = '0 17 * * *'; +``` + +### EVERY\_DAY\_AT\_6AM + +```ts +EVERY_DAY_AT_6AM: EVERY_DAY_AT_6AM = '0 06 * * *'; +``` + +### EVERY\_DAY\_AT\_6PM + +```ts +EVERY_DAY_AT_6PM: EVERY_DAY_AT_6PM = '0 18 * * *'; +``` + +### EVERY\_DAY\_AT\_7AM + +```ts +EVERY_DAY_AT_7AM: EVERY_DAY_AT_7AM = '0 07 * * *'; +``` + +### EVERY\_DAY\_AT\_7PM + +```ts +EVERY_DAY_AT_7PM: EVERY_DAY_AT_7PM = '0 19 * * *'; +``` + +### EVERY\_DAY\_AT\_8AM + +```ts +EVERY_DAY_AT_8AM: EVERY_DAY_AT_8AM = '0 08 * * *'; +``` + +### EVERY\_DAY\_AT\_8PM + +```ts +EVERY_DAY_AT_8PM: EVERY_DAY_AT_8PM = '0 20 * * *'; +``` + +### EVERY\_DAY\_AT\_9AM + +```ts +EVERY_DAY_AT_9AM: EVERY_DAY_AT_9AM = '0 09 * * *'; +``` + +### EVERY\_DAY\_AT\_9PM + +```ts +EVERY_DAY_AT_9PM: EVERY_DAY_AT_9PM = '0 21 * * *'; +``` + +### EVERY\_DAY\_AT\_MIDNIGHT + +```ts +EVERY_DAY_AT_MIDNIGHT: EVERY_DAY_AT_MIDNIGHT = '0 0 * * *'; +``` + +### EVERY\_DAY\_AT\_NOON + +```ts +EVERY_DAY_AT_NOON: EVERY_DAY_AT_NOON = '0 12 * * *'; +``` + +### EVERY\_HOUR + +```ts +EVERY_HOUR: EVERY_HOUR = '0 0-23/1 * * *'; +``` + +### EVERY\_MINUTE + +```ts +EVERY_MINUTE: EVERY_MINUTE = '*/1 * * * *'; +``` + +### EVERY\_QUARTER + +```ts +EVERY_QUARTER: EVERY_QUARTER = '0 0 1 */3 *'; +``` + +### EVERY\_SECOND + +```ts +EVERY_SECOND: EVERY_SECOND = '* * * * * *'; +``` + +### EVERY\_WEEK + +```ts +EVERY_WEEK: EVERY_WEEK = '0 0 * * 0'; +``` + +### EVERY\_WEEKDAY + +```ts +EVERY_WEEKDAY: EVERY_WEEKDAY = '0 0 * * 1-5'; +``` + +### EVERY\_WEEKEND + +```ts +EVERY_WEEKEND: EVERY_WEEKEND = '0 0 * * 6,0'; +``` + +### EVERY\_YEAR + +```ts +EVERY_YEAR: EVERY_YEAR = '0 0 1 1 *'; +``` + +### FRIDAY + +```ts +FRIDAY: FRIDAY = 5; +``` + +### MONDAY + +```ts +MONDAY: MONDAY = 1; +``` + +### SATURDAY + +```ts +SATURDAY: SATURDAY = 6; +``` + +### SUNDAY + +```ts +SUNDAY: SUNDAY = 0; +``` + +### THURSDAY + +```ts +THURSDAY: THURSDAY = 4; +``` + +### TUESDAY + +```ts +TUESDAY: TUESDAY = 2; +``` + +### WEDNESAY + +```ts +WEDNESAY: WEDNESAY = 3; +``` + +### daily() + +Run the task every day at 00:00 +Alias: EVERY_DAY_AT_MIDNIGHT + +#### Returns + +`ConstantExpressions` + +### everyDayAt() + +Run the task every day at HH:MM + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `time`? | `string` | `'00:00'` | The time in 'HH:mm' format (24-hour clock). | + +#### Returns + +`string` + +### everyHours() + +Run the task every H hours + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `hours` | `number` | `1` | | + +#### Returns + +`string` + +### everyHoursAt() + +Run the task every H hours at M minutes + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `hours` | `number` | `undefined` | | +| `minutes` | `number` | `0` | | + +#### Returns + +`string` + +### everyMinute() + +Run the task every minute +Alias: EVERY_MINUTE + +#### Returns + +`ConstantExpressions` + +### everyMinutes() + +Run the task every M minutes + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `minutes` | `number` | `1` | | + +#### Returns + +`string` + +### everyQuarter() + +Run the task every quarter (3 months) +Alias: EVERY_QUARTER + +#### Returns + +`ConstantExpressions` + +### everySecond() + +Run the task every second +Alias: EVERY_SECOND + +#### Returns + +`ConstantExpressions` + +### everySenconds() + +Run the task every S seconds + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `seconds` | `number` | `1` | | + +#### Returns + +`string` + +### everyWeekday() + +Run the task every day from monday to friday at 00:00 +Alias: EVERY_WEEKDAY + +#### Returns + +`ConstantExpressions` + +### everyWeekdayAt() + +Run the task every day from monday to friday at given time + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `time`? | `string` | `'00:00'` | The time in 'HH:mm' format (24-hour clock). | + +#### Returns + +`string` + +### everyWeekend() + +Run the task on saturday and sunday at 00:00 +Alias: EVERY_WEEKDAY + +#### Returns + +`ConstantExpressions` + +### everyWeekendAt() + +Run the task on saturday and sunday at given time + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `time`? | `string` | `'00:00'` | The time in 'HH:mm' format (24-hour clock). | + +#### Returns + +`string` + +### everyWeekOn() + +Run the task at a specific time on a given day of the week. + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `day` | `number` | `undefined` | The day of the week (0 for Sunday, 1 for Monday, ..., 6 for Saturday). | +| `time`? | `string` | `'00:00'` | The time in 'HH:mm' format (24-hour clock). | + +#### Returns + +`string` + +### hourly() + +Run the task every hour +Alias: EVERY_HOUR + +#### Returns + +`ConstantExpressions` + +### monthly() + +Run the task every first day of month at 00:00 +Alias: EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT + +#### Returns + +`ConstantExpressions` + +### weekly() + +Run the task every week on monday at 00:00 +Alias: EVERY_WEEK + +#### Returns + +`ConstantExpressions` + +### yearly() + +Run the task on the first day of every year at 00:00 +Alias: EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT + +#### Returns + +`ConstantExpressions` diff --git a/docs/docs/ref/@robojs/cron/_index.md b/docs/docs/ref/@robojs/cron/_index.md new file mode 100644 index 00000000..02d59d16 --- /dev/null +++ b/docs/docs/ref/@robojs/cron/_index.md @@ -0,0 +1,9 @@ +# @robojs/cron + +## Variables + +- [Patterns](Variable.Patterns.md) + +## Functions + +- [Cron](Function.Cron.md) diff --git a/docs/docs/ref/@robojs/cron/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/cron/typedoc-sidebar.cjs new file mode 100644 index 00000000..2a1d5543 --- /dev/null +++ b/docs/docs/ref/@robojs/cron/typedoc-sidebar.cjs @@ -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/cron/Variable.Patterns","label":"Patterns"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"ref/@robojs/cron/Function.Cron","label":"Cron"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/moderation/Function.getLockdown.md b/docs/docs/ref/@robojs/moderation/Function.getLockdown.md new file mode 100644 index 00000000..0da740e7 --- /dev/null +++ b/docs/docs/ref/@robojs/moderation/Function.getLockdown.md @@ -0,0 +1,15 @@ +# Function: getLockdown() + +```ts +function getLockdown(guildId): LockdownData +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `guildId` | `string` | + +## Returns + +`LockdownData` diff --git a/docs/docs/ref/@robojs/moderation/_index.md b/docs/docs/ref/@robojs/moderation/_index.md new file mode 100644 index 00000000..5acfc468 --- /dev/null +++ b/docs/docs/ref/@robojs/moderation/_index.md @@ -0,0 +1,5 @@ +# @robojs/moderation + +## Functions + +- [getLockdown](Function.getLockdown.md) diff --git a/docs/docs/ref/@robojs/moderation/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/moderation/typedoc-sidebar.cjs new file mode 100644 index 00000000..17acb4d0 --- /dev/null +++ b/docs/docs/ref/@robojs/moderation/typedoc-sidebar.cjs @@ -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/moderation/Function.getLockdown","label":"getLockdown"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/patch/Variable.DiscordProxy.md b/docs/docs/ref/@robojs/patch/Variable.DiscordProxy.md new file mode 100644 index 00000000..378d448a --- /dev/null +++ b/docs/docs/ref/@robojs/patch/Variable.DiscordProxy.md @@ -0,0 +1,44 @@ +# Variable: DiscordProxy + +```ts +const DiscordProxy: object; +``` + +## Type declaration + +### patch() + +```ts +patch: () => void; +``` + +Automatically patches all internal requests when in a Discord Activity. +This updates the `fetch` and `WebSocket` APIs to always include the `/.proxy` prefix. + +Run this at the very beginning of your app to ensure all requests are proxied. + +#### Returns + +`void` + +### Vite() + +```ts +Vite: () => Plugin = VitePlugin; +``` + +Vite plugin to inject the Discord proxy patch script into the index.html. + +In development, the script loads synchronously to ensure patch is applied before Vite's HMR runs. +In production, the script is bundled into the output and referenced from the index.html. + +The patch script is equivalent to running: +```js +import { DiscordProxy } from '@robojs/patch' + +DiscordProxy.patch() +``` + +#### Returns + +`Plugin` diff --git a/docs/docs/ref/@robojs/patch/_index.md b/docs/docs/ref/@robojs/patch/_index.md new file mode 100644 index 00000000..3b225a3b --- /dev/null +++ b/docs/docs/ref/@robojs/patch/_index.md @@ -0,0 +1,5 @@ +# @robojs/patch + +## Variables + +- [DiscordProxy](Variable.DiscordProxy.md) diff --git a/docs/docs/ref/@robojs/patch/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/patch/typedoc-sidebar.cjs new file mode 100644 index 00000000..98a8413a --- /dev/null +++ b/docs/docs/ref/@robojs/patch/typedoc-sidebar.cjs @@ -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/patch/Variable.DiscordProxy","label":"DiscordProxy"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/server/Class.RoboRequest.md b/docs/docs/ref/@robojs/server/Class.RoboRequest.md new file mode 100644 index 00000000..c2efebeb --- /dev/null +++ b/docs/docs/ref/@robojs/server/Class.RoboRequest.md @@ -0,0 +1,199 @@ +# Class: RoboRequest + +Extends the [Web Request API](https://developer.mozilla.org/docs/Web/API/Request) with additional convenience methods. + +## Extends + +- `Request` + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| `[INTERNALS]` | `public` | `object` | - | - | +| `[INTERNALS].params` | `public` | `Record`\<`string`, `string`\> | - | - | +| `[INTERNALS].raw` | `public` | `IncomingMessage` | - | - | +| `body` | `readonly` | `ReadableStream`\<`Uint8Array`\> | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body) | `Request.body` | +| `bodyUsed` | `readonly` | `boolean` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) | `Request.bodyUsed` | +| `cache` | `readonly` | `RequestCache` | Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/cache) | `Request.cache` | +| `credentials` | `readonly` | `RequestCredentials` | Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/credentials) | `Request.credentials` | +| `destination` | `readonly` | `RequestDestination` | Returns the kind of resource requested by request, e.g., "document" or "script". [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/destination) | `Request.destination` | +| `headers` | `readonly` | `Headers` | Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/headers) | `Request.headers` | +| `integrity` | `readonly` | `string` | Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/integrity) | `Request.integrity` | +| `keepalive` | `readonly` | `boolean` | Returns a boolean indicating whether or not request can outlive the global in which it was created. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/keepalive) | `Request.keepalive` | +| `method` | `readonly` | `string` | Returns request's HTTP method, which is "GET" by default. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/method) | `Request.method` | +| `mode` | `readonly` | `RequestMode` | Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/mode) | `Request.mode` | +| `redirect` | `readonly` | `RequestRedirect` | Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/redirect) | `Request.redirect` | +| `referrer` | `readonly` | `string` | Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/referrer) | `Request.referrer` | +| `referrerPolicy` | `readonly` | `ReferrerPolicy` | Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/referrerPolicy) | `Request.referrerPolicy` | +| `signal` | `readonly` | `AbortSignal` | Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/signal) | `Request.signal` | +| `url` | `readonly` | `string` | Returns the URL of request as a string. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/url) | `Request.url` | + +## Accessors + +### params + +#### Get Signature + +```ts +get params(): Record +``` + +##### Returns + +`Record`\<`string`, `string`\> + +*** + +### query + +#### Get Signature + +```ts +get query(): Record +``` + +##### Returns + +`Record`\<`string`, `string` \| `string`[]\> + +*** + +### raw + +#### Get Signature + +```ts +get raw(): IncomingMessage +``` + +##### Returns + +`IncomingMessage` + +## Methods + +### arrayBuffer() + +```ts +arrayBuffer(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) + +#### Returns + +`Promise`\<`ArrayBuffer`\> + +#### Inherited from + +`Request.arrayBuffer` + +*** + +### blob() + +```ts +blob(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) + +#### Returns + +`Promise`\<`Blob`\> + +#### Inherited from + +`Request.blob` + +*** + +### clone() + +```ts +clone(): Request +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/clone) + +#### Returns + +`Request` + +#### Inherited from + +`Request.clone` + +*** + +### formData() + +```ts +formData(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/formData) + +#### Returns + +`Promise`\<`FormData`\> + +#### Inherited from + +`Request.formData` + +*** + +### json() + +```ts +json(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json) + +#### Returns + +`Promise`\<`any`\> + +#### Inherited from + +`Request.json` + +*** + +### text() + +```ts +text(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/text) + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +`Request.text` + +*** + +### from() + +```ts +static from(req, options?): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `req` | `IncomingMessage` | +| `options`? | `FromOptions` | + +#### Returns + +`Promise`\<[`RoboRequest`](Class.RoboRequest.md)\> diff --git a/docs/docs/ref/@robojs/server/Class.RoboResponse.md b/docs/docs/ref/@robojs/server/Class.RoboResponse.md new file mode 100644 index 00000000..04e2bcc4 --- /dev/null +++ b/docs/docs/ref/@robojs/server/Class.RoboResponse.md @@ -0,0 +1,226 @@ +# Class: RoboResponse + +Extends the [Web Response API](https://developer.mozilla.org/docs/Web/API/Response) with additional convenience methods. + +## Extends + +- `Response` + +## Constructors + +### new RoboResponse() + +```ts +new RoboResponse(body?, init?): RoboResponse +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `body`? | `BodyInit` | +| `init`? | `ResponseInit` | + +#### Returns + +[`RoboResponse`](Class.RoboResponse.md) + +#### Overrides + +`Response.constructor` + +## Properties + +| Property | Modifier | Type | Description | Inherited from | +| ------ | ------ | ------ | ------ | ------ | +| `body` | `readonly` | `ReadableStream`\<`Uint8Array`\> | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body) | `Response.body` | +| `bodyUsed` | `readonly` | `boolean` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) | `Response.bodyUsed` | +| `headers` | `readonly` | `Headers` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/headers) | `Response.headers` | +| `ok` | `readonly` | `boolean` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/ok) | `Response.ok` | +| `redirected` | `readonly` | `boolean` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirected) | `Response.redirected` | +| `status` | `readonly` | `number` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/status) | `Response.status` | +| `statusText` | `readonly` | `string` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/statusText) | `Response.statusText` | +| `type` | `readonly` | `ResponseType` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/type) | `Response.type` | +| `url` | `readonly` | `string` | [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/url) | `Response.url` | + +## Methods + +### arrayBuffer() + +```ts +arrayBuffer(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) + +#### Returns + +`Promise`\<`ArrayBuffer`\> + +#### Inherited from + +`Response.arrayBuffer` + +*** + +### blob() + +```ts +blob(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) + +#### Returns + +`Promise`\<`Blob`\> + +#### Inherited from + +`Response.blob` + +*** + +### clone() + +```ts +clone(): Response +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/clone) + +#### Returns + +`Response` + +#### Inherited from + +`Response.clone` + +*** + +### formData() + +```ts +formData(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/formData) + +#### Returns + +`Promise`\<`FormData`\> + +#### Inherited from + +`Response.formData` + +*** + +### json() + +```ts +json(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json) + +#### Returns + +`Promise`\<`any`\> + +#### Inherited from + +`Response.json` + +*** + +### text() + +```ts +text(): Promise +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/text) + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +`Response.text` + +*** + +### error() + +```ts +static error(): Response +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/error_static) + +#### Returns + +`Response` + +#### Inherited from + +`Response.error` + +*** + +### json() + +```ts +static json(body, init?): RoboResponse +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/json_static) + +#### Type Parameters + +| Type Parameter | +| ------ | +| `JsonBody` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `body` | `JsonBody` | +| `init`? | `ResponseInit` | + +#### Returns + +[`RoboResponse`](Class.RoboResponse.md) + +#### Overrides + +`Response.json` + +*** + +### redirect() + +```ts +static redirect(url, status?): Response +``` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirect_static) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `url` | `string` \| `URL` | +| `status`? | `number` | + +#### Returns + +`Response` + +#### Inherited from + +`Response.redirect` diff --git a/docs/docs/ref/@robojs/server/Function.getServerEngine.md b/docs/docs/ref/@robojs/server/Function.getServerEngine.md new file mode 100644 index 00000000..8b912fb8 --- /dev/null +++ b/docs/docs/ref/@robojs/server/Function.getServerEngine.md @@ -0,0 +1,15 @@ +# Function: getServerEngine() + +```ts +function getServerEngine(): T +``` + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `T` *extends* `BaseEngine` | `BaseEngine` | + +## Returns + +`T` diff --git a/docs/docs/ref/@robojs/server/Function.ready.md b/docs/docs/ref/@robojs/server/Function.ready.md new file mode 100644 index 00000000..36b49d13 --- /dev/null +++ b/docs/docs/ref/@robojs/server/Function.ready.md @@ -0,0 +1,11 @@ +# Function: ready() + +```ts +function ready(): Promise +``` + +Returns a promise that resolves when the plugin is all set up. + +## Returns + +`Promise`\<`void`\> diff --git a/docs/docs/ref/@robojs/server/Interface.Api.md b/docs/docs/ref/@robojs/server/Interface.Api.md new file mode 100644 index 00000000..299f180c --- /dev/null +++ b/docs/docs/ref/@robojs/server/Interface.Api.md @@ -0,0 +1,20 @@ +# Interface: Api + +## Properties + +### default() + +```ts +default: (request, reply) => unknown; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `request` | [`RoboRequest`](Class.RoboRequest.md) | +| `reply` | [`RoboReply`](Interface.RoboReply.md) | + +#### Returns + +`unknown` diff --git a/docs/docs/ref/@robojs/server/Interface.ApiEntry.md b/docs/docs/ref/@robojs/server/Interface.ApiEntry.md new file mode 100644 index 00000000..8056dc4c --- /dev/null +++ b/docs/docs/ref/@robojs/server/Interface.ApiEntry.md @@ -0,0 +1,90 @@ +# Interface: ApiEntry + +## Extends + +- `BaseConfig` + +## Properties + +### \_\_auto? + +```ts +optional __auto: true; +``` + +#### Inherited from + +`BaseConfig.__auto` + +*** + +### \_\_module? + +```ts +optional __module: string; +``` + +#### Inherited from + +`BaseConfig.__module` + +*** + +### \_\_path? + +```ts +optional __path: string; +``` + +#### Inherited from + +`BaseConfig.__path` + +*** + +### \_\_plugin? + +```ts +optional __plugin: object; +``` + +| Name | Type | +| ------ | ------ | +| `name` | `string` | +| `path` | `string` | + +#### Inherited from + +`BaseConfig.__plugin` + +*** + +### description? + +```ts +optional description: string; +``` + +#### Inherited from + +`BaseConfig.description` + +*** + +### subroutes? + +```ts +optional subroutes: Record; +``` + +*** + +### timeout? + +```ts +optional timeout: number; +``` + +#### Inherited from + +`BaseConfig.timeout` diff --git a/docs/docs/ref/@robojs/server/Interface.RoboReply.md b/docs/docs/ref/@robojs/server/Interface.RoboReply.md new file mode 100644 index 00000000..203c6329 --- /dev/null +++ b/docs/docs/ref/@robojs/server/Interface.RoboReply.md @@ -0,0 +1,90 @@ +# Interface: RoboReply + +## Properties + +### code() + +```ts +code: (statusCode) => RoboReply; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `statusCode` | `number` | + +#### Returns + +[`RoboReply`](Interface.RoboReply.md) + +*** + +### hasSent + +```ts +hasSent: boolean; +``` + +*** + +### header() + +```ts +header: (name, value) => RoboReply; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `name` | `string` | +| `value` | `string` | + +#### Returns + +[`RoboReply`](Interface.RoboReply.md) + +*** + +### json() + +```ts +json: (data) => RoboReply; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `unknown` | + +#### Returns + +[`RoboReply`](Interface.RoboReply.md) + +*** + +### raw + +```ts +raw: ServerResponse; +``` + +*** + +### send() + +```ts +send: (response) => RoboReply; +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `response` | `Response` \| `BodyInit` | + +#### Returns + +[`RoboReply`](Interface.RoboReply.md) diff --git a/docs/docs/ref/@robojs/server/TypeAlias.HttpMethod.md b/docs/docs/ref/@robojs/server/TypeAlias.HttpMethod.md new file mode 100644 index 00000000..97bda429 --- /dev/null +++ b/docs/docs/ref/@robojs/server/TypeAlias.HttpMethod.md @@ -0,0 +1,12 @@ +# Type Alias: HttpMethod + +```ts +type HttpMethod: + | "GET" + | "POST" + | "PUT" + | "DELETE" + | "PATCH" + | "OPTIONS" + | "HEAD"; +``` diff --git a/docs/docs/ref/@robojs/server/TypeAlias.RouteHandler.md b/docs/docs/ref/@robojs/server/TypeAlias.RouteHandler.md new file mode 100644 index 00000000..10d70634 --- /dev/null +++ b/docs/docs/ref/@robojs/server/TypeAlias.RouteHandler.md @@ -0,0 +1,16 @@ +# Type Alias: RouteHandler() + +```ts +type RouteHandler: (req, res) => unknown | Promise; +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `req` | [`RoboRequest`](Class.RoboRequest.md) | +| `res` | [`RoboReply`](Interface.RoboReply.md) | + +## Returns + +`unknown` \| `Promise`\<`unknown`\> diff --git a/docs/docs/ref/@robojs/server/TypeAlias.WebSocketHandler.md b/docs/docs/ref/@robojs/server/TypeAlias.WebSocketHandler.md new file mode 100644 index 00000000..cfa1f8fe --- /dev/null +++ b/docs/docs/ref/@robojs/server/TypeAlias.WebSocketHandler.md @@ -0,0 +1,17 @@ +# Type Alias: WebSocketHandler() + +```ts +type WebSocketHandler: (req, socket, head) => void; +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `req` | `IncomingMessage` | +| `socket` | `Duplex` | +| `head` | `Buffer` | + +## Returns + +`void` diff --git a/docs/docs/ref/@robojs/server/Variable.Server.md b/docs/docs/ref/@robojs/server/Variable.Server.md new file mode 100644 index 00000000..9f06f739 --- /dev/null +++ b/docs/docs/ref/@robojs/server/Variable.Server.md @@ -0,0 +1,41 @@ +# Variable: Server + +```ts +const Server: object; +``` + +Use this to interact with the server. + +## Type declaration + +### config() + +```ts +config: () => unknown; +``` + +#### Returns + +`unknown` + +### get() + +```ts +get: () => any; +``` + +#### Returns + +`any` + +### ready() + +```ts +ready: () => Promise; +``` + +Returns a promise that resolves when the server is all set up. + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/docs/ref/@robojs/server/_index.md b/docs/docs/ref/@robojs/server/_index.md new file mode 100644 index 00000000..0799eca3 --- /dev/null +++ b/docs/docs/ref/@robojs/server/_index.md @@ -0,0 +1,27 @@ +# @robojs/server + +## Classes + +- [RoboRequest](Class.RoboRequest.md) +- [RoboResponse](Class.RoboResponse.md) + +## Interfaces + +- [Api](Interface.Api.md) +- [ApiEntry](Interface.ApiEntry.md) +- [RoboReply](Interface.RoboReply.md) + +## Type Aliases + +- [HttpMethod](TypeAlias.HttpMethod.md) +- [RouteHandler](TypeAlias.RouteHandler.md) +- [WebSocketHandler](TypeAlias.WebSocketHandler.md) + +## Variables + +- [Server](Variable.Server.md) + +## Functions + +- [getServerEngine](Function.getServerEngine.md) +- [ready](Function.ready.md) diff --git a/docs/docs/ref/@robojs/server/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/server/typedoc-sidebar.cjs new file mode 100644 index 00000000..80ab622e --- /dev/null +++ b/docs/docs/ref/@robojs/server/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Classes","items":[{"type":"doc","id":"ref/@robojs/server/Class.RoboRequest","label":"RoboRequest"},{"type":"doc","id":"ref/@robojs/server/Class.RoboResponse","label":"RoboResponse"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"ref/@robojs/server/Interface.Api","label":"Api"},{"type":"doc","id":"ref/@robojs/server/Interface.ApiEntry","label":"ApiEntry"},{"type":"doc","id":"ref/@robojs/server/Interface.RoboReply","label":"RoboReply"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"ref/@robojs/server/TypeAlias.HttpMethod","label":"HttpMethod"},{"type":"doc","id":"ref/@robojs/server/TypeAlias.RouteHandler","label":"RouteHandler"},{"type":"doc","id":"ref/@robojs/server/TypeAlias.WebSocketHandler","label":"WebSocketHandler"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"ref/@robojs/server/Variable.Server","label":"Server"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"ref/@robojs/server/Function.getServerEngine","label":"getServerEngine"},{"type":"doc","id":"ref/@robojs/server/Function.ready","label":"ready"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/sync/Function.SyncContextProvider.md b/docs/docs/ref/@robojs/sync/Function.SyncContextProvider.md new file mode 100644 index 00000000..030c650e --- /dev/null +++ b/docs/docs/ref/@robojs/sync/Function.SyncContextProvider.md @@ -0,0 +1,15 @@ +# Function: SyncContextProvider() + +```ts +function SyncContextProvider(props): Element +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | `SyncContextProviderProps` | + +## Returns + +`Element` diff --git a/docs/docs/ref/@robojs/sync/Function.useSyncState.md b/docs/docs/ref/@robojs/sync/Function.useSyncState.md new file mode 100644 index 00000000..8cfc7590 --- /dev/null +++ b/docs/docs/ref/@robojs/sync/Function.useSyncState.md @@ -0,0 +1,22 @@ +# Function: useSyncState() + +```ts +function useSyncState(initialState, key): readonly [T, (newState) => void] +``` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `initialState` | `T` | +| `key` | (`null` \| `string`)[] | + +## Returns + +readonly [`T`, (`newState`) => `void`] diff --git a/docs/docs/ref/@robojs/sync/Interface.MessagePayload.md b/docs/docs/ref/@robojs/sync/Interface.MessagePayload.md new file mode 100644 index 00000000..1856d16b --- /dev/null +++ b/docs/docs/ref/@robojs/sync/Interface.MessagePayload.md @@ -0,0 +1,37 @@ +# Interface: MessagePayload\ + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `T` | `unknown` \| `undefined` | + +## Properties + +### data + +```ts +data: T; +``` + +*** + +### key? + +```ts +optional key: string[]; +``` + +*** + +### type + +```ts +type: + | "get" + | "off" + | "on" + | "ping" + | "pong" + | "update"; +``` diff --git a/docs/docs/ref/@robojs/sync/_index.md b/docs/docs/ref/@robojs/sync/_index.md new file mode 100644 index 00000000..b83eb93e --- /dev/null +++ b/docs/docs/ref/@robojs/sync/_index.md @@ -0,0 +1,10 @@ +# @robojs/sync + +## Interfaces + +- [MessagePayload](Interface.MessagePayload.md) + +## Functions + +- [SyncContextProvider](Function.SyncContextProvider.md) +- [useSyncState](Function.useSyncState.md) diff --git a/docs/docs/ref/@robojs/sync/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/sync/typedoc-sidebar.cjs new file mode 100644 index 00000000..1738713f --- /dev/null +++ b/docs/docs/ref/@robojs/sync/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"ref/@robojs/sync/Interface.MessagePayload","label":"MessagePayload"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"ref/@robojs/sync/Function.SyncContextProvider","label":"SyncContextProvider"},{"type":"doc","id":"ref/@robojs/sync/Function.useSyncState","label":"useSyncState"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/ref/@robojs/trpc/Function.TRPCProvider.md b/docs/docs/ref/@robojs/trpc/Function.TRPCProvider.md new file mode 100644 index 00000000..245229f2 --- /dev/null +++ b/docs/docs/ref/@robojs/trpc/Function.TRPCProvider.md @@ -0,0 +1,15 @@ +# Function: TRPCProvider() + +```ts +function TRPCProvider(props): Element +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | `TRPCProviderProps` | + +## Returns + +`Element` diff --git a/docs/docs/ref/@robojs/trpc/Function.createTRPCClient.md b/docs/docs/ref/@robojs/trpc/Function.createTRPCClient.md new file mode 100644 index 00000000..c84ac734 --- /dev/null +++ b/docs/docs/ref/@robojs/trpc/Function.createTRPCClient.md @@ -0,0 +1,21 @@ +# Function: createTRPCClient() + +```ts +function createTRPCClient(opts): CreateTRPCClient +``` + +## Type Parameters + +| Type Parameter | +| ------ | +| `AppRouter` *extends* `Router`\<`object`, `object`\> | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts` | `CreateTRPCClientOptions`\<`AppRouter`\> | + +## Returns + +`CreateTRPCClient`\<`AppRouter`\> diff --git a/docs/docs/ref/@robojs/trpc/Function.createTRPCReact.md b/docs/docs/ref/@robojs/trpc/Function.createTRPCReact.md new file mode 100644 index 00000000..10e35cec --- /dev/null +++ b/docs/docs/ref/@robojs/trpc/Function.createTRPCReact.md @@ -0,0 +1,22 @@ +# Function: createTRPCReact() + +```ts +function createTRPCReact(options?): CreateTRPCReact +``` + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `TRouter` *extends* `AnyRouter` | - | +| `TSSRContext` | `unknown` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `options`? | `CreateTRPCReactOptions`\<`TRouter`\> | + +## Returns + +`CreateTRPCReact`\<`TRouter`, `TSSRContext`\> diff --git a/docs/docs/ref/@robojs/trpc/Function.httpBatchLink.md b/docs/docs/ref/@robojs/trpc/Function.httpBatchLink.md new file mode 100644 index 00000000..0fb05320 --- /dev/null +++ b/docs/docs/ref/@robojs/trpc/Function.httpBatchLink.md @@ -0,0 +1,25 @@ +# Function: httpBatchLink() + +```ts +function httpBatchLink(opts): TRPCLink +``` + +## Type Parameters + +| Type Parameter | +| ------ | +| `TRouter` *extends* `AnyRouter` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts` | `HTTPBatchLinkOptions`\<`TRouter`\[`"_def"`\]\[`"_config"`\]\[`"$types"`\]\> | + +## Returns + +`TRPCLink`\<`TRouter`\> + +## See + +https://trpc.io/docs/client/links/httpBatchLink diff --git a/docs/docs/ref/@robojs/trpc/Interface.Context.md b/docs/docs/ref/@robojs/trpc/Interface.Context.md new file mode 100644 index 00000000..bf12d7b6 --- /dev/null +++ b/docs/docs/ref/@robojs/trpc/Interface.Context.md @@ -0,0 +1,17 @@ +# Interface: Context + +## Properties + +### req + +```ts +req: RoboRequest; +``` + +*** + +### res + +```ts +res: RoboReply; +``` diff --git a/docs/docs/ref/@robojs/trpc/_index.md b/docs/docs/ref/@robojs/trpc/_index.md new file mode 100644 index 00000000..67f68953 --- /dev/null +++ b/docs/docs/ref/@robojs/trpc/_index.md @@ -0,0 +1,12 @@ +# @robojs/trpc + +## Interfaces + +- [Context](Interface.Context.md) + +## Functions + +- [createTRPCClient](Function.createTRPCClient.md) +- [createTRPCReact](Function.createTRPCReact.md) +- [httpBatchLink](Function.httpBatchLink.md) +- [TRPCProvider](Function.TRPCProvider.md) diff --git a/docs/docs/ref/@robojs/trpc/typedoc-sidebar.cjs b/docs/docs/ref/@robojs/trpc/typedoc-sidebar.cjs new file mode 100644 index 00000000..3d842aeb --- /dev/null +++ b/docs/docs/ref/@robojs/trpc/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"ref/@robojs/trpc/Interface.Context","label":"Context"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"ref/@robojs/trpc/Function.createTRPCClient","label":"createTRPCClient"},{"type":"doc","id":"ref/@robojs/trpc/Function.createTRPCReact","label":"createTRPCReact"},{"type":"doc","id":"ref/@robojs/trpc/Function.httpBatchLink","label":"httpBatchLink"},{"type":"doc","id":"ref/@robojs/trpc/Function.TRPCProvider","label":"TRPCProvider"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/ref/framework/Class.Env.md b/docs/docs/ref/framework/Class.Env.md index 66b7a070..c69da6d5 100644 --- a/docs/docs/ref/framework/Class.Env.md +++ b/docs/docs/ref/framework/Class.Env.md @@ -32,7 +32,7 @@ Creates a new instance of the Env class with the specified schema with type-chec ```ts const env = new Env({ discord: { - clientId: { env: 'DISCORD_CLIENT_ID' } + clientId: { env: 'DISCORD_CLIENT_ID' } }, example: { default: 'This is an example', diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 05f37f3f..3b446be8 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -7,6 +7,23 @@ const { themes } = require('prism-react-renderer') const lightCodeTheme = themes.github const darkCodeTheme = themes.dracula +const typedocConfig = { + useCodeBlocks: true, + disableSources: true, + entryFileName: '_index', + flattenOutputFiles: true, + readme: 'none', + interfacePropertiesFormat: 'list', + skipErrorChecking: true, + classPropertiesFormat: 'table', + enumMembersFormat: 'table', + parametersFormat: 'table', + expandObjects: false, + expandParameters: false, + typeDeclarationFormat: 'list', + propertyMembersFormat: 'table' +} + /** @type {import('@docusaurus/types').Config} */ const config = { title: 'Robo.js', @@ -366,23 +383,131 @@ const config = { [ 'docusaurus-plugin-typedoc', { + id: 'robo.js', entryPoints: ['../packages/robo/src/index.ts'], out: 'docs/ref/framework', tsconfig: '../packages/robo/tsconfig.json', - useCodeBlocks: true, - disableSources: true, - entryFileName: '_index', - flattenOutputFiles: true, - readme: 'none', - interfacePropertiesFormat: 'list', - skipErrorChecking: true, - classPropertiesFormat: 'table', - enumMembersFormat: 'table', - parametersFormat: 'table', - expandObjects: false, - expandParameters: false, - typeDeclarationFormat: 'list', - propertyMembersFormat: 'table' + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/ai', + entryPoints: ['../packages/plugin-ai/src/index.ts'], + out: 'docs/ref/@robojs/ai', + tsconfig: '../packages/plugin-ai/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/ai-voice', + entryPoints: ['../packages/plugin-ai-voice/src/index.ts'], + out: 'docs/ref/@robojs/ai-voice', + tsconfig: '../packages/plugin-ai-voice/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/analytics', + entryPoints: ['../packages/@robojs/analytics/src/index.ts'], + out: 'docs/ref/@robojs/analytics', + tsconfig: '../packages/@robojs/analytics/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/better-stack', + entryPoints: ['../packages/plugin-better-stack/src/index.ts'], + out: 'docs/ref/@robojs/better-stack', + tsconfig: '../packages/plugin-better-stack/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/cron', + entryPoints: ['../packages/@robojs/cron/src/index.ts'], + out: 'docs/ref/@robojs/cron', + tsconfig: '../packages/@robojs/cron/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/dev', + entryPoints: ['../packages/plugin-devtools/src/index.ts'], + out: 'docs/ref/@robojs/dev', + tsconfig: '../packages/plugin-devtools/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/maintenance', + entryPoints: ['../packages/plugin-maintenance/src/index.ts'], + out: 'docs/ref/@robojs/maintenance', + tsconfig: '../packages/@robojs/analytics/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/moderation', + entryPoints: ['../packages/plugin-modtools/src/index.ts'], + out: 'docs/ref/@robojs/moderation', + tsconfig: '../packages/plugin-modtools/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/patch', + entryPoints: ['../packages/@robojs/patch/src/index.ts'], + out: 'docs/ref/@robojs/patch', + tsconfig: '../packages/@robojs/patch/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/server', + entryPoints: ['../packages/plugin-api/src/index.ts'], + out: 'docs/ref/@robojs/server', + tsconfig: '../packages/plugin-api/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/sync', + entryPoints: ['../packages/plugin-sync/src/index.ts'], + out: 'docs/ref/@robojs/sync', + tsconfig: '../packages/plugin-sync/tsconfig.json', + ...typedocConfig + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: '@robojs/trpc', + entryPoints: ['../packages/@robojs/trpc/src/index.ts'], + out: 'docs/ref/@robojs/trpc', + tsconfig: '../packages/@robojs/trpc/tsconfig.json', + ...typedocConfig } ] ], diff --git a/docs/sidebars.js b/docs/sidebars.js index d402f8ea..28a245e5 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -351,6 +351,201 @@ const sidebars = { type: 'doc' } ] + }, + { + type: 'html', + value: 'Plugins', + className: 'sidebar-title' + }, + { + type: 'category', + label: '@robojs/ai', + items: [ + { + id: 'ref/@robojs/ai/Variable.AI', + label: 'AI', + type: 'doc' + }, + { + id: 'ref/@robojs/ai/Function.selectOne', + label: 'selectOne', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/ai-voice', + items: [ + { + id: 'ref/@robojs/ai-voice/Function.textToSpeech', + label: 'textToSpeech', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/analytics', + items: [ + { + id: 'ref/@robojs/analytics/Variable.Analytics', + label: 'Analytics', + type: 'doc' + }, + { + id: 'ref/@robojs/analytics/Class.GoogleAnalytics', + label: 'GoogleAnalytics', + type: 'doc' + }, + { + id: 'ref/@robojs/analytics/Class.ManyEngines', + label: 'ManyEngines', + type: 'doc' + }, + { + id: 'ref/@robojs/analytics/Class.PlausibleAnalytics', + label: 'PlausibleAnalytics', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/better-stack', + items: [ + { + id: 'ref/@robojs/better-stack/Function.createLogtailDrain', + label: 'createLogtailDrain', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/cron', + items: [ + { + id: 'ref/@robojs/cron/Function.Cron', + label: 'Cron', + type: 'doc' + }, + { + id: 'ref/@robojs/cron/Variable.Patterns', + label: 'Patterns', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/moderation', + items: [ + { + id: 'ref/@robojs/moderation/Function.getLockdown', + label: 'getLockdown', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/patch', + items: [ + { + id: 'ref/@robojs/patch/Variable.DiscordProxy', + label: 'DiscordProxy', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/server', + items: [ + { + id: 'ref/@robojs/server/Function.getServerEngine', + label: 'getServerEngine', + type: 'doc' + }, + { + id: 'ref/@robojs/server/Function.ready', + label: 'ready', + type: 'doc' + }, + { + id: 'ref/@robojs/server/Interface.RoboReply', + label: 'RoboReply', + type: 'doc' + }, + { + id: 'ref/@robojs/server/Class.RoboRequest', + label: 'RoboRequest', + type: 'doc' + }, + { + id: 'ref/@robojs/server/Class.RoboResponse', + label: 'RoboResponse', + type: 'doc' + }, + { + id: 'ref/@robojs/server/Variable.Server', + label: 'Server', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/sync', + items: [ + { + id: 'ref/@robojs/sync/Interface.MessagePayload', + label: 'MessagePayload', + type: 'doc' + }, + { + id: 'ref/@robojs/sync/Function.SyncContextProvider', + label: 'SyncContextProvider', + type: 'doc' + }, + { + id: 'ref/@robojs/sync/Function.useSyncState', + label: 'useSyncState', + type: 'doc' + } + ] + }, + { + type: 'category', + label: '@robojs/trpc', + items: [ + { + id: 'ref/@robojs/trpc/Interface.Context', + label: 'Context', + type: 'doc' + }, + { + id: 'ref/@robojs/trpc/Function.createTRPCClient', + label: 'createTRPCClient', + type: 'doc' + }, + { + id: 'ref/@robojs/trpc/Function.createTRPCReact', + label: 'createTRPCReact', + type: 'doc' + }, + { + id: 'ref/@robojs/trpc/Function.httpBatchLink', + label: 'httpBatchLink', + type: 'doc' + }, + { + id: 'ref/@robojs/trpc/Function.TRPCProvider', + label: 'TRPCProvider', + type: 'doc' + } + ] } ] } diff --git a/packages/robo/src/core/env.ts b/packages/robo/src/core/env.ts index a88b4e23..0cdca86a 100644 --- a/packages/robo/src/core/env.ts +++ b/packages/robo/src/core/env.ts @@ -76,7 +76,7 @@ export class Env { * ```ts * const env = new Env({ * discord: { - * clientId: { env: 'DISCORD_CLIENT_ID' } + * clientId: { env: 'DISCORD_CLIENT_ID' } * }, * example: { * default: 'This is an example',