Documentation / @warp-drive/core

@warp-drive/core

This package provides the core WarpDrive experience. Head over to the guides for an introduction to WarpDrive

Installation

pnpm install -E @warp-drive/core@latest

See Configuration for full installation and configuration instructions.

Bare Bones Setup

services/store.ts

import { RequestManager, Store, Fetch } from '@warp-drive/core';

export default class AppStore extends Store {
  requestManager = new RequestManager()
    .use([Fetch]);
}

Basic Usage

const { content } = await store.request({ url: '/api/users' });

Modules

• build-config
• build-config/babel-macros
• build-config/canary-features
• build-config/debugging
• build-config/deprecations
• build-config/env
• build-config/macros
• configure
• reactive
• request
• store
• types
• types/cache
• types/cache/aliases
• types/cache/change
• types/cache/mutations
• types/cache/operations
• types/cache/relationship
• types/graph
• types/identifier
• types/json/raw
• types/params
• types/record
• types/request
• types/runtime
• types/schema/concepts
• types/schema/fields
• types/schema/fields.type-test
• types/spec/document
• types/spec/error
• types/spec/json-api-raw
• types/symbols
• types/utils
• utils/string

Classes

• Document
• Fetch
• RequestManager
• Store

Interfaces

• CachePolicy
• StoreRequestContext

Type Aliases

• CacheOperation
• DocumentCacheOperation
• NotificationType
• StoreRequestInput

Variables

• CacheHandler

Functions

• recordIdentifierFor
• setIdentifierForgetMethod
• setIdentifierGenerationMethod
• setIdentifierResetMethod
• setIdentifierUpdateMethod
• setKeyInfoForResource
• storeFor