definePlugin()

Function exported by @botmesh/core.

function definePlugin<TConfig>(spec): PluginSpec<TConfig>;

Defined in: plugins/definePlugin.ts:62

Types a plugin spec (it returns spec unchanged). install() must be synchronous.

Type Parameters

Type Parameter	Default type
TConfig	Record<string, unknown>

Parameters

Parameter	Type
spec	PluginSpec<TConfig>

Returns

PluginSpec<TConfig>

Example

const greeter = definePlugin<{ text?: string }>({
  name: 'greeter',
  version: '1.0.0',
  install({ bot }, config) {
    bot.when('hello', (ctx) => ctx.reply(config?.text ?? 'Hi!'))
  },
})

bot.plug(greeter, { text: 'Welcome!' })