Class RegexFilter

Filter that matches message text or caption against a regular expression pattern.

Populates context.matches when handled in a MessageHandler.

Example

const regexFilter = new RegexFilter(/^order_(\d+)$/i);

Hierarchy (View Summary)

BaseFilter
- RegexFilter

Index

Constructors

constructor

new RegexFilter(pattern: RegExp): RegexFilter
Constructs a new RegexFilter.
Parameters
- pattern: RegExp
  Regular expression to test against message text or caption.
Returns RegexFilter

Overrides BaseFilter.constructor

Properties

`Readonly`pattern

pattern: RegExp

The compiled regular expression pattern to match against.

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>
Checks whether the message text or caption matches the pattern.
Parameters
- update: Update
  Incoming Telegram update.
Returns Promise<boolean>
true if text or caption matches.

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

Class RegexFilter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RegexFilter

Properties

`Readonly`pattern

Methods

and

Parameters

Returns BaseFilter

Example

checkUpdate

Parameters

Returns Promise<boolean>

not

Returns BaseFilter

Example

or

Parameters

Returns BaseFilter

Example

Settings

On This Page

Class RegexFilter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RegexFilter

Properties

Readonlypattern

Methods

and

Parameters

Returns BaseFilter

Example

checkUpdate

Parameters

Returns Promise<boolean>

not

Returns BaseFilter

Example

or

Parameters

Returns BaseFilter

Example

Settings

On This Page

`Readonly`pattern