simplex-chat-nodejs: typed DbConfig (#6875)

* simplex-chat-nodejs: typed DbConfig for ChatApi.init and BotDbOpts

* simplex-chat-nodejs: regenerate typedoc docs for DbConfig

* simplex-chat-nodejs: rename DbConfig.kind to .type
This commit is contained in:
sh
2026-04-24 15:43:43 +00:00
committed by GitHub
parent ac0176fa0b
commit 42dd36bf09
22 changed files with 485 additions and 239 deletions
@@ -6,43 +6,43 @@
# Interface: BotConfig
Defined in: [src/bot.ts:37](../src/bot.ts#L37)
Defined in: [src/bot.ts:35](../src/bot.ts#L35)
## Properties
### dbOpts
> **dbOpts**: [`BotDbOpts`](bot.Interface.BotDbOpts.md)
> **dbOpts**: [`BotDbOpts`](bot.TypeAlias.BotDbOpts.md)
Defined in: [src/bot.ts:39](../src/bot.ts#L39)
Defined in: [src/bot.ts:37](../src/bot.ts#L37)
***
### events?
> `optional` **events**: [`EventSubscribers`](api.TypeAlias.EventSubscribers.md)
> `optional` **events?**: [`EventSubscribers`](api.TypeAlias.EventSubscribers.md)
Defined in: [src/bot.ts:46](../src/bot.ts#L46)
Defined in: [src/bot.ts:44](../src/bot.ts#L44)
***
### onCommands?
> `optional` **onCommands**: \{\[`key`: `string`\]: (`chatItem`, `command`) => `void` \| `Promise`\<`void`\> \| `undefined`; \}
> `optional` **onCommands?**: `object`
Defined in: [src/bot.ts:43](../src/bot.ts#L43)
Defined in: [src/bot.ts:41](../src/bot.ts#L41)
#### Index Signature
\[`key`: `string`\]: (`chatItem`, `command`) => `void` \| `Promise`\<`void`\> \| `undefined`
\[`key`: `string`\]: ((`chatItem`, `command`) => `void` \| `Promise`\<`void`\>) \| `undefined`
***
### onMessage()?
### onMessage?
> `optional` **onMessage**: (`chatItem`, `content`) => `void` \| `Promise`\<`void`\>
> `optional` **onMessage?**: (`chatItem`, `content`) => `void` \| `Promise`\<`void`\>
Defined in: [src/bot.ts:41](../src/bot.ts#L41)
Defined in: [src/bot.ts:39](../src/bot.ts#L39)
#### Parameters
@@ -64,7 +64,7 @@ Defined in: [src/bot.ts:41](../src/bot.ts#L41)
> **options**: [`BotOptions`](bot.Interface.BotOptions.md)
Defined in: [src/bot.ts:40](../src/bot.ts#L40)
Defined in: [src/bot.ts:38](../src/bot.ts#L38)
***
@@ -72,4 +72,4 @@ Defined in: [src/bot.ts:40](../src/bot.ts#L40)
> **profile**: `Profile`
Defined in: [src/bot.ts:38](../src/bot.ts#L38)
Defined in: [src/bot.ts:36](../src/bot.ts#L36)