createTestBot()

Call Signature

function createTestBot(config?, options?): Promise<TestBot>;

Defined in: testing/createTestBot.ts:90 Starts a Bot on a MockProvider: no network and no phone. Resolves to the bot, the provider and chat helpers that send inbound messages and check the replies. options.chaos wraps the provider in a ChaosProvider.

Parameters

Parameter	Type
`config?`	`Omit`<`BotConfig`, `"provider"`>
`options?`	`CreateTestBotOptions` & `object`

Returns

Promise<TestBot>

Example

import { createTestBot } from '@botmesh/core/testing'

const { bot, chat } = await createTestBot()
bot.when('hi', (ctx) => ctx.reply('Hello!'))

await chat.send('hi')
await chat.expectReply('Hello!')
await bot.stop()

Call Signature

function createTestBot(config, options): Promise<TestBot & object>;

Defined in: testing/createTestBot.ts:91 Starts a Bot on a MockProvider: no network and no phone. Resolves to the bot, the provider and chat helpers that send inbound messages and check the replies. options.chaos wraps the provider in a ChaosProvider.

Parameters

Parameter	Type
`config`	\| `Omit`<`BotConfig`, `"provider"`> \| `undefined`
`options`	`CreateTestBotOptions` & `object`

Returns

Promise<TestBot & object>

Example

import { createTestBot } from '@botmesh/core/testing'

const { bot, chat } = await createTestBot()
bot.when('hi', (ctx) => ctx.reply('Hello!'))

await chat.send('hi')
await chat.expectReply('Hello!')
await bot.stop()

Call Signature

function createTestBot(factory, options?): Promise<TestBot>;

Defined in: testing/createTestBot.ts:111 Test the bot a defineBot factory builds: the factory is called with the MockProvider (or its chaos wrapper) and the bot it returns is started.

Parameters

Parameter	Type
`factory`	`BotFactory`
`options?`	`CreateTestBotOptions` & `object`

Returns

Promise<TestBot>

Example

import createBot from '../src/bot.js'

const { bot, chat } = await createTestBot(createBot)
await chat.send('hola')
await chat.expectReply(/Hola/)
await bot.stop()

Throws

when the factory does not return a Bot built around the provider it was given.

Call Signature

function createTestBot(factory, options): Promise<TestBot & object>;

Defined in: testing/createTestBot.ts:112 Starts a Bot on a MockProvider: no network and no phone. Resolves to the bot, the provider and chat helpers that send inbound messages and check the replies. options.chaos wraps the provider in a ChaosProvider.

Parameters

Parameter	Type
`factory`	`BotFactory`
`options`	`CreateTestBotOptions` & `object`

Returns

Promise<TestBot & object>

Example

import { createTestBot } from '@botmesh/core/testing'

const { bot, chat } = await createTestBot()
bot.when('hi', (ctx) => ctx.reply('Hello!'))

await chat.send('hi')
await chat.expectReply('Hello!')
await bot.stop()

​Call Signature

​Parameters

​Returns

​Example

​Call Signature

​Parameters

​Returns

​Example

​Call Signature

​Parameters

​Returns

​Example

​Throws

​Call Signature

​Parameters

​Returns

​Example

Call Signature

Parameters

Returns

Example

Call Signature

Parameters

Returns

Example

Call Signature

Parameters

Returns

Example

Throws

Call Signature

Parameters

Returns

Example