Docs
API
Interfaces
RateLimitTransformConfig

Interface: RateLimitTransformConfig

types/src.YamlConfig.RateLimitTransformConfig

Table of contents

Properties

Properties

field

field: string

The field of the type that the rate limit is applied to

Defined in

packages/types/src/config.ts:1496


identifier

identifier: string

The identifier expression that determines the identity of the request (e.g. {context.req.socket.remoteAddress})

Defined in

packages/types/src/config.ts:1508


max

max: number

The maximum number of requests that can be made in a given time period

Defined in

packages/types/src/config.ts:1500


ttl

ttl: number

The time period in which the rate limit is applied

Defined in

packages/types/src/config.ts:1504


type

type: string

The type name that the following field belongs to

Defined in

packages/types/src/config.ts:1492