cachu - npm Package Compare versions

Comparing version 5.0.0-canary.3 to 5.0.0-canary.4

package.json

 {
   "name": "cachu",
-  "version": "5.0.0-canary.3",
+  "version": "5.0.0-canary.4",
   "description": "🦝 Simple, Minimalistic KV Cache",
-  "types": "./types/node.d.ts",
-  "exports": {
-    ".": "./dist/node.js"
-  },
+  "types": "./types/index.d.ts",
+  "main": "./dist/index.js",
   "scripts": {
-    "types": "tsc -w",
-    "build:node": "esbuild src/node.ts --bundle --minify --format=cjs --outfile=dist/node.js",
-    "build:browser": "esbuild src/browser.ts --bundle --minify --format=cjs --outfile=dist/browser.js",
-    "publish:patch": "tsc && npm run build:node && npm run build:browser && npm version patch && npm publish",
-    "publish:minor": "tsc && npm run build:node && npm run build:browser && npm version minor && npm publish",
-    "publish:major": "tsc && npm run build:node && npm run build:browser && npm version major && npm publish",
+    "types": "tsc",
+    "build": "esbuild src/index.ts --bundle --minify --format=cjs --outfile=dist/index.js",
+    "publish:patch": "tsc && npm run build && npm version patch && npm publish",
+    "publish:minor": "tsc && npm run build && npm version minor && npm publish",
+    "publish:major": "tsc && npm run build && npm version major && npm publish",
     "test": "jest --detectOpenHandles"
@@ -28,6 +25,5 @@ },
     "kv",
+    "cache",
     "asynchronous",
-    "cache",
-    "easy-to-use",
-    "modules"
+    "simple"
   ],
@@ -34,0 +30,0 @@ "author": "Azury <[e-mail]> (https://azury.dev)",

types/caches/MemoryCache/index.d.ts

@@ -1,3 +0,120 @@
-import { CreateMemoryCache } from './types';
-declare const MemoryCache: CreateMemoryCache;
-export default MemoryCache;
+/**
+ * Create a new `MemoryCache`
+ */
+declare type MemoryCache = (config: {
+    maxAge?: string | number;
+    maxAmount?: number;
+}) => {
+    set: SetMethod;
+    setMany: SetManyMethod;
+    get: GetMethod;
+    getMany: GetManyMethod;
+    update: UpdateMethod;
+    updateMany: UpdateManyMethod;
+    delete: DeleteMethod;
+    deleteMany: DeleteManyMethod;
+    has: HasMethod;
+    size: SizeMethod;
+    keys: KeysMethod;
+    values: ValuesMethod;
+    clear: ClearMethod;
+    memory: MemoryMethod;
+    recent: RecentMethod;
+    maxAge: MaxAgeMethod;
+    maxAmount: MaxAmountMethod;
+    on: OnMethod;
+};
+declare type Key = {};
+declare type Value = {};
+declare type Record = {
+    key: Key;
+    value: Value;
+    age: number;
+    maxAge?: number;
+};
+declare type Event = 'set' | 'setMany' | 'get' | 'getMany' | 'update' | 'updateMany' | 'delete' | 'deleteMany' | 'has' | 'size' | 'keys' | 'values' | 'clear' | 'memory' | 'recent' | 'maxAge' | 'maxAmount' | 'on';
+/**
+ * Add a event handler.
+ */
+declare type OnMethod = (event: Event, action: Function) => Promise<void>;
+/**
+ * Change or get the maximum age of records.
+ */
+declare type MaxAgeMethod = (newAge?: string | number) => Promise<number>;
+/**
+ * Change or get the limit of records.
+ */
+declare type MaxAmountMethod = (newAmount?: number) => Promise<number>;
+/**
+ * Add a new record to the cache.
+ */
+declare type SetMethod = (key: Key, value: Value, maxAge?: number | string) => Promise<Record | undefined>;
+/**
+ * Add many new records to the cache.
+ */
+declare type SetManyMethod = (records: [Key, Value, number | string | undefined][]) => Promise<(Record | undefined)[]>;
+/**
+ * Read a record from the cache.
+ */
+declare type GetMethod = (key: Key, config?: {
+    validate?: boolean;
+    delete?: boolean;
+}) => Promise<Record | undefined>;
+/**
+ * Read many records from the cache.
+ */
+declare type GetManyMethod = (keys: Key[], config?: {
+    reverse?: boolean;
+    validate?: boolean;
+    delete?: boolean;
+}) => Promise<(Record | undefined)[]>;
+/**
+ * Delete all stale records manually.
+ */
+declare type ClearMethod = () => Promise<void>;
+/**
+ * Get an array of all record keys.
+ */
+declare type KeysMethod = () => Promise<any[]>;
+/**
+ * Get an array of all record values.
+ */
+declare type ValuesMethod = () => Promise<any[]>;
+/**
+ * Get the amount of memory in bytes consumed by the cache.
+ */
+declare type MemoryMethod = () => Promise<number>;
+/**
+ * Get the most recent updated or added record.
+ */
+declare type RecentMethod = () => Promise<Record | undefined>;
+/**
+ * Get the amount of records in the cache.
+ */
+declare type SizeMethod = () => Promise<number>;
+/**
+ * Check whether the cache has a specific record.
+ */
+declare type HasMethod = (key: Key) => Promise<boolean>;
+/**
+ * Delete a record from the cache.
+ */
+declare type DeleteMethod = (key: Key) => Promise<void>;
+/**
+ * Delete many records from the cache.
+ */
+declare type DeleteManyMethod = (keys: Key[]) => Promise<void>;
+/**
+ * Update the value of a record.
+ */
+declare type UpdateMethod = (key: Key, value: Value, config?: {
+    updateAge: boolean;
+}) => Promise<void>;
+/**
+ * Update the values of many records.
+ */
+declare type UpdateManyMethod = (records: [Key, Value][], config: {
+    updateAge: boolean;
+}) => Promise<void>;
+declare const memoryCache: MemoryCache;
+export default memoryCache;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23454

increased by15.14%

Lines of code

145

increased by417.86%

Worsened metrics

Number of package files

7

decreased by-12.5%

No dependency changes