Class BaseFilter

Filter base class

Hierarchy

BaseFilter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseFilter(name: string, options?: OptionsInterface): BaseFilter

- Defined in base-filter.ts:10
Parameters
- name: string
  
  Name/key of the filter
- Default value options: OptionsInterface = {}
  
  Options
Returns BaseFilter

Properties

Protected Readonly client

client: Red

name

name: string

Protected Readonly options

options: Options

Methods

connect

connect(): Promise<void>

- Defined in base-filter.ts:27
Connect to Redis server

Returns Promise<void>

disconnect

disconnect(): Promise<void>

- Defined in base-filter.ts:34
Disconnect from Redis server

Returns Promise<void>

reset

reset(): Promise<number>

- Defined in base-filter.ts:42
Reset the filter

Returns Promise<number>

1 on success, 0 otherwise