Compare commits

...

9 Commits

Author SHA1 Message Date
751177c981 Added LRU support to cache
Some checks failed
Build / Build NPM Project (push) Successful in 1m16s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-09-08 22:52:01 -04:00
5849a97c21 Respect timezones when converting dates
Some checks failed
Build / Build NPM Project (push) Successful in 48s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-08-10 21:16:25 -04:00
fcae9e107e Better applyDeltas
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 9s
2025-08-01 23:43:43 -04:00
5bb5067abc Better applyDeltas
Some checks failed
Build / Build NPM Project (push) Successful in 39s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 9s
2025-08-01 23:33:10 -04:00
2064880673 Fixed package version
Some checks failed
Build / Build NPM Project (push) Successful in 40s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-08-01 23:10:16 -04:00
fdefdf354d New delta functions
Some checks failed
Build / Build NPM Project (push) Successful in 40s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Failing after 7s
2025-08-01 22:25:50 -04:00
31998c01d6 formatDate fixed
Some checks failed
Build / Build NPM Project (push) Successful in 1m12s
Build / Tag Version (push) Successful in 16s
Build / Publish Documentation (push) Failing after 16s
2025-08-01 11:06:07 -04:00
c5270fbd7e Better date format
Some checks failed
Build / Build NPM Project (push) Failing after 46s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-08-01 09:54:22 -04:00
bfe9493d23 Added array support to delta calculations
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 9s
2025-07-30 21:14:02 -04:00
8 changed files with 353 additions and 196 deletions

View File

@@ -1,9 +1,11 @@
<html> <html>
<body> <body>
<script type="module"> <script type="module">
import {PE} from './dist/index.mjs'; import {formatDate} from './dist/index.mjs';
console.log('data/Ts:n', PE`${'data/Ts'}:n`.methods); const dt = new Date('2021-03-03T09:00:00Z');
const result = formatDate('Do MMMM dddd', dt, 0);
console.log(result);
</script> </script>
</body> </body>
</html> </html>

View File

@@ -1,6 +1,6 @@
{ {
"name": "@ztimson/utils", "name": "@ztimson/utils",
"version": "0.26.25", "version": "0.27.5",
"description": "Utility library", "description": "Utility library",
"author": "Zak Timson", "author": "Zak Timson",
"license": "MIT", "license": "MIT",

View File

@@ -8,6 +8,8 @@ export type CacheOptions = {
persistentStorage?: {storage: Storage | Database, key: string} | string; persistentStorage?: {storage: Storage | Database, key: string} | string;
/** Keep or delete cached items once expired, defaults to delete */ /** Keep or delete cached items once expired, defaults to delete */
expiryPolicy?: 'delete' | 'keep'; expiryPolicy?: 'delete' | 'keep';
/** Least Recently Used size limit */
sizeLimit?: number;
} }
export type CachedValue<T> = T & {_expired?: boolean}; export type CachedValue<T> = T & {_expired?: boolean};
@@ -16,14 +18,15 @@ export type CachedValue<T> = T & {_expired?: boolean};
* Map of data which tracks whether it is a complete collection & offers optional expiry of cached values * Map of data which tracks whether it is a complete collection & offers optional expiry of cached values
*/ */
export class Cache<K extends string | number | symbol, T> { export class Cache<K extends string | number | symbol, T> {
private store: Record<K, T> = <any>{}; private _loading!: Function;
private store: Map<K, T> = new Map();
private timers: Map<K, NodeJS.Timeout> = new Map();
private lruOrder: K[] = [];
/** Support index lookups */ /** Support index lookups */
[key: string | number | symbol]: CachedValue<T> | any; [key: string | number | symbol]: CachedValue<T> | any;
/** Whether cache is complete */ /** Whether cache is complete */
complete = false; complete = false;
private _loading!: Function;
/** Await initial loading */ /** Await initial loading */
loading = new Promise<void>(r => this._loading = r); loading = new Promise<void>(r => this._loading = r);
@@ -43,12 +46,18 @@ export class Cache<K extends string | number | symbol, T> {
const persists: any = this.options.persistentStorage; const persists: any = this.options.persistentStorage;
const table: Table<any, any> = await persists.storage.createTable({name: persists.key, key: this.key}); const table: Table<any, any> = await persists.storage.createTable({name: persists.key, key: this.key});
const rows = await table.getAll(); const rows = await table.getAll();
Object.assign(this.store, rows.reduce((acc, row) => ({...acc, [this.getKey(row)]: row}), {})); for(const row of rows) this.store.set(this.getKey(row), row);
this._loading(); this._loading();
})(); })();
} else if((<any>this.options.persistentStorage?.storage)?.getItem != undefined) { } else if((<any>this.options.persistentStorage?.storage)?.getItem != undefined) {
const stored = (<Storage>this.options.persistentStorage.storage).getItem(this.options.persistentStorage.key); const {storage, key} = <{storage: Storage, key: string}>this.options.persistentStorage;
if(stored != null) try { Object.assign(this.store, JSON.parse(stored)); } catch { } const stored = storage.getItem(key);
if(stored != null) {
try {
const obj = JSON.parse(stored);
for(const k of Object.keys(obj)) this.store.set(<any>k, obj[k]);
} catch { /* ignore */ }
}
this._loading(); this._loading();
} }
} else { } else {
@@ -71,8 +80,8 @@ export class Cache<K extends string | number | symbol, T> {
private getKey(value: T): K { private getKey(value: T): K {
if(!this.key) throw new Error('No key defined'); if(!this.key) throw new Error('No key defined');
if(value[this.key] === undefined) throw new Error(`${this.key.toString()} Doesn't exist on ${JSON.stringify(value, null, 2)}`); if((value as any)[this.key] === undefined) throw new Error(`${this.key.toString()} Doesn't exist on ${JSON.stringify(value, null, 2)}`);
return <K>value[this.key]; return <K>(value as any)[this.key];
} }
private save(key?: K) { private save(key?: K) {
@@ -80,28 +89,50 @@ export class Cache<K extends string | number | symbol, T> {
if(!!persists?.storage) { if(!!persists?.storage) {
if(persists.storage?.database != undefined) { if(persists.storage?.database != undefined) {
(<Database>persists.storage).createTable({name: persists.key, key: <string>this.key}).then(table => { (<Database>persists.storage).createTable({name: persists.key, key: <string>this.key}).then(table => {
if(key) { if(key !== undefined) {
const value = this.get(key); const value = this.get(key, true);
if(value != null) table.set(value, key); if(value != null) table.set(value, key);
else table.delete(key); else table.delete(key);
} else { } else {
table.clear(); table.clear();
this.all().forEach(row => table.add(row)); this.all(true).forEach(row => table.add(row));
} }
}); });
} else if(persists.storage?.setItem != undefined) { } else if(persists.storage?.setItem != undefined) {
persists.storage.setItem(persists.storage.key, JSONSanitize(this.all(true))); const obj: Record<any, any> = {};
for(const [k, v] of this.store.entries()) obj[k as any] = v;
persists.storage.setItem(persists.key, JSONSanitize(obj));
} }
} }
} }
private clearTimer(key: K) {
const t = this.timers.get(key);
if(t) { clearTimeout(t); this.timers.delete(key); }
}
private touchLRU(key: K) {
if(!this.options.sizeLimit || this.options.sizeLimit <= 0) return;
const idx = this.lruOrder.indexOf(key);
if(idx >= 0) this.lruOrder.splice(idx, 1);
this.lruOrder.push(key);
while(this.lruOrder.length > (this.options.sizeLimit || 0)) {
const lru = this.lruOrder.shift();
if(lru !== undefined) this.delete(lru);
}
}
/** /**
* Get all cached items * Get all cached items
* @return {T[]} Array of items * @return {T[]} Array of items
*/ */
all(expired?: boolean): CachedValue<T>[] { all(expired?: boolean): CachedValue<T>[] {
return deepCopy<any>(Object.values(this.store) const out: CachedValue<T>[] = [];
.filter((v: any) => expired || !v._expired)); for(const v of this.store.values()) {
const val: any = v;
if(expired || !val?._expired) out.push(deepCopy<any>(val));
}
return out;
} }
/** /**
@@ -134,7 +165,10 @@ export class Cache<K extends string | number | symbol, T> {
*/ */
clear(): this { clear(): this {
this.complete = false; this.complete = false;
this.store = <any>{}; for (const [k, t] of this.timers) clearTimeout(t);
this.timers.clear();
this.lruOrder = [];
this.store.clear();
this.save(); this.save();
return this; return this;
} }
@@ -144,7 +178,10 @@ export class Cache<K extends string | number | symbol, T> {
* @param {K} key Item's primary key * @param {K} key Item's primary key
*/ */
delete(key: K): this { delete(key: K): this {
delete this.store[key]; this.clearTimer(key);
const idx = this.lruOrder.indexOf(key);
if(idx >= 0) this.lruOrder.splice(idx, 1);
this.store.delete(key);
this.save(key); this.save(key);
return this; return this;
} }
@@ -154,8 +191,12 @@ export class Cache<K extends string | number | symbol, T> {
* @return {[K, T][]} Key-value pairs array * @return {[K, T][]} Key-value pairs array
*/ */
entries(expired?: boolean): [K, CachedValue<T>][] { entries(expired?: boolean): [K, CachedValue<T>][] {
return deepCopy<any>(Object.entries(this.store) const out: [K, CachedValue<T>][] = [];
.filter((v: any) => expired || !v?._expired)); for(const [k, v] of this.store.entries()) {
const val: any = v;
if(expired || !val?._expired) out.push([k, deepCopy<any>(val)]);
}
return out;
} }
/** /**
@@ -165,8 +206,12 @@ export class Cache<K extends string | number | symbol, T> {
expire(key: K): this { expire(key: K): this {
this.complete = false; this.complete = false;
if(this.options.expiryPolicy == 'keep') { if(this.options.expiryPolicy == 'keep') {
(<any>this.store[key])._expired = true; const v: any = this.store.get(key);
if(v) {
v._expired = true;
this.store.set(key, v);
this.save(key); this.save(key);
}
} else this.delete(key); } else this.delete(key);
return this; return this;
} }
@@ -178,7 +223,11 @@ export class Cache<K extends string | number | symbol, T> {
* @returns {T | undefined} Cached item or undefined if nothing matched * @returns {T | undefined} Cached item or undefined if nothing matched
*/ */
find(filter: Partial<T>, expired?: boolean): T | undefined { find(filter: Partial<T>, expired?: boolean): T | undefined {
return <T>Object.values(this.store).find((row: any) => (expired || !row._expired) && includes(row, filter)); for(const v of this.store.values()) {
const row: any = v;
if((expired || !row._expired) && includes(row, filter)) return deepCopy<any>(row);
}
return undefined;
} }
/** /**
@@ -188,7 +237,10 @@ export class Cache<K extends string | number | symbol, T> {
* @return {T} Cached item * @return {T} Cached item
*/ */
get(key: K, expired?: boolean): CachedValue<T> | null { get(key: K, expired?: boolean): CachedValue<T> | null {
const cached = deepCopy<any>(this.store[key] ?? null); const raw = this.store.get(key);
if(raw == null) return null;
const cached: any = deepCopy<any>(raw);
this.touchLRU(key);
if(expired || !cached?._expired) return cached; if(expired || !cached?._expired) return cached;
return null; return null;
} }
@@ -198,8 +250,12 @@ export class Cache<K extends string | number | symbol, T> {
* @return {K[]} Array of keys * @return {K[]} Array of keys
*/ */
keys(expired?: boolean): K[] { keys(expired?: boolean): K[] {
return <K[]>Object.keys(this.store) const out: K[] = [];
.filter(k => expired || !(<any>this.store)[k]._expired); for(const [k, v] of this.store.entries()) {
const val: any = v;
if(expired || !val?._expired) out.push(k);
}
return out;
} }
/** /**
@@ -207,10 +263,11 @@ export class Cache<K extends string | number | symbol, T> {
* @return {Record<K, T>} * @return {Record<K, T>}
*/ */
map(expired?: boolean): Record<K, CachedValue<T>> { map(expired?: boolean): Record<K, CachedValue<T>> {
const copy: any = deepCopy(this.store); const copy: any = {};
if(!expired) Object.keys(copy).forEach(k => { for(const [k, v] of this.store.entries()) {
if(copy[k]._expired) delete copy[k] const val: any = v;
}); if(expired || !val?._expired) copy[k as any] = deepCopy<any>(val);
}
return copy; return copy;
} }
@@ -223,12 +280,17 @@ export class Cache<K extends string | number | symbol, T> {
*/ */
set(key: K, value: T, ttl = this.options.ttl): this { set(key: K, value: T, ttl = this.options.ttl): this {
if(this.options.expiryPolicy == 'keep') delete (<any>value)._expired; if(this.options.expiryPolicy == 'keep') delete (<any>value)._expired;
this.store[key] = value; this.clearTimer(key);
this.store.set(key, value);
this.touchLRU(key);
this.save(key); this.save(key);
if(ttl) setTimeout(() => { if(ttl) {
const t = setTimeout(() => {
this.expire(key); this.expire(key);
this.save(key); this.save(key);
}, (ttl || 0) * 1000); }, (ttl || 0) * 1000);
this.timers.set(key, t);
}
return this; return this;
} }
@@ -236,5 +298,5 @@ export class Cache<K extends string | number | symbol, T> {
* Get all cached items * Get all cached items
* @return {T[]} Array of items * @return {T[]} Array of items
*/ */
values = this.all(); values = this.all
} }

View File

@@ -48,3 +48,17 @@ export function fracToDec(frac: string) {
split = (<string>split.pop()).split('/'); split = (<string>split.pop()).split('/');
return whole + (Number(split[0]) / Number(split[1])); return whole + (Number(split[0]) / Number(split[1]));
} }
/**
* Add a suffix to a number:
* 1 = 1st
* 2 = 2nd
* 3 = 3rd
* N = Nth
* @param {number} n
* @returns {string}
*/
export function numSuffix(n: number): string {
const s = ['th', 'st', 'nd', 'rd'], v = n % 100;
return `${n}${s[(v - 20) % 10] || s[v] || s[0]}`;
}

View File

@@ -1,56 +1,51 @@
export type Delta = { [key: string]: any | Delta | null }; export type Delta = { [key: string]: any | Delta | null };
/** /**
* Applies deltas in order to modify `target`. * Applies deltas to `target`.
* @param target - Object to mutate * @param base starting point
* @param deltas - List of deltas to apply * @param deltas List of deltas to apply
* @returns Mutated target * @returns Mutated target
*/ */
export function applyDeltas(target: any, deltas: Delta[]): any { export function applyDeltas(base: any, ...deltas: any[]): any {
for(const delta of deltas) { function applyDelta(base: any, delta: any): any {
for(const [key, value] of Object.entries(delta)) { if(delta === null) return null;
if(value === null) { if(typeof base !== 'object' || base === null) return delta === undefined ? base : delta;
delete target[key]; // remove const result = Array.isArray(base) ? [...base] : { ...base };
} else if(typeof value === 'object' && !Array.isArray(value)) { for(const key in delta) {
if(typeof target[key] !== 'object' || Array.isArray(target[key])) { const val = delta[key];
target[key] = {}; // nested obj if(val === undefined) delete result[key];
else if(typeof val === 'object' && val !== null && !Array.isArray(val)) result[key] = applyDelta(result[key], val);
else result[key] = val;
} }
applyDeltas(target[key], [value]); // recurse return result;
} else {
target[key] = value; // restore
} }
}
} for(const d of deltas.flat()) base = applyDelta(base, d?.delta ?? d);
return target; return base;
} }
/** /**
* Creates a nested delta that reverts `target` back to `old`. * Creates a nested delta that reverts `target` back to `old`.
* @param old - Original object * @param old - Original object
* @param target - Modified object * @param updated - Modified object
* @returns Delta to revert changes * @returns New changes
*/ */
export function calcDelta(old: any, target: any): Delta { export function calcDelta(old: any, updated: any): any {
const delta: Delta = {}; if(updated == null) return null; // full delete
const keys = new Set([...Object.keys(old || {}), ...Object.keys(target || {})]); const delta: any = {};
for(const key of keys) { const isObj = (v: any) => v && typeof v === 'object' && !Array.isArray(v);
const val1 = old?.[key]; for (const key of new Set([...(old ? Object.keys(old) : []), ...(updated ? Object.keys(updated) : [])])) {
const val2 = target?.[key]; const oldVal = old?.[key];
if(!(key in target)) { const newVal = updated?.[key];
delta[key] = val1; // removed if(isObj(oldVal) && isObj(newVal)) {
} else if(!(key in old)) { const nested = calcDelta(oldVal, newVal);
delta[key] = null; // added if(nested !== null && Object.keys(nested).length > 0) delta[key] = nested;
} else if( } else if(JSON.stringify(oldVal) !== JSON.stringify(newVal)) {
typeof val1 === 'object' && typeof val2 === 'object' && delta[key] = newVal;
val1 && val2 && !Array.isArray(val1)
) {
const nested = calcDelta(val1, val2);
if(Object.keys(nested).length) delta[key] = nested;
} else if(val1 !== val2) {
delta[key] = val1; // changed
} }
} }
return delta; return Object.keys(delta).length === 0 ? {} : delta;
} }
/** /**

View File

@@ -1,3 +1,5 @@
import {numSuffix} from './math.ts';
/** /**
* Like setInterval but will adjust the timeout value to account for runtime * Like setInterval but will adjust the timeout value to account for runtime
* @param {Function} cb Callback function that will be ran * @param {Function} cb Callback function that will be ran
@@ -20,6 +22,15 @@ export function adjustedInterval(cb: Function, ms: number) {
} }
} }
export function dayOfWeek(d: number): string {
return ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'][d];
}
export function dayOfYear(date: Date): number {
const start = new Date(Date.UTC(date.getUTCFullYear(), 0, 1));
return Math.ceil((date.getTime() - start.getTime()) / (1000 * 60 * 60 * 24));
}
/** /**
* Format date * Format date
* *
@@ -28,111 +39,117 @@ export function adjustedInterval(cb: Function, ms: number) {
* @param tz Set timezone offset * @param tz Set timezone offset
* @return {string} Formated date * @return {string} Formated date
*/ */
export function formatDate(format = 'YYYY-MM-DD H:mm', date: Date | number | string = new Date(), tz?: string | number): string { export function formatDate(format: string = 'YYYY-MM-DD H:mm', date: Date | number | string = new Date(), tz: string | number = 'local'): string {
const timezones = [ if (typeof date === 'number' || typeof date === 'string') date = new Date(date);
['IDLW', -12], if (isNaN(date.getTime())) throw new Error('Invalid date input');
['SST', -11], const numericTz = typeof tz === 'number';
['HST', -10], const localTz = tz === 'local' || (!numericTz && tz.toLowerCase?.() === 'local');
['AKST', -9], const tzName = localTz ? Intl.DateTimeFormat().resolvedOptions().timeZone : numericTz ? 'UTC' : tz;
['PST', -8],
['MST', -7],
['CST', -6],
['EST', -5],
['AST', -4],
['BRT', -3],
['MAT', -2],
['AZOT', -1],
['UTC', 0],
['CET', 1],
['EET', 2],
['MSK', 3],
['AST', 4],
['PKT', 5],
['IST', 5.5],
['BST', 6],
['ICT', 7],
['CST', 8],
['JST', 9],
['AEST', 10],
['SBT', 11],
['FJT', 12],
['TOT', 13],
['LINT', 14]
];
function adjustTz(date: Date, gmt: number) { if (!numericTz && tzName !== 'UTC') {
const currentOffset = date.getTimezoneOffset(); try {
const adjustedOffset = gmt * 60; new Intl.DateTimeFormat('en-US', { timeZone: tzName }).format();
return new Date(date.getTime() + (adjustedOffset + currentOffset) * 60000); } catch {
} throw new Error(`Invalid timezone: ${tzName}`);
function day(num: number): string {
return ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'][num] || 'Unknown';
}
function doy(date: Date) {
const start = new Date(`${date.getFullYear()}-01-01 0:00:00`);
return Math.ceil((date.getTime() - start.getTime()) / (1000 * 60 * 60 * 24));
}
function month(num: number): string {
return ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'][num] || 'Unknown';
}
function suffix(num: number) {
if (num % 100 >= 11 && num % 100 <= 13) return `${num}th`;
switch (num % 10) {
case 1: return `${num}st`;
case 2: return `${num}nd`;
case 3: return `${num}rd`;
default: return `${num}th`;
} }
} }
function tzOffset(offset: number) { let zonedDate = new Date(date);
const hours = ~~(offset / 60); let get: (fn: 'FullYear' | 'Month' | 'Date' | 'Day' | 'Hours' | 'Minutes' | 'Seconds' | 'Milliseconds') => number;
const minutes = offset % 60; const partsMap: Record<string, string> = {};
return (offset > 0 ? '-' : '') + `${hours}:${minutes.toString().padStart(2, '0')}`; if (!numericTz && tzName !== 'UTC') {
const parts = new Intl.DateTimeFormat('en-US', {
timeZone: tzName,
year: 'numeric', month: '2-digit', day: '2-digit', weekday: 'long',
hour: '2-digit', minute: '2-digit', second: '2-digit',
hour12: false
}).formatToParts(date);
parts.forEach(p => {
partsMap[p.type] = p.value;
});
const monthValue = parseInt(partsMap.month) - 1;
const dayOfWeekValue = new Date(`${partsMap.year}-${partsMap.month}-${partsMap.day}`).getDay();
const hourValue = parseInt(partsMap.hour);
get = (fn: 'FullYear' | 'Month' | 'Date' | 'Day' | 'Hours' | 'Minutes' | 'Seconds' | 'Milliseconds'): number => {
switch (fn) {
case 'FullYear': return parseInt(partsMap.year);
case 'Month': return monthValue;
case 'Date': return parseInt(partsMap.day);
case 'Day': return dayOfWeekValue;
case 'Hours': return hourValue;
case 'Minutes': return parseInt(partsMap.minute);
case 'Seconds': return parseInt(partsMap.second);
default: return 0;
} }
if(typeof date == 'number' || typeof date == 'string' || date == null) date = new Date(date);
// Handle timezones
let t!: [string, number];
if(tz == null) tz = -(date.getTimezoneOffset() / 60);
t = <any>timezones.find(t => isNaN(<any>tz) ? t[0] == tz : t[1] == tz);
if(!t) throw new Error(`Unknown timezone: ${tz}`);
date = adjustTz(date, t[1]);
// Token mapping
const tokens: Record<string, string> = {
'YYYY': date.getFullYear().toString(),
'YY': date.getFullYear().toString().slice(2),
'MMMM': month(date.getMonth()),
'MMM': month(date.getMonth()).slice(0, 3),
'MM': (date.getMonth() + 1).toString().padStart(2, '0'),
'M': (date.getMonth() + 1).toString(),
'DDD': doy(date).toString(),
'DD': date.getDate().toString().padStart(2, '0'),
'Do': suffix(date.getDate()),
'D': date.getDate().toString(),
'dddd': day(date.getDay()),
'ddd': day(date.getDay()).slice(0, 3),
'HH': date.getHours().toString().padStart(2, '0'),
'H': date.getHours().toString(),
'hh': (date.getHours() % 12 || 12).toString().padStart(2, '0'),
'h': (date.getHours() % 12 || 12).toString(),
'mm': date.getMinutes().toString().padStart(2, '0'),
'm': date.getMinutes().toString(),
'ss': date.getSeconds().toString().padStart(2, '0'),
's': date.getSeconds().toString(),
'SSS': date.getMilliseconds().toString().padStart(3, '0'),
'A': date.getHours() >= 12 ? 'PM' : 'AM',
'a': date.getHours() >= 12 ? 'pm' : 'am',
'ZZ': tzOffset(t[1] * 60).replace(':', ''),
'Z': tzOffset(t[1] * 60),
'z': typeof tz == 'string' ? tz : (<any>t)[0]
}; };
} else {
const offset = numericTz ? tz as number : 0;
zonedDate = new Date(date.getTime() + offset * 60 * 60 * 1000);
get = (fn: 'FullYear' | 'Month' | 'Date' | 'Day' | 'Hours' | 'Minutes' | 'Seconds' | 'Milliseconds'): number => zonedDate[`getUTC${fn}`]();
}
function numSuffix(n: number): string {
const s = ["th", "st", "nd", "rd"];
const v = n % 100;
return n + (s[(v - 20) % 10] || s[v] || s[0]);
}
function getTZOffset(): string {
if (numericTz) {
const total = (tz as number) * 60;
const hours = Math.floor(Math.abs(total) / 60);
const mins = Math.abs(total) % 60;
return `${tz >= 0 ? '+' : '-'}${String(hours).padStart(2, '0')}:${String(mins).padStart(2, '0')}`;
}
try {
const offset = new Intl.DateTimeFormat('en-US', {timeZone: tzName, timeZoneName: 'longOffset', hour: '2-digit', minute: '2-digit',})
.formatToParts(<Date>date).find(p => p.type === 'timeZoneName')?.value.match(/([+-]\d{2}:\d{2})/)?.[1];
if (offset) return offset;
} catch {}
return '+00:00';
}
function getTZAbbr(): string {
if (numericTz && tz === 0) return 'UTC';
try {
return new Intl.DateTimeFormat('en-US', { timeZone: tzName, timeZoneName: 'short' })
.formatToParts(<Date>date).find(p => p.type === 'timeZoneName')?.value || '';
} catch {
return tzName;
}
}
const tokens: Record<string, string> = {
YYYY: get('FullYear').toString(),
YY: get('FullYear').toString().slice(2),
MMMM: month(get('Month')),
MMM: month(get('Month')).slice(0, 3),
MM: (get('Month') + 1).toString().padStart(2, '0'),
M: (get('Month') + 1).toString(),
DDD: dayOfYear(zonedDate).toString(),
DD: get('Date').toString().padStart(2, '0'),
Do: numSuffix(get('Date')),
D: get('Date').toString(),
dddd: dayOfWeek(get('Day')),
ddd: dayOfWeek(get('Day')).slice(0, 3),
HH: get('Hours').toString().padStart(2, '0'),
H: get('Hours').toString(),
hh: (get('Hours') % 12 || 12).toString().padStart(2, '0'),
h: (get('Hours') % 12 || 12).toString(),
mm: get('Minutes').toString().padStart(2, '0'),
m: get('Minutes').toString(),
ss: get('Seconds').toString().padStart(2, '0'),
s: get('Seconds').toString(),
SSS: (zonedDate[`getUTC${'Milliseconds'}`]()).toString().padStart(3, '0'),
A: get('Hours') >= 12 ? 'PM' : 'AM',
a: get('Hours') >= 12 ? 'pm' : 'am',
ZZ: getTZOffset().replace(':', ''),
Z: getTZOffset(),
z: getTZAbbr(),
};
return format.replace(/YYYY|YY|MMMM|MMM|MM|M|DDD|DD|Do|D|dddd|ddd|HH|H|hh|h|mm|m|ss|s|SSS|A|a|ZZ|Z|z/g, token => tokens[token]); return format.replace(/YYYY|YY|MMMM|MMM|MM|M|DDD|DD|Do|D|dddd|ddd|HH|H|hh|h|mm|m|ss|s|SSS|A|a|ZZ|Z|z/g, token => tokens[token]);
} }
@@ -148,6 +165,10 @@ export function instantInterval(fn: () => any, interval: number) {
return setInterval(fn, interval); return setInterval(fn, interval);
} }
export function month(m: number): string {
return ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'][m];
}
/** /**
* Use in conjunction with `await` to pause an async script * Use in conjunction with `await` to pause an async script
* *

View File

@@ -3,12 +3,14 @@ import { Cache } from '../src';
describe('Cache', () => { describe('Cache', () => {
type TestItem = { id: string; value: string }; type TestItem = { id: string; value: string };
let cache: Cache<string, TestItem>; let cache: Cache<string | symbol, TestItem>;
let storageMock: Storage; let storageMock: Storage;
let storageGetItemSpy: jest.SpyInstance; let storageGetItemSpy: jest.SpyInstance;
let storageSetItemSpy: jest.SpyInstance; let storageSetItemSpy: jest.SpyInstance;
beforeEach(() => { beforeEach(() => {
jest.useFakeTimers();
storageMock = { storageMock = {
constructor: { name: 'Storage' as any }, constructor: { name: 'Storage' as any },
getItem: jest.fn(), getItem: jest.fn(),
@@ -23,11 +25,15 @@ describe('Cache', () => {
storageGetItemSpy = jest.spyOn(storageMock, 'getItem'); storageGetItemSpy = jest.spyOn(storageMock, 'getItem');
storageSetItemSpy = jest.spyOn(storageMock, 'setItem'); storageSetItemSpy = jest.spyOn(storageMock, 'setItem');
cache = new Cache<string, TestItem>('id', { cache = new Cache<string | symbol, TestItem>('id', {
persistentStorage: { storage: storageMock, key: 'cache' }, persistentStorage: { storage: storageMock, key: 'cache' },
}); });
jest.clearAllMocks(); jest.clearAllMocks();
jest.useFakeTimers(); });
afterEach(() => {
jest.useRealTimers();
}); });
it('adds and gets an item', () => { it('adds and gets an item', () => {
@@ -58,10 +64,12 @@ describe('Cache', () => {
expect(storageSetItemSpy).toHaveBeenCalled(); expect(storageSetItemSpy).toHaveBeenCalled();
}); });
it('clears the cache', () => { it('clears the cache & cancels TTL timers', () => {
cache.add({ id: '1', value: 'test' }); cache.set('1', { id: '1', value: 'x' }, 1);
cache.clear(); cache.clear();
expect(cache.get('1')).toBeNull(); // Even after timers advance, nothing should appear or throw
jest.advanceTimersByTime(1500);
expect(cache.get('1', true)).toBeNull();
expect(cache.complete).toBe(false); expect(cache.complete).toBe(false);
}); });
@@ -75,7 +83,7 @@ describe('Cache', () => {
expect(cache.complete).toBe(true); expect(cache.complete).toBe(true);
}); });
it('returns correct keys, entries, and map', () => { it('returns correct keys, entries, map, and values()', () => {
cache.add({ id: 'x', value: 'foo' }); cache.add({ id: 'x', value: 'foo' });
cache.add({ id: 'y', value: 'bar' }); cache.add({ id: 'y', value: 'bar' });
expect(cache.keys().sort()).toEqual(['x', 'y']); expect(cache.keys().sort()).toEqual(['x', 'y']);
@@ -83,6 +91,8 @@ describe('Cache', () => {
const m = cache.map(); const m = cache.map();
expect(Object.keys(m)).toEqual(expect.arrayContaining(['x', 'y'])); expect(Object.keys(m)).toEqual(expect.arrayContaining(['x', 'y']));
expect(m['x'].value).toBe('foo'); expect(m['x'].value).toBe('foo');
// CHANGE: values() was a snapshot field before; now its a method
expect(cache.values().map(v => v.id).sort()).toEqual(['x', 'y']);
}); });
it('persists and restores from storage', () => { it('persists and restores from storage', () => {
@@ -93,6 +103,8 @@ describe('Cache', () => {
persistentStorage: { storage: storageMock, key: 'cache' }, persistentStorage: { storage: storageMock, key: 'cache' },
}); });
expect(c.get('z')).toEqual({ id: 'z', value: 'from-storage' }); expect(c.get('z')).toEqual({ id: 'z', value: 'from-storage' });
// ensure it used the right storage key
expect(storageGetItemSpy).toHaveBeenCalledWith('cache');
}); });
it('expiryPolicy "delete" removes expired items completely', () => { it('expiryPolicy "delete" removes expired items completely', () => {
@@ -112,20 +124,71 @@ describe('Cache', () => {
expect(val && val._expired).toBe(true); expect(val && val._expired).toBe(true);
}); });
// Uncomment and adapt this test if TTL/expiry timers are supported by your implementation it('TTL expiration deletes by default', () => {
// it('expires and deletes items after TTL', () => { cache.add({ id: 'ttl1', value: 'tick' }, 1);
// jest.useFakeTimers(); jest.advanceTimersByTime(999);
// cache = new Cache<string, TestItem>('id', { ttl: 0.01 }); expect(cache.get('ttl1')).toEqual({ id: 'ttl1', value: 'tick' });
// cache.add({ id: 'ttl1', value: 'temp' }); jest.advanceTimersByTime(2);
// jest.advanceTimersByTime(100); expect(cache.get('ttl1')).toBeNull();
// expect(cache.get('ttl1')).toBeNull(); });
// });
// Edge: add error handling test it('TTL overwrite cancels previous timer', () => {
it('throws if instantiating with invalid key property', () => { cache.add({ id: 'ow', value: 'v1' }, 1);
expect(() => { jest.advanceTimersByTime(500);
const invalid = new Cache<'string', TestItem>('id'); cache.add({ id: 'ow', value: 'v2' }, 1);
// try invalid.add({id: 'z', value: 'fail'}) if needed jest.advanceTimersByTime(600);
}).not.toThrow(); expect(cache.get('ow')).toEqual({ id: 'ow', value: 'v2' });
jest.advanceTimersByTime(500);
expect(cache.get('ow')).toBeNull();
});
it('find() returns first match respecting expired flag', () => {
cache.options.expiryPolicy = 'keep';
cache.add({ id: 'f1', value: 'hello' });
cache.add({ id: 'f2', value: 'world' });
cache.expire('f1');
expect(cache.find({ value: 'hello' })).toBeUndefined();
expect(cache.find({ value: 'hello' }, true)).toEqual({ id: 'f1', value: 'hello', _expired: true });
});
it('symbol keys are supported when using set/get directly', () => {
const s = Symbol('k');
// NOTE: cant use add() without a primary key; set works fine
cache.set(s, { id: 'sym', value: 'ok' });
expect(cache.get(s as any)).toEqual({ id: 'sym', value: 'ok' });
// ensure keys() includes the symbol
const keys = cache.keys(true);
expect(keys.includes(s as any)).toBe(true);
});
it('LRU: evicts least-recently-used when over capacity', () => {
const lruCache = new Cache<string, TestItem>('id', {
sizeLimit: 2,
persistentStorage: { storage: storageMock, key: 'cache' },
});
lruCache.add({ id: 'A', value: '1' });
lruCache.add({ id: 'B', value: '2' });
// touch A to make it MRU
expect(lruCache.get('A')).toEqual({ id: 'A', value: '1' });
// add C → should evict least-recently-used (B)
lruCache.add({ id: 'C', value: '3' });
expect(lruCache.get('B')).toBeNull();
expect(lruCache.get('A')).toEqual({ id: 'A', value: '1' });
expect(lruCache.get('C')).toEqual({ id: 'C', value: '3' });
});
it('delete() removes from LRU and cancels timer', () => {
const lruCache = new Cache<string, TestItem>('id', { sizeLimit: 2 });
lruCache.set('A', { id: 'A', value: '1' }, 1);
lruCache.delete('A');
jest.advanceTimersByTime(1200);
expect(lruCache.get('A', true)).toBeNull();
});
it('throws when adding item missing the primary key', () => {
const c = new Cache<'id', any>('id');
expect(() => c.add({ nope: 'missing' } as any)).toThrow(/Doesn't exist/);
}); });
}); });

View File

@@ -31,11 +31,11 @@ describe('Time Utilities', () => {
it('handles formatting for given timestamp', () => { it('handles formatting for given timestamp', () => {
const timestamp = Date.UTC(2023, 1, 1, 18, 5, 5, 123); // Feb 1, 2023 18:05:05.123 UTC const timestamp = Date.UTC(2023, 1, 1, 18, 5, 5, 123); // Feb 1, 2023 18:05:05.123 UTC
const formatted = formatDate('YYYY MM DD HH mm ss SSS A Z', timestamp, 'UTC'); const formatted = formatDate('YYYY MM DD HH mm ss SSS A Z', timestamp, 'UTC');
expect(formatted).toMatch(/^2023 02 01 18 05 05 123 PM \+?0:00$/i); expect(formatted).toMatch(/^2023 02 01 18 05 05 123 PM \+00:00/i);
}); });
it('throws for unknown timezone', () => { it('throws for unknown timezone', () => {
expect(() => formatDate('YYYY', new Date(), '???')).toThrowError(/Unknown timezone/); expect(() => formatDate('YYYY', new Date(), '???')).toThrowError(/Invalid timezone/);
}); });
it('handles timezone by offset number', () => { it('handles timezone by offset number', () => {