abstract StoreAdapter<Item>

Extended by

• CloudflareStoreAdapter

Type Parameters

Type Parameter
Item

Constructors

Constructor

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, evictQueries?) => Promise<void>
deleteQueriesByRef	abstract	<Result, Root, Args>(queryRef?, parentRef?, args?) => Promise<void>
getPartialMany	abstract	(refs) => Promise<null | (null | Item)[]>
hash	protected	string
loader	protected	DataLoader<ItemRef, null | Item, ItemRef>
loadQueryMetadata	abstract	(queryRef, parentRef?, args?) => Promise<null | string[]>
options	protected	StoreOptions<Item>
saveMany	abstract	(items) => Promise<void>
saveQueryMetadata	abstract	(queryRef, meta, parentRef?, args?) => 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