@baeta/extension-cache

Classes

CacheRef<Result, Root, Args>

Cache reference for a type field or query

Type Parameters

Type Parameter
Result
Root
Args

Constructors

new CacheRef()

new CacheRef<Result, Root, Args>(type, field, hash, revision): CacheRef<Result, Root, Args>

Parameters

Parameter	Type	Default value
type	string	undefined
field	string	undefined
hash	string	undefined
revision	number	1

Returns

CacheRef<Result, Root, Args>

Methods

getHash()

getHash(): string

Returns

string

getRevision()

getRevision(): number

Returns

number

setRevision()

setRevision(revision): void

Parameters

Parameter	Type
revision	number

Returns

void

toString()

toString(): string

Returns

string

---

abstract Store

Base class for cache storage implementations

Constructors

new Store()

new Store(): Store

Returns

Store

Methods

createStoreAdapter()

abstract createStoreAdapter<T>(serializer, options, type, hash): StoreAdapter<T>

Creates a new store adapter for a specific type

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
serializer	Serializer	Serializer instance
options	StoreOptions<T>	Store configuration options
type	string	Type name for the cached items
hash	string	Unique hash for the type

Returns

StoreAdapter<T>

---

abstract StoreAdapter<Item>

Type Parameters

Type Parameter
Item

Constructors

new StoreAdapter()

new StoreAdapter<Item>(serializer, options, type, hash): StoreAdapter<Item>

Parameters

Parameter	Type
serializer	Serializer
options	StoreOptions<Item>
type	string
hash	string

Returns

StoreAdapter<Item>

Properties

Property	Modifier	Type
deleteMany	abstract	(refs: ItemRef[], evictQueries?: boolean) => Promise<void>
deleteQueriesByRef	abstract	<Result, Root, Args>(queryRef?: string, parentRef?: ParentRef, args?: Record<string, unknown>) => Promise<void>
getPartialMany	abstract	(refs: ItemRef[]) => Promise<null | (null | Item)[]>
hash	protected	string
loader	protected	DataLoader<ItemRef, null | Item, ItemRef>
loadQueryMetadata	abstract	(queryRef: string, parentRef?: ParentRef, args?: Record<string, unknown>) => Promise<null | string[]>
options	protected	StoreOptions<Item>
saveMany	abstract	(items: Item[]) => Promise<void>
saveQueryMetadata	abstract	(queryRef: string, meta: string[], parentRef?: ParentRef, args?: Record<string, unknown>) => Promise<void>
serializer	protected	Serializer
type	protected	string

Methods

createKey()

protected createKey(ref): string

Parameters

Parameter	Type
ref	ItemRef

Returns

string

createKeyByItem()

protected createKeyByItem(item): string

Parameters

Parameter	Type
item	Item

Returns

string

createKeyByQuery()

protected createKeyByQuery(queryRef, parentRef?, args?): string

Parameters

Parameter	Type
queryRef	string
parentRef?	ParentRef
args?	Record<string, unknown>

Returns

string

createMiddleware()

createMiddleware<Result, Root, Args>(queryRef, ...args): Middleware<Result, Root, unknown, Args>

Type Parameters

Type Parameter
Result
Root
Args

Parameters

Parameter	Type
queryRef	CacheRef<Result, Root, Args>
...args	Root extends RefCompatibleRoot ? [CacheMiddlewareOptions<Root<Root>>] : [RequiredCacheMiddlewareOptions<Root>]

Returns

Middleware<Result, Root, unknown, Args>

createQueryKeyGlobMatcher()

protected createQueryKeyGlobMatcher(queryRef, parentRef, args): string

Parameters

Parameter	Type
queryRef	string
parentRef	NonNullable<ParentRef>
args	Record<string, unknown>

Returns

string

createQueryKeyHeader()

protected createQueryKeyHeader(parentRef, args?): string

Parameters

Parameter	Type
parentRef	ParentRef
args?	Record<string, unknown>

Returns

string

createQueryKeyNamespace()

protected createQueryKeyNamespace(queryRef): string

Parameters

Parameter	Type
queryRef	string

Returns

string

createQueryKeyRegExpMatcher()

protected createQueryKeyRegExpMatcher(queryRef, parentRef, args): RegExp

Parameters

Parameter	Type
queryRef	string
parentRef	NonNullable<ParentRef>
args	Record<string, unknown>

Returns

RegExp

decodeQueryItemRef()

protected decodeQueryItemRef(encodedRef): null | string

Parameters

Parameter	Type
encodedRef	string

Returns

null | string

delete()

delete(ref, evictQueries?): Promise<void>

Parameters

Parameter	Type
ref	ItemRef
evictQueries?	boolean

Returns

Promise<void>

deleteQueries()

deleteQueries<Result, Root, Args>(queryRef?, matcher?): Promise<void>

Type Parameters

Type Parameter
Result
Root
Args

Parameters

Parameter	Type
queryRef?	CacheRef<Result, Root, Args>
matcher?	CacheQueryMatching<Args>

Returns

Promise<void>

encodeQueryItemRef()

protected encodeQueryItemRef(item): string

Parameters

Parameter	Type
item	null | Item

Returns

string

get()

get(ref): Promise<null | Item>

Parameters

Parameter	Type
ref	ItemRef

Returns

Promise<null | Item>

getMany()

Call Signature

getMany(refs): Promise<null | Item[]>

Parameters

Parameter	Type
refs	ItemRef[]

Returns

Promise<null | Item[]>

Call Signature

getMany<T>(refs, fallback): Promise<Item[]>

Type Parameters

Type Parameter
T extends ItemRef

Parameters

Parameter	Type
refs	T[]
fallback	(refs) => Promise<Item[]>

Returns

Promise<Item[]>

getQueryResult()

getQueryResult<Result, Root, Args>(queryRef, matcher?): Promise<null | { query: Result; }>

Type Parameters

Type Parameter
Result
Root
Args

Parameters

Parameter	Type
queryRef	CacheRef<Result, Root, Args>
matcher?	CacheQueryMatching<Args>

Returns

Promise<null | { query: Result; }>

getRef()

protected getRef(root): ItemRef

Parameters

Parameter	Type
root	Item

Returns

ItemRef

getRevision()

protected getRevision(): string

Returns

string

loaderFn()

protected loaderFn(refs): Promise<any[]>

Parameters

Parameter	Type
refs	readonly ItemRef[]

Returns

Promise<any[]>

parseItem()

protected parseItem(value): Item

Parameters

Parameter	Type
value	string

Returns

Item

save()

save(item): Promise<void>

Parameters

Parameter	Type
item	Item

Returns

Promise<void>

saveQueryResult()

saveQueryResult<Result, Root, Args>(queryRef, data, matcher?): Promise<void>

Type Parameters

Type Parameter
Result
Root
Args

Parameters

Parameter	Type
queryRef	CacheRef<Result, Root, Args>
data	Result
matcher?	CacheQueryMatching<Args>

Returns

Promise<void>

stringifyItem()

protected stringifyItem(item): string

Parameters

Parameter	Type
item	Item

Returns

string

Interfaces

CacheMiddlewareOptions<Root>

Options for cache middleware

Extended by

• RequiredCacheMiddlewareOptions

Type Parameters

Type Parameter
Root

Properties

Property	Type	Description
getRootRef?	(root: Root) => ItemRef	Function to extract object reference id

---

DefaultStoreOptions

Default options for cache stores

Extended by

• StoreOptions

Properties

Property	Type	Default value	Description
ttl?	number	3600;	Time-to-live in seconds

---

RequiredCacheMiddlewareOptions<Root>

Required options for cache middleware

Extends

• CacheMiddlewareOptions<Root>

Type Parameters

Type Parameter
Root

Properties

Property	Type	Description	Overrides
getRootRef	(root: Root) => ItemRef	Function to extract object reference id	CacheMiddlewareOptions.getRootRef

---

RequiredStoreOptions<Root>

Required configuration options for cache stores

Extends

• StoreOptions<Root>

Type Parameters

Type Parameter
Root

Properties

Property	Type	Default value	Description	Overrides	Inherited from
getRef	(root: Root) => ItemRef	undefined	Function to extract object reference id	StoreOptions.getRef	‐
revision?	number	undefined	Manual cache version for invalidation	‐	StoreOptions.revision
ttl?	number	3600;	Time-to-live in seconds	‐	StoreOptions.ttl

---

Serializer

Methods

deserialize()

deserialize<T>(payload): T

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
payload	SerializerResult

Returns

T

parse()

parse<T>(string): T

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
string	string

Returns

T

serialize()

serialize(object): SerializerResult

Parameters

Parameter	Type
object	any

Returns

SerializerResult

stringify()

stringify(object): string

Parameters

Parameter	Type
object	any

Returns

string

---

SerializerResult

Properties

Property	Type
json	any
meta?	object
meta.referentialEqualities?	any
meta.values?	any

---

StoreOptions<Root>

Configuration options for cache stores

Extends

• DefaultStoreOptions

Extended by

• RequiredStoreOptions

Type Parameters

Type Parameter
Root

Properties

Property	Type	Default value	Description	Inherited from
getRef?	(root: Root) => ItemRef	undefined	Function to extract object reference id	‐
revision?	number	undefined	Manual cache version for invalidation	‐
ttl?	number	3600;	Time-to-live in seconds	DefaultStoreOptions.ttl

Type Aliases

CacheArgs<T>

CacheArgs<T>: { [P in keyof T]?: T[P] extends object ? CacheArgs<T[P]> : T[P] }

Optional query arguments

Type Parameters

Type Parameter
T

---

CacheQueryMatching<Args>

CacheQueryMatching<Args>: object

Type Parameters

Type Parameter
Args

Type declaration

Name	Type
args?	CacheArgs<Args>
parentRef?	ParentRef

---

ClassTransformer

ClassTransformer: object

Type declaration

Name	Type
class	SerializerClass
kind	"class"
allowProps?	string[]
identifier?	string

---

CustomTransformer<Input, Output>

CustomTransformer<Input, Output>: object

Type Parameters

Type Parameter
Input
Output extends SerializerValue

Type declaration

Name	Type
deserialize	(value) => Input
isApplicable	(value) => value is Input
kind	"custom"
name	string
serialize	(value) => Output

---

ItemRef

ItemRef: string | number | bigint

Reference type for cached items

---

ParentRef

ParentRef: ItemRef | null | undefined

Reference type for query parent

---

RefCompatibleRoot

RefCompatibleRoot: { id: string | number | bigint; } | {}

Type constraint for objects that are compatible with default cache ref

---

SerializerAny

SerializerAny: any

---

SerializerClass()

SerializerClass: (...args) => any

Parameters

Parameter	Type
...args	any[]

Returns

any

---

SerializerTransformer<Input, Output>

SerializerTransformer<Input, Output>: CustomTransformer<Input, Output> | ClassTransformer | SymbolTransformer

Type Parameters

Type Parameter	Default type
Input	SerializerAny
Output extends SerializerValue	SerializerAny

---

SerializerValue

SerializerValue: string | number | boolean | undefined | null | SerializerValue[] | {}

---

SymbolTransformer

SymbolTransformer: object

Type declaration

Name	Type
kind	"symbol"
symbol	symbol
identifier?	string

Functions

cacheExtension()

cacheExtension(store, options?, transformers?): () => Extension

Creates a cache extension

Parameters

Parameter	Type	Description
store	Store	Storage adapter implementation
options?	DefaultStoreOptions	Default caching options
transformers?	SerializerTransformer[]	Serializer transformers for custom scalars that are not serializable by default

Returns

Function

Extension factory function

Returns

Extension

Example

import { cacheExtension } from "@baeta/extension-cache";
import { RedisStore } from "@baeta/extension-cache-redis";
import Redis from "ioredis";

const redis = new Redis("redis://localhost:6379");
const redisStore = new RedisStore(redis);

export const cacheExt = cacheExtension(redisStore, {
  ttl: 3600, // TTL in seconds (defaults to 1 hour)
});

---

createSerializer()

createSerializer<Input, Output>(serializers?): Serializer

Type Parameters

Type Parameter	Default type
Input	any
Output extends SerializerValue	any

Parameters

Parameter	Type
serializers?	SerializerTransformer<Input, Output>[]

Returns

Serializer