ContextQMD
Back to Pocketbase

Interface RateLimitsConfig

static/jsvm/interfaces/core.RateLimitsConfig.html

latest1.7 KB
Original Source

Interface RateLimitsConfig

Hierarchy

  • RateLimitsConfig

Index

Methods

findRateLimitRulemarshalJSONvalidate

Properties

enabledrules

Methods

findRateLimitRule

  • findRateLimitRule(searchLabels, ...optOnlyAudience): [RateLimitRule, boolean]

FindRateLimitRule returns the first matching rule based on the provided labels.

Optionally you can further specify a list of valid RateLimitRule.Audience values to further filter the matching rule (aka. the rule Audience will have to exist in one of the specified options).

Parameters

searchLabels: string[]
Rest ...optOnlyAudience: string[]

Returns [RateLimitRule, boolean]

marshalJSON

  • marshalJSON(): string | number[]

MarshalJSON implements the [json.Marshaler] interface.

Returns string | number[]

validate

  • validate(): void

Validate makes RateLimitsConfig validatable by implementing [validation.Validatable] interface.

Returns void

Properties

enabled

enabled: boolean

rules

rules: RateLimitRule[]

Settings

Member Visibility

  • Inherited

Theme

OSLightDark

On This Page

Generated using TypeDoc