cacheAsync
Creates a version of a schema that caches its output.
const Schema = v.cacheAsync<TSchema, TCacheConfig>(schema, config);
Generics
TSchemaextends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>TCacheConfigextends CacheConfig | undefined
Parameters
schemaTSchemaconfigTCacheConfig
Explanation
The cacheAsync method creates a version of the given schema that caches its output. This can be useful for performance optimization, for example when validation involves a network request.
Hint: Primitive inputs are cached by value. Object and function inputs are cached by reference identity, so mutating input objects and reusing the same reference can return a stale cached dataset. Returned objects are also reused by reference, so mutating cached output can affect later cache hits. For best results, use
cacheAsyncwith immutable inputs and avoid mutating returned cached objects.
Returns
SchemaSchemaWithCacheAsync<TSchema, TCacheConfig>
Examples
The following examples show how cacheAsync can be used.
Cache schema
Schema that caches its output.
const CacheSchema = v.cacheAsync(v.string());
Max size schema
Schema that caches its output for a maximum of 100 items.
const MaxSizeSchema = v.cacheAsync(v.string(), { maxSize: 100 });
Max age schema
Schema that caches its output for a maximum of 10 seconds.
const MaxAgeSchema = v.cacheAsync(v.string(), { maxAge: 10_000 });
Related
The following APIs can be combined with cacheAsync.
Schemas
any,array,bigint,blob,boolean,custom,date,enum,exactOptional,file,function,instance,intersect,lazy,literal,looseObject,looseTuple,map,nan,never,nonNullable,nonNullish,nonOptional,null,nullable,nullish,number,object,objectWithRest,optional,picklist,promise,record,set,strictObject,strictTuple,string,symbol,tuple,tupleWithRest,undefined,undefinedable,union,unknown,variant,void