Skip to main content

StorageAdapter

Package: @nauth-toolkit/core Type: Interface

Shared state adapter used by nauth-toolkit for transient state (rate limits, locks, token reuse detection). Required for production deployments.

import { StorageAdapter } from '@nauth-toolkit/nestjs';

Methods

MethodReturnsDescription
initialize()Promise<void>Initialize adapter
isHealthy()Promise<boolean>Health check
get(key)Promise<string | null>Read value
set(key, value, ttlSeconds?, options?)Promise<string | null | void>Write value (optional TTL / NX)
del(key)Promise<void>Delete key
exists(key)Promise<boolean>Key existence
incr(key, ttlSeconds?)Promise<number>Atomic increment
decr(key)Promise<number>Atomic decrement
expire(key, ttl)Promise<void>Set TTL
ttl(key)Promise<number>Get TTL
hget(key, field)Promise<string | null>Hash get
hset(key, field, value)Promise<void>Hash set
hgetall(key)Promise<Record<string, string>>Hash get all
hdel(key, ...fields)Promise<number>Hash delete
lpush(key, value)Promise<void>List push
lrange(key, start, stop)Promise<string[]>List range
llen(key)Promise<number>List length
keys(pattern)Promise<string[]>Pattern keys
scan(cursor, pattern, count)Promise<[number, string[]]>Cursor scan
cleanup()Promise<void>Cleanup resources
disconnect()Promise<void>Disconnect