@codesoul-co/hypha-serving-cache / cache-manager

• Package index: @codesoul-co/hypha-serving-cache
• Source: packages/serving-cache/src/cache-manager.ts
• Exports: 3

Using this module

Use the Cache manager module for reading, writing, or coordinating cache state. It exports 2 classes, 1 interface.

Import from the package entrypoint

import {
  CacheEntryTooLargeError,
  ServingCacheManager,
} from '@codesoul-co/hypha-serving-cache';

import type {
  ServingCacheManagerOptions,
} from '@codesoul-co/hypha-serving-cache';

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 2 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
CacheEntryTooLargeError	class	new CacheEntryTooLargeError(sizeBytes: number, maxEntryBytes: number): CacheEntryTooLargeError	Cache Entry Too Large Error class with 11 public constructor or member entries; its exact declarations are listed below.
ServingCacheManager	class	new ServingCacheManager(options: ServingCacheManagerOptions): ServingCacheManager	Serving Cache Manager class with 8 public constructor or member entries; its exact declarations are listed below.
ServingCacheManagerOptions	interface	interface ServingCacheManagerOptions	Serving Cache Manager Options interface with 3 public fields or methods.

CacheEntryTooLargeError

Cache Entry Too Large Error class with 11 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { CacheEntryTooLargeError } from '@codesoul-co/hypha-serving-cache';
• Source module: cache-manager

Declaration

export declare class CacheEntryTooLargeError extends Error {
    readonly sizeBytes: number;
    readonly maxEntryBytes: number;
    readonly code = "CACHE_ENTRY_TOO_LARGE";
    constructor(sizeBytes: number, maxEntryBytes: number);
}

Public members

Member	Kind	Signature	Description
cause	property	cause?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
code	property	readonly code: "CACHE_ENTRY_TOO_LARGE"	Public property; its type, readonly modifier and optionality are shown in the signature.
constructor	constructor	(sizeBytes: number, maxEntryBytes: number): CacheEntryTooLargeError	Creates an instance of this class.
maxEntryBytes	property	readonly maxEntryBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
message	property	message: string	Public property; its type, readonly modifier and optionality are shown in the signature.
name	property	name: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sizeBytes	property	readonly sizeBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
stack	property	stack?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
static captureStackTrace	method	static captureStackTrace(targetObject: object, constructorOpt?: Function): void	Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called. js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}. The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace. The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance: js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a();
static prepareStackTrace	method	static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any	Public method; parameters and return type are shown in the signature.
static stackTraceLimit	property	static stackTraceLimit: number	The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

ServingCacheManager

Serving Cache Manager class with 8 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { ServingCacheManager } from '@codesoul-co/hypha-serving-cache';
• Source module: cache-manager

Declaration

export declare class ServingCacheManager {
    readonly policy: CachePolicy;
    constructor(options: ServingCacheManagerOptions);
    keyFor(input: LLMCacheKeyInput): string;
    get<T>(key: string): Promise<CacheEntry<T> | null>;
    lookup<T>(key: string): Promise<CacheLookupResult<T>>;
    set<T>(key: string, value: T, metadata: CacheMetadata, ttlMs?: number | undefined): Promise<void>;
    delete(key: string): Promise<void>;
    clear(): Promise<void>;
}

Public members

Member	Kind	Signature	Description
clear	method	clear(): Promise<void>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: ServingCacheManagerOptions): ServingCacheManager	Creates an instance of this class.
delete	method	delete(key: string): Promise<void>	Public method; parameters and return type are shown in the signature.
get	method	get<T>(key: string): Promise<CacheEntry<T> | null>	Public method; parameters and return type are shown in the signature.
keyFor	method	keyFor(input: LLMCacheKeyInput): string	Public method; parameters and return type are shown in the signature.
lookup	method	lookup<T>(key: string): Promise<CacheLookupResult<T>>	Public method; parameters and return type are shown in the signature.
policy	property	readonly policy: CachePolicy	Public property; its type, readonly modifier and optionality are shown in the signature.
set	method	set<T>(key: string, value: T, metadata: CacheMetadata, ttlMs?: number | undefined): Promise<void>	Public method; parameters and return type are shown in the signature.

ServingCacheManagerOptions

Serving Cache Manager Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ServingCacheManagerOptions } from '@codesoul-co/hypha-serving-cache';
• Source module: cache-manager

Declaration

export interface ServingCacheManagerOptions {
    store: CacheStore;
    policy?: Partial<CachePolicy>;
    now?: () => number;
}

Contract members

Member	Kind	Signature	Description
now	method	now?(): number	Public method; parameters and return type are shown in the signature.
policy	property	policy?: Partial<CachePolicy>	Public property; its type, readonly modifier and optionality are shown in the signature.
store	property	store: CacheStore<unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.