@codesoul-co/hypha-serving-cache / prefix-shape

• Package index: @codesoul-co/hypha-serving-cache
• Source: packages/serving-cache/src/prefix-shape.ts
• Exports: 2

Using this module

Use the Prefix shape module for using the public contracts and operations for this capability boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

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

import type {
  PrefixCacheShapeInput,
} 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 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
PrefixCacheShapeTracker	class	new PrefixCacheShapeTracker(maxSnapshots?: number): PrefixCacheShapeTracker	Prefix Cache Shape Tracker class with 2 public constructor or member entries; its exact declarations are listed below.
PrefixCacheShapeInput	interface	interface PrefixCacheShapeInput	Prefix Cache Shape Input interface with 4 public fields or methods.

PrefixCacheShapeTracker

Prefix Cache Shape Tracker class with 2 public constructor or member entries; its exact declarations are listed below.

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

Declaration

export declare class PrefixCacheShapeTracker {
    constructor(maxSnapshots?: number);
    observe(input: PrefixCacheShapeInput): PrefixCacheShapeObservation;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(maxSnapshots?: number): PrefixCacheShapeTracker	Creates an instance of this class.
observe	method	observe(input: PrefixCacheShapeInput): PrefixCacheShapeObservation	Public method; parameters and return type are shown in the signature.

PrefixCacheShapeInput

Prefix Cache Shape Input interface with 4 public fields or methods.

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

Declaration

export interface PrefixCacheShapeInput {
    provider: string;
    model: string;
    scope?: CacheScope;
    prefixMetadata: PromptPrefixMetadata;
}

Contract members

Member	Kind	Signature	Description
model	property	model: string	Public property; its type, readonly modifier and optionality are shown in the signature.
prefixMetadata	property	prefixMetadata: PromptPrefixMetadata	Public property; its type, readonly modifier and optionality are shown in the signature.
provider	property	provider: string	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope?: CacheScope	Public property; its type, readonly modifier and optionality are shown in the signature.