Documentation / @warp-drive/core / StoreSetupOptions

Interface: StoreSetupOptions<T>

Defined in: core/src/index.ts:60

Options for setting up a Store instance with useRecommendedStore.

Type Parameters

T

T extends Cache = Cache

Properties

cache()

cache: (capabilities) => T;

Defined in: core/src/index.ts:64

The Cache implementation to use

Parameters

capabilities

CacheCapabilitiesManager

Returns

T

---

CAUTION_MEGA_DANGER_ZONE_extensions?

optional CAUTION_MEGA_DANGER_ZONE_extensions: CAUTION_MEGA_DANGER_ZONE_Extension[];

Defined in: core/src/index.ts:108

Extensions to use with resources, objects and arrays to provide custom behaviors and capabilities that are not described by Schema.

This feature should only be used during a transition period to support migrating towards schemas from existing Model and ModelFragments implementations.

---

derivations?

optional derivations: Derivation[];

Defined in: core/src/index.ts:92

Derivations to use for derived fields.

---

handlers?

optional handlers: Handler[];

Defined in: core/src/index.ts:78

The request handlers to use. Fetch will automatically be added to the end of the handler chain and CacheHandler will automatically be added as the cache handler.

---

hashFns?

optional hashFns: HashFn[];

Defined in: core/src/index.ts:100

Hash Functions to use for embedded object identity and polymorphic type calculations

---

policy?

optional policy: CachePolicy;

Defined in: core/src/index.ts:72

The Cache policy to use.

Defaults to DefaultCachePolicy configured to respect Expires, X-WarpDrive-Expires, and Cache-Control headers with a fallback to 30s soft expiration and 15m hard expiration.

---

schemas?

optional schemas: (
  | PolarisResourceSchema
  | ObjectSchema)[];

Defined in: core/src/index.ts:84

Schemas describing the structure of your resource data.

See , and ObjectSchema for more information.

---

traits?

optional traits: Trait[];

Defined in: core/src/index.ts:88

Traits to use with , | Resource Schemas

---

transformations?

optional transformations: Transformation[];

Defined in: core/src/index.ts:96

Transformations to use for transforming fields.