@graphql-box/cache-manager 5.3.3 → 5.4.1

package/src/types.ts

@@ -26,9 +26,9 @@ export interface UserOptions {
    * The cache to use for storing query responses, data entities,
    * and request field paths.
    */
-  cache: Core;
+  cache: Core | (() => Promise<Core>);
   /**
-   * Whether to enable/disable any/all of the three cache tiers
+   * Whether to enable/disable any/all the three cache tiers
    * the CacheManager uses. All three are enabled by default.
    */
   cacheTiersEnabled?: CacheTiersEnabled;
@@ -50,7 +50,7 @@ export interface UserOptions {
    */
   typeCacheDirectives?: Record<string, string>;
   /**
-   * The name of the property thats value is used as the unique
+   * The name of the property that's value is used as the unique
    * identifier for each type in the GraphQL schema.
    */
   typeIDKey?: string;
@@ -161,36 +161,36 @@ export interface QueryResponseCacheEntry {
 
 export interface CacheManagerDef {
   analyzeQuery(requestData: RequestData, options: RequestOptions, context: RequestContext): Promise<AnalyzeQueryResult>;
-  cache: Core;
+  cache: Core | undefined;
   cacheQuery(
     requestData: RequestData,
     updatedRequestData: RequestData | undefined,
     responseData: RawResponseDataWithMaybeCacheMetadata,
     options: RequestOptions,
-    context: RequestContext
+    context: RequestContext,
   ): Promise<ResponseData>;
   cacheResponse(
     requestData: RequestData,
     responseData: RawResponseDataWithMaybeCacheMetadata,
     options: RequestOptions,
-    context: RequestContext
+    context: RequestContext,
   ): Promise<ResponseData>;
   checkCacheEntry(
     cacheType: CacheTypes,
     hash: string,
     options: RequestOptions,
-    context: RequestContext
+    context: RequestContext,
   ): Promise<CheckCacheEntryResult | false>;
   checkQueryResponseCacheEntry(
     hash: string,
     options: RequestOptions,
-    context: RequestContext
+    context: RequestContext,
   ): Promise<ResponseData | false>;
   deletePartialQueryResponse(hash: string): void;
   setQueryResponseCacheEntry(
     requestData: RequestData,
     responseData: ResponseData,
     options: RequestOptions,
-    context: CacheManagerContext
+    context: CacheManagerContext,
   ): Promise<void>;
 }