Class MongodbCacheAdapter<TType>

tis kl 9 To utilize the MongodbCacheAdapter, you must install the "mongodb" package and supply a string serde, such as SuperJsonSerde.

Example

import { MongodbCacheAdapter, SuperJsonSerde } from "@daiso-tech/core";
import { MongoClient } from "mongodb";

const client = new MongoClient("YOUR_MONGODB_CONNECTION_STRING");
const database = client.db("database");
const cacheCollection = database.collection("cache");
const serde = new SuperJsonSerde();
const cacheAdapter = new MongodbCacheAdapter(cacheCollection, {
  serde,
  rootGroup: "@global"
});

(async () => {
  // You only need to call it once before using the adapter.
  await cacheAdapter.init();
  await cacheAdapter.add("a", 1);
})();

Type Parameters

TType

Implements

Index

Constructors

constructor

Methods

add clear exists get getGroup increment init put remove update withGroup

Constructors

constructor

new MongodbCacheAdapter<TType>(collection, __namedParameters): MongodbCacheAdapter<TType>
Type Parameters
- TType
Parameters
- collection: Collection<MongodbCacheDocument>
- __namedParameters: MongodbCacheAdapterSettings
Returns MongodbCacheAdapter<TType>
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:86

Methods

add

add(key, value, ttl): Promise<boolean>
The add method add a new key. Returns true if the key where added otherwise false will be returned. You must provide a ttl value. If null is passed, the item will not expire.
Parameters
- key: string
- value: TType
- ttl: null | TimeSpan
Returns Promise<boolean>
Implementation of ICacheAdapter.add
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:176

clear

clear(): Promise<void>
The clear method removes all keys that starts prefix.

Returns Promise<void>
Implementation of ICacheAdapter.clear
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:405

exists

exists(key): Promise<boolean>
The exists returns true if the key if exists otherwise false will be returned.
Parameters
- key: string
Returns Promise<boolean>
Implementation of ICacheAdapter.exists
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:121

get

get(key): Promise<null | TType>
The get returns the key value if found otherwise null will be returned.
Parameters
- key: string
Returns Promise<null | TType>
Implementation of ICacheAdapter.get
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:148

getGroup

getGroup(): string
The getGroup method returns the group name.

Returns string
Implementation of ICacheAdapter.getGroup
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:95

increment

increment(key, value): Promise<boolean>
The increment method will increment the given key if found otherwise nonthing will occur. Returns true if key is incremented otherwise false will be returned. An error will thrown if the key is not a number.
Parameters
- key: string
- value: number
Returns Promise<boolean>
Throws
TypeCacheError
Implementation of ICacheAdapter.increment
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:346

init

init(): Promise<void>
Returns Promise<void>
Implementation of IInitizable.init
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:106

put

put(key, value, ttl): Promise<boolean>
The put method replaces a key if the key exists including the ttl value or adds key that do not exists with a given ttl. Returns true if the key where replaced otherwise false is returned. You must provide a ttl value. If null is passed, the item will not expire.
Parameters
- key: string
- value: TType
- ttl: null | TimeSpan
Returns Promise<boolean>
Implementation of ICacheAdapter.put
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:286

remove

remove(key): Promise<boolean>
The remove method removes a key. Returns true if the key is removed otherwise false is returned.
Parameters
- key: string
Returns Promise<boolean>
Implementation of ICacheAdapter.remove
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:322

update

update(key, value): Promise<boolean>
The update method updates a key. Returns true if the key where updated otherwise false will be returned.
Parameters
- key: string
- value: TType
Returns Promise<boolean>
Implementation of ICacheAdapter.update
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:236

withGroup

withGroup(group): ICacheAdapter<TType>
The withGroup method returns a new ICacheAdapter instance that groups keys together. Only keys in the group can be updated, removed, or retrieved, leaving keys outside the group unaffected.
Parameters
- group: OneOrMore<string>
Returns ICacheAdapter<TType>
Implementation of ICacheAdapter.withGroup
- Defined in src/cache/implementations/adapters/mongodb-cache-adapter/mongodb-cache-adapter.ts:99

Class MongodbCacheAdapter<TType>

Example

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MongodbCacheAdapter<TType>

Methods

add

Parameters

Returns Promise<boolean>

clear

Returns Promise<void>

exists

Parameters

Returns Promise<boolean>

get

Parameters

Returns Promise<null | TType>

getGroup

Returns string

increment

Parameters

Returns Promise<boolean>

Throws

init

Returns Promise<void>

put

Parameters

Returns Promise<boolean>

remove

Parameters

Returns Promise<boolean>

update

Parameters

Returns Promise<boolean>

withGroup

Parameters

Returns ICacheAdapter<TType>

Settings

On This Page