Class FilterManager<PluginFilters>

A helper class for Queue to simplify filter management

Type Parameters

PluginFilters extends JsonObject = EmptyObject

Index

Constructors

constructor

new FilterManager<PluginFilters extends JsonObject = EmptyObject>(
player: Player,
guildId: string,
): FilterManager<PluginFilters>
Type Parameters
- PluginFilters extends JsonObject = EmptyObject
Parameters
- player: Player
- guildId: string
Returns FilterManager<PluginFilters>
- Defined in src/Queue/FilterManager.ts:14

Accessors

data

get data(): Filters<PluginFilters>
Raw filters object

Returns Filters<PluginFilters>
- Defined in src/Queue/FilterManager.ts:37

Methods

get

get<Name extends string>(name: Name): FilterValue<Name, PluginFilters> | null
Gets the value of a filter
Type Parameters
- Name extends string
Parameters
- name: Name
  Name of the filter
Returns FilterValue<Name, PluginFilters> | null
Value of that filter if active, null otherwise
- Defined in src/Queue/FilterManager.ts:46

set

set<
    Name extends string,
    Value extends

            | JsonLike
            | EqualizerFilter
            | KaraokeFilter
            | TimescaleFilter
            | TremoloFilter
            | VibratoFilter
            | RotationFilter
            | DistortionFilter
            | ChannelMixFilter
            | LowPassFilter,
>(
    name: Name,
    value: Value,
    isPlugin?: boolean,
): Promise<Value | null>
Sets the value of a filter
Type Parameters
- Name extends string
- Value extends
      | JsonLike
      | EqualizerFilter
      | KaraokeFilter
      | TimescaleFilter
      | TremoloFilter
      | VibratoFilter
      | RotationFilter
      | DistortionFilter
      | ChannelMixFilter
      | LowPassFilter
Parameters
- name: Name
  Name of the filter
- value: Value
  Value of the filter
- isPlugin: boolean = false
  Whether this filer belongs to a plugin
Returns Promise<Value | null>
- Defined in src/Queue/FilterManager.ts:57

has

has<Name extends string>(name: Name): boolean
Returns a boolean saying whether a filter is active
Type Parameters
- Name extends string
Parameters
- name: Name
  Name of the filter
Returns boolean
- Defined in src/Queue/FilterManager.ts:76

merge

merge(filters: Filters<PluginFilters>): Promise<Filters<PluginFilters>>
Updates the filters by shallow merging current and provided filters object
Parameters
- filters: Filters<PluginFilters>
  Raw filters object
Returns Promise<Filters<PluginFilters>>
- Defined in src/Queue/FilterManager.ts:88

remove

remove<Name extends string>(...names: Name[]): Promise<Filters<PluginFilters>>
Removes filters by name
Type Parameters
- Name extends string
Parameters
- ...names: Name[]
  List of filter names
Returns Promise<Filters<PluginFilters>>
- Defined in src/Queue/FilterManager.ts:96

clear

clear(): Promise<Filters<PluginFilters>>
Removes all filters

Returns Promise<Filters<PluginFilters>>
- Defined in src/Queue/FilterManager.ts:110

override

override(filters: Filters<PluginFilters>): Promise<Filters<PluginFilters>>
Updates the filters as provided
Parameters
- filters: Filters<PluginFilters>
  Raw filters object
Returns Promise<Filters<PluginFilters>>
- Defined in src/Queue/FilterManager.ts:118

Class FilterManager<PluginFilters>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FilterManager<PluginFilters>

Accessors

data

Returns Filters<PluginFilters>

Methods

get

Type Parameters

Parameters

Returns FilterValue<Name, PluginFilters> | null

set

Type Parameters

Parameters

Returns Promise<Value | null>

has

Type Parameters

Parameters

Returns boolean

merge

Parameters

Returns Promise<Filters<PluginFilters>>

remove

Type Parameters

Parameters

Returns Promise<Filters<PluginFilters>>

clear

Returns Promise<Filters<PluginFilters>>

override

Parameters

Returns Promise<Filters<PluginFilters>>

Settings

On This Page