basalt / auth/src / LoginThrottleOptions

Interface: LoginThrottleOptions

Defined in: auth/src/throttle.ts:154

Properties

clock?

> optional clock?: () => number

Defined in: auth/src/throttle.ts:173

Injectable clock for the default in-memory store (ignored with store).

Returns

number

---

maxAttempts?

> optional maxAttempts?: number

Defined in: auth/src/throttle.ts:156

Failed attempts allowed within the window. Default 5.

---

maxEntries?

> optional maxEntries?: number

Defined in: auth/src/throttle.ts:171

Bound of the default in-memory store (ignored with store). Default 100 000.

---

namespace?

> optional namespace?: string

Defined in: auth/src/throttle.ts:169

Key prefix separating this throttle's counters from others sharing the same store (Auth uses login, login-ip and email-request).

---

store?

> optional store?: ThrottleStore

Defined in: auth/src/throttle.ts:164

Where the counters live. Default: a private MemoryThrottleStore (per process). Pass a shared store — e.g. RedisThrottleStore — to enforce one budget across every replica.

---

windowMs?

> optional windowMs?: number

Defined in: auth/src/throttle.ts:158

Fixed window in ms, opened by the first attempt. Default 15 minutes.