ModuleOptions
Options for the SDK module.
interface ModuleOptions {
dataPrefix?: string;
defaultTimeToLive?: number;
enabled?: boolean;
id?: string;
ioredis?: RedisOptions;
mock?: boolean;
tagPrefix?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
dataPrefix | Optional | string | Prefix for all data keys stored in Redis. "data:" |
defaultTimeToLive | Optional | number | The time in seconds after which data records saved in redis using the setCache method will be deleted. Can be overridden by the timeout property of the setCache method. |
enabled | Optional | boolean | Disables caching globally by inactivating certain SDK methods when set to false. |
id | Optional | string | Unique identifier of a module instance. |
ioredis | Optional | RedisOptions | ioredis client options. |
mock | Optional | boolean | Uses in-memory key-value store instead of redis. |
tagPrefix | Optional | string | Prefix for all tag keys stored in Redis. "tag:" |
Referenced Types
RedisOptions