PopiiStorageAdapter
Popii / PopiiStorageAdapter
Interface: PopiiStorageAdapter
Section titled “Interface: PopiiStorageAdapter”Defined in: types.ts:75
Methods
Section titled “Methods”get(
key):Promise<string|null>
Defined in: types.ts:76
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string | null>
set(
key,value,mode,duration):Promise<void>
Defined in: types.ts:77
Parameters
Section titled “Parameters”string
string
"PX"
duration
Section titled “duration”number
Returns
Section titled “Returns”Promise<void>
zadd()
Section titled “zadd()”zadd(
key,score,member):Promise<void>
Defined in: types.ts:78
Parameters
Section titled “Parameters”string
number
member
Section titled “member”string
Returns
Section titled “Returns”Promise<void>
zrangebyscore()
Section titled “zrangebyscore()”zrangebyscore(
key,min,max):Promise<string[]>
Defined in: types.ts:79
Parameters
Section titled “Parameters”string
number
number
Returns
Section titled “Returns”Promise<string[]>
zremrangebyscore()
Section titled “zremrangebyscore()”zremrangebyscore(
key,min,max):Promise<void>
Defined in: types.ts:80
Parameters
Section titled “Parameters”string
number
number
Returns
Section titled “Returns”Promise<void>
zrem()?
Section titled “zrem()?”
optionalzrem(key,member):Promise<number>
Defined in: types.ts:81
Parameters
Section titled “Parameters”string
member
Section titled “member”string
Returns
Section titled “Returns”Promise<number>
incr()?
Section titled “incr()?”
optionalincr(key,expireMs):Promise<number>
Defined in: types.ts:82
Parameters
Section titled “Parameters”string
expireMs
Section titled “expireMs”number
Returns
Section titled “Returns”Promise<number>
setnx()?
Section titled “setnx()?”
optionalsetnx(key,value,expireMs):Promise<boolean>
Defined in: types.ts:83
Parameters
Section titled “Parameters”string
string
expireMs
Section titled “expireMs”number
Returns
Section titled “Returns”Promise<boolean>
del()?
Section titled “del()?”
optionaldel(key):Promise<void>
Defined in: types.ts:84
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
transaction()?
Section titled “transaction()?”
optionaltransaction<T>(fn):Promise<T>
Defined in: types.ts:92
Execute a function inside a storage transaction.
Implementations should guarantee that either all writes within fn commit
or none do (atomicity). For Redis, prefer Lua scripts for true atomicity
since the storage adapter does not expose MULTI/EXEC directly.
If the adapter does not support transactions, fn is executed directly.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”() => T | Promise<T>
Returns
Section titled “Returns”Promise<T>
disconnect()
Section titled “disconnect()”disconnect():
Promise<void>
Defined in: types.ts:93
Returns
Section titled “Returns”Promise<void>