@nest-boot/graphql-rate-limit

Classes

GraphQLRateLimitModule

Defined in: packages/graphql-rate-limit/src/graphql-rate-limit.module.ts:62

Extends

• ConfigurableModuleClass

Indexable

[key: string]: any

Constructors

Constructor

new GraphQLRateLimitModule(): GraphQLRateLimitModule;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Returns

GraphQLRateLimitModule

Inherited from

ConfigurableModuleClass.constructor

Properties

forRoot()

static forRoot: (options) => DynamicModule;

Parameters

Parameter	Type
options	Partial<GraphQLRateLimitOptions> & Partial<{ }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.forRoot

forRootAsync()

static forRootAsync: (options) => DynamicModule;

Parameters

Parameter	Type
options	ConfigurableModuleAsyncOptions<Partial<GraphQLRateLimitOptions>, "create"> & Partial<{ }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.forRootAsync

Interfaces

ComplexityOptions

Defined in: packages/graphql-rate-limit/src/decorators/complexity.decorator.ts:3

Properties

multipliers?

optional multipliers: string[];

Defined in: packages/graphql-rate-limit/src/decorators/complexity.decorator.ts:5

value?

optional value: number;

Defined in: packages/graphql-rate-limit/src/decorators/complexity.decorator.ts:4

---

CostResponse

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:8

Properties

actualQueryCost

actualQueryCost: number;

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:10

requestedQueryCost

requestedQueryCost: number;

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:9

throttleStatus?

optional throttleStatus: CostThrottleStatus;

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:11

---

CostThrottleStatus

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:1

Properties

blocked

blocked: boolean;

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:2

currentlyAvailable

currentlyAvailable: number;

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:4

maximumAvailable

maximumAvailable: number;

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:3

restoreRate

restoreRate: number;

Defined in: packages/graphql-rate-limit/src/interfaces/cost-response.interface.ts:5

---

GraphQLRateLimitOptions

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-options.interface.ts:4

Properties

connection?

optional connection: RedisOptions;

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-options.interface.ts:5

defaultComplexity

defaultComplexity: number;

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-options.interface.ts:7

getId()

getId: (args) => string;

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-options.interface.ts:11

Parameters

Parameter	Type
args	GraphQLRequestContext<BaseContext>

Returns

string

keyPrefix

keyPrefix: string;

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-options.interface.ts:8

maxComplexity

maxComplexity: number;

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-options.interface.ts:6

maximumAvailable

maximumAvailable: number;

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-options.interface.ts:10

restoreRate

restoreRate: number;

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-options.interface.ts:9

Type Aliases

GraphQLRateLimitModuleOptions

type GraphQLRateLimitModuleOptions = Partial<GraphQLRateLimitOptions>;

Defined in: packages/graphql-rate-limit/src/interfaces/graphql-rate-limit-module-options.interface.ts:3

Variables

connectionComplexity

const connectionComplexity: Complexity;

Defined in: packages/graphql-rate-limit/src/complexities/connection.complexity.ts:6

---

GRAPHQL_COMPLEXITY_MODULE_OPTIONS_TOKEN

GRAPHQL_COMPLEXITY_MODULE_OPTIONS_TOKEN: string | symbol;

Defined in: packages/graphql-rate-limit/src/graphql-rate-limit.module-definition.ts:11

Functions

Complexity()

function Complexity(options): MethodDecorator & PropertyDecorator & ClassDecorator;

Defined in: packages/graphql-rate-limit/src/decorators/complexity.decorator.ts:8

Parameters

Parameter	Type
options	ComplexityOptions

Returns

MethodDecorator & PropertyDecorator & ClassDecorator