Class CustomFilter

Filter that executes an arbitrary predicate against the full Update object.

Example

const customFilter = new CustomFilter((update) => update.effective_user?.id === 123456);

Hierarchy (View Summary)

BaseFilter
- CustomFilter

Index

Constructors

constructor

new CustomFilter(
filterFn: (update: Update) => boolean | Promise<boolean>,
): CustomFilter
Constructs a new CustomFilter.
Parameters
- filterFn: (update: Update) => boolean | Promise<boolean>
  Predicate receiving an Update and returning boolean.
Returns CustomFilter

Overrides BaseFilter.constructor

Properties

`Readonly`filterFn

filterFn: (update: Update) => boolean | Promise<boolean>

The custom predicate function.

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 custom predicate against the incoming update.
Parameters
- update: Update
  Incoming Telegram update.
Returns Promise<boolean>
Result of the predicate function.

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 CustomFilter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CustomFilter

Properties

`Readonly`filterFn

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 CustomFilter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CustomFilter

Properties

ReadonlyfilterFn

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`filterFn