Class MessageFilter

Filter that evaluates incoming messages using a custom predicate function.

Example

const customFilter = new MessageFilter((msg) => msg.text?.startsWith("!") ?? false);

Hierarchy (View Summary)

BaseFilter
- MessageFilter

Index

Constructors

Methods

and checkUpdate not or

Constructors

constructor

new MessageFilter(
predicate: (message: Message) => boolean | Promise<boolean>,
): MessageFilter
Constructs a new MessageFilter.
Parameters
- predicate: (message: Message) => boolean | Promise<boolean>
  Function that evaluates a Message and returns boolean.
Returns MessageFilter

Overrides BaseFilter.constructor

Methods

and

and(other: BaseFilter): BaseFilter
Combines this filter with another using logical AND (&&).
Parameters
- other: BaseFilter
  The other filter to combine with.
Returns BaseFilter
A new combined BaseFilter.
Example
```
const textInPrivate = filters.TEXT.and(filters.ChatType.PRIVATE);
```
Inherited from BaseFilter.and

checkUpdate

checkUpdate(update: Update): Promise<boolean>
Evaluates the predicate on update.effective_message.
Parameters
- update: Update
  Incoming Telegram update.
Returns Promise<boolean>
true if the message satisfies the predicate.

Overrides BaseFilter.checkUpdate

not

not(): BaseFilter
Inverts this filter using logical NOT (!).

Returns BaseFilter
A new inverted BaseFilter.
Example
```
const notCommand = filters.COMMAND.not();
```
Inherited from BaseFilter.not

or

or(other: BaseFilter): BaseFilter
Combines this filter with another using logical OR (||).
Parameters
- other: BaseFilter
  The other filter to combine with.
Returns BaseFilter
A new combined BaseFilter.
Example
```
const photoOrDoc = filters.PHOTO.or(filters.DOCUMENT);
```
Inherited from BaseFilter.or