umbot
    Preparing search index...

    Interface IAddFormField<TBotController>

    Описание одного поля формы в Bot.addForm.

    interface IAddFormField<TBotController extends BotController = BotController> {
        name: string;
        optional?: boolean;
        options?: string[];
        parse?: (
            value: string,
            ctx: TBotController,
        ) => TFormParseResult | Promise<TFormParseResult>;
        prompt: string | ((ctx: TBotController, context: TFormContext) => string);
        validate?: (value: string) => string | boolean | Promise<string | boolean>;
    }

    Type Parameters

    Index
    name: string

    Имя поля. Станет ключом в объекте ответов, который получит onComplete. Должно быть валидным ключом объекта.

    'name', 'email', 'age'
    
    optional?: boolean

    Необязательное поле: к вопросу добавляется кнопка skipText формы («Пропустить»). Пропущенное поле не попадает в ответы.

    options?: string[]

    Варианты ответа: показываются кнопками, ответ должен совпасть с одним из них (без учёта регистра). В ответы попадает вариант в написании из списка. Иначе вопрос задаётся повторно с текстом invalidOptionText формы.

    ['Утро', 'День', 'Вечер']
    
    parse?: (
        value: string,
        ctx: TBotController,
    ) => TFormParseResult | Promise<TFormParseResult>

    Проверка с преобразованием ответа (вызывается после validate): вернуть { value } — в ответы попадёт value; { error } — вопрос задаётся повторно с этим текстом. Значение хранится в userData до конца формы, поэтому должно сериализоваться в JSON (дату возвращайте строкой ISO).

    parse: (v) => (Number.isInteger(+v) && +v > 0 ? { value: +v } : { error: 'Нужно целое число' })
    
    prompt: string | ((ctx: TBotController, context: TFormContext) => string)

    Текст, который бот отправит пользователю с просьбой ввести это поле. Может быть строкой или функцией от контроллера и контекста формы (см. Bot.startForm).

    'Как вас зовут?' | (ctx, context) => `Комната ${context.roomId}. Ваше имя?`
    
    validate?: (value: string) => string | boolean | Promise<string | boolean>

    Валидатор пользовательского ввода.

    Может быть синхронным или асинхронным. Возвращаемое значение:

    • true — значение принято, переходим к следующему полю.
    • false — валидация не прошла, повторяем prompt без сообщения об ошибке.
    • string — эта строка отправляется пользователю как текст ошибки.
    // Синхронная валидация
    validate: (v) => v.length > 0

    // Сообщение, если неверно
    validate: (v) => /\S+@\S+/.test(v) || 'Некорректный email'

    // Асинхронная (например, проверка через API)
    validate: async (v) => {
    const exists = await db.users.findOne({ email: v });
    return exists ? 'Email уже занят' : true;
    }