@arkstack/cache 0.19.1 → 0.19.3

package/README.md

@@ -8,12 +8,12 @@ Cache module for Arkstack, providing a unified, driver based caching layer for t
 
 `@arkstack/cache` ships with four stores out of the box:
 
-| Driver     | Backing store                | Notes                                    |
-| ---------- | ---------------------------- | ---------------------------------------- |
-| `memory`   | in-process `Map`             | default; great for dev and tests         |
-| `file`     | JSON files on disk           | no external service required             |
-| `redis`    | Redis (via `ioredis`)        | distributed; atomic counters             |
-| `database` | a table via `@arkstack/database` | reuses your database connection      |
+| Driver     | Backing store                    | Notes                            |
+| ---------- | -------------------------------- | -------------------------------- |
+| `memory`   | in-process `Map`                 | default; great for dev and tests |
+| `file`     | JSON files on disk               | no external service required     |
+| `redis`    | Redis (via `ioredis`)            | distributed; atomic counters     |
+| `database` | a table via `@arkstack/database` | reuses your database connection  |
 
 ## Configuration
 
@@ -28,8 +28,15 @@ export default (): CacheConfig => ({
   prefix: env('CACHE_PREFIX', 'arkstack_cache_'),
   stores: {
     memory: { driver: 'memory' },
-    file: { driver: 'file', path: path.join(Arkstack.rootDir(), './storage/framework/cache') },
-    redis: { driver: 'redis', host: env('REDIS_HOST', '127.0.0.1'), port: env('REDIS_PORT', 6379) },
+    file: {
+      driver: 'file',
+      path: path.join(Arkstack.rootDir(), './storage/framework/cache'),
+    },
+    redis: {
+      driver: 'redis',
+      host: env('REDIS_HOST', '127.0.0.1'),
+      port: env('REDIS_PORT', 6379),
+    },
     database: { driver: 'database', table: 'cache' },
   },
 })
@@ -41,7 +48,7 @@ export default (): CacheConfig => ({
 import { Cache } from '@arkstack/cache'
 
 // default store
-await Cache.put('user:1', user, 60)        // ttl in seconds
+await Cache.put('user:1', user, 60) // ttl in seconds
 await Cache.get('user:1')
 await Cache.forget('user:1')
 
@@ -63,7 +70,9 @@ The ttl accepts a number of seconds, a `Date`, or `null` (forever).
 ```ts
 import { Cache, Store } from '@arkstack/cache'
 
-class TagStore extends Store { /* ... implement the Store contract ... */ }
+class TagStore extends Store {
+  /* ... implement the Store contract ... */
+}
 
 Cache.extend('tags', (config) => new TagStore(config))
 ```

package/dist/{CacheManager-B2Iw5ceu.js → CacheManager-D7cFvMyi.js}

@@ -378,18 +378,18 @@ var Repository = class {
 	}
 	/**
 	* Determine whether an item exists in the cache and has not expired.
-	* 
-	* @param key 
-	* @returns 
+	*
+	* @param key
+	* @returns
 	*/
 	async has(key) {
 		return await this.store.get(key) !== null;
 	}
 	/**
 	* Determine whether an item is missing from the cache.
-	* 
-	* @param key 
-	* @returns 
+	*
+	* @param key
+	* @returns
 	*/
 	async missing(key) {
 		return !await this.has(key);
@@ -397,9 +397,9 @@ var Repository = class {
 	/**
 	* Retrieve an item from the cache, falling back to `defaultValue` (which may
 	* be a callback) when the item is absent.
-	* 
-	* @param key 
-	* @returns 
+	*
+	* @param key
+	* @returns
 	*/
 	async get(key, defaultValue = null) {
 		const value = await this.store.get(key);
@@ -408,10 +408,10 @@ var Repository = class {
 	}
 	/**
 	* Retrieve an item and delete it from the cache in a single call.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async pull(key, defaultValue = null) {
 		const value = await this.get(key, defaultValue);
@@ -421,10 +421,10 @@ var Repository = class {
 	/**
 	* Store an item in the cache. A `null`/omitted ttl stores the item forever;
 	* a non positive ttl is a no-op that also forgets any existing entry.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async put(key, value, ttl = null) {
 		const seconds = ttlToSeconds(ttl);
@@ -436,10 +436,10 @@ var Repository = class {
 	}
 	/**
 	* Alias for {@link put}.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async set(key, value, ttl = null) {
 		return this.put(key, value, ttl);
@@ -447,10 +447,10 @@ var Repository = class {
 	/**
 	* Store an item only if it is not already present. Returns `false` when the
 	* key already exists.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async add(key, value, ttl = null) {
 		if (await this.has(key)) return false;
@@ -458,30 +458,30 @@ var Repository = class {
 	}
 	/**
 	* Store an item that never expires.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async forever(key, value) {
 		return this.store.forever(key, value);
 	}
 	/**
 	* Increment a stored numeric value.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async increment(key, value = 1) {
 		return this.store.increment(key, value);
 	}
 	/**
 	* Decrement a stored numeric value.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async decrement(key, value = 1) {
 		return this.store.decrement(key, value);
@@ -489,10 +489,10 @@ var Repository = class {
 	/**
 	* Get an item from the cache, or execute the callback, store its result for
 	* the given ttl, and return it.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async remember(key, ttl, callback) {
 		const existing = await this.store.get(key);
@@ -504,10 +504,10 @@ var Repository = class {
 	/**
 	* Get an item from the cache, or execute the callback and store its result
 	* forever.
-	* 
-	* @param key 
-	* @param defaultValue 
-	* @returns 
+	*
+	* @param key
+	* @param defaultValue
+	* @returns
 	*/
 	async rememberForever(key, callback) {
 		const existing = await this.store.get(key);
@@ -518,50 +518,50 @@ var Repository = class {
 	}
 	/**
 	* Alias for {@link rememberForever}.
-	* 
-	* @param key 
-	* @param callback 
-	* @returns 
+	*
+	* @param key
+	* @param callback
+	* @returns
 	*/
 	async sear(key, callback) {
 		return this.rememberForever(key, callback);
 	}
 	/**
 	* Remove an item from the cache.
-	* 
-	* @param key 
-	* @param callback 
-	* @returns 
+	*
+	* @param key
+	* @param callback
+	* @returns
 	*/
 	async forget(key) {
 		return this.store.forget(key);
 	}
 	/**
 	* Alias for {@link forget}.
-	* 
-	* @param key 
-	* @param callback 
-	* @returns 
+	*
+	* @param key
+	* @param callback
+	* @returns
 	*/
 	async delete(key) {
 		return this.forget(key);
 	}
 	/**
 	* Remove every item from the cache store.
-	* 
-	* @param key 
-	* @param callback 
-	* @returns 
+	*
+	* @param key
+	* @param callback
+	* @returns
 	*/
 	async flush() {
 		return this.store.flush();
 	}
 	/**
 	* Alias for {@link flush}.
-	* 
-	* @param key 
-	* @param callback 
-	* @returns 
+	*
+	* @param key
+	* @param callback
+	* @returns
 	*/
 	async clear() {
 		return this.flush();

package/dist/commands/CacheClearCommand.js

@@ -1,4 +1,4 @@
-import { t as Cache } from "../CacheManager-B2Iw5ceu.js";
+import { t as Cache } from "../CacheManager-D7cFvMyi.js";
 import { Command } from "@h3ravel/musket";
 //#region src/commands/CacheClearCommand.ts
 /**

package/dist/index.js

@@ -1,2 +1,2 @@
-import { a as RedisStore, c as DatabaseStore, i as ttlToSeconds, l as Store, n as configure, o as MemoryStore, r as Repository, s as FileStore, t as Cache } from "./CacheManager-B2Iw5ceu.js";
+import { a as RedisStore, c as DatabaseStore, i as ttlToSeconds, l as Store, n as configure, o as MemoryStore, r as Repository, s as FileStore, t as Cache } from "./CacheManager-D7cFvMyi.js";
 export { Cache, DatabaseStore, FileStore, MemoryStore, RedisStore, Repository, Store, configure, ttlToSeconds };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/cache",
-  "version": "0.19.1",
+  "version": "0.19.3",
   "type": "module",
   "description": "Cache module for Arkstack, providing a unified, driver based caching layer for the framework.",
   "homepage": "https://arkstack.toneflix.net/guide/cache",
@@ -33,13 +33,13 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/common": "^0.19.1"
+    "@arkstack/common": "^0.19.3"
   },
   "peerDependencies": {
     "@h3ravel/musket": "^2.2.13",
     "ioredis": "^5.4.1",
-    "@arkstack/contract": "^0.19.1",
-    "@arkstack/database": "^0.19.1"
+    "@arkstack/database": "^0.19.3",
+    "@arkstack/contract": "^0.19.3"
   },
   "peerDependenciesMeta": {
     "@arkstack/database": {