Guides
Upgrading
API Docs
Blog
Skills
Contributing
RFCs

Sidebar Navigation

Installation

Instructions
UNPKG

Configuration

Setup
Setup - Advanced
Setup - Legacy (Ember)
Setup - React
Older Packages (Ember Only)
- Overview
  Setup
  - Ember
    Universal

Tutorials

Overview
TodoMVC
- 0. Setup
  1. First request
  2. Why that worked
  3. Request builders
  4. Create
  5. Edit title
  6. Toggle
  7. Delete
  8. Bulk operations

The Manual

Introduction
Requests
- Making Requests
  Typing Requests
  Using The Response
  Builders
  Handlers
Schemas
- Overview
  Resources
  - ResourceSchemas
    Legacy Mode
    Polaris Mode
  Object Schemas
  Simple Fields
  Relational Fields
  Complex Fields
  Traits
  Derivations
  Transformations
  Extensions
Relational Data
- Overview
  Configuration
  - Many To Many
    Many To None
    Many To One
    One To Many
    One To None
    One To One
  Features
  - Inverses
    Polymorphism
Caching
- Overview
  Key Terms
Reactivity
- Overview
  Async as Reactive State
  Control Flow
TypeScript
- Overview
  Configuration
  Installation
  Typing Includes
  Typing Models
  Why Brands
Debugging
- Overview
Testing with Holodeck
- Overview
  Server Setup
  Client Setup
  Test Framework Integration
  Common Setups
  - Common Setups
    Vite Dev Server
    Testem
    Caddy
  Writing Mocks
  Recording and Replaying
  Troubleshooting
  HoloPrograms
Mutations
- Overview
  Mutations
  Operations
Experiments
- Overview
  Pagination
  Storage Resources
Cookbook
- Index
  Auth Handlers
  Basic Usage
  Holodeck in Dev Mode
  Multiple Frameworks On One Page
  Naming Conventions
  Paginating POST Queries
Community Resources

Skills

Schemas
- Define a Resource Schema
Requests
- Fetch and Cache Data
  Write a Request Builder
Holodeck
- Set Up Holodeck
  Mock HTTP Requests in Tests
  Use RECORD in Holodeck Mocks
Docs
- Read the Docs as Markdown
Contributors
- Start in a Fresh Worktree
  Keep Commits Human-Authored
  Fix at the Source
  Commit Mock Cache Fixtures
  Writing and Implementing RFCs
  Write Documentation
  Publish a Blog Post
  Use CI as the Source of Truth
  Extract Test Setup Into Functions
  Submit a PR
  Write a PR Blog Summary
  Draft a Release Blog Post

FAQ

Index
Multiple Frameworks on One Page
PolarisMode With Ember and React

Linting

Overview

Contributing

Become A Contributor
Reporting Issues
Setting Up The Project
Project Architecture
Key Concepts
Writing Documentation
- Overview
  Writing Guides
  Writing API Docs
  Writing Agent Skills
Submitting PRs
The RFC Process
Performing A Release
The Project Roadmap

RFCs

⚪ #1 - Transactional Notification Delivery and Reactive Request State (2026-09-02)
⚪ #2 - A Framework-Agnostic Build Plugin for WarpDrive (2026-09-02)
⚪ #3 - A Browser Devtools Extension (2026-09-23)
⚪ #4 - Dropping V1 Addon and Classic ember-cli Macros Support in 6.0 (2026-09-25)
⚪ #5 - Deprecating the Legacy ember-data Packages and @warp-drive/core-types (2026-09-25)
⚪ #6 - Pointer and Reference Fields (2026-09-25)
⚪ #7 - Virtualized Resources (2026-09-26)
⚪ #8 - A $state Field for PolarisMode ReactiveResources (2026-09-25)
⚪ #9 - Deprecating Subscription-Based Request State (2026-09-26)

Upgrading

4.x → 5.x
- Migrating 4.x to 5.x
  Two Store Migration
  Incremental Adoption
  Using Codemods

Blog

5.x
- 5.x
  Introducing Upgrading & Blog
  WarpDrive 5.9

API Docs

Universal Packages
@warp-drive/core
- exports
  - ConfiguredStore
    RequestManager
    Store
    CacheHandler
    Fetch
    recordIdentifierFor
    setIdentifierForgetMethod
    setIdentifierGenerationMethod
    setIdentifierResetMethod
    setIdentifierUpdateMethod
    setKeyInfoForResource
    useRecommendedStore
  /build-config
  - exports
    babelPlugin
    setConfig
    /babel-macros
    exports
    macros
    /canary-features
    exports
    ENFORCE_STRICT_RESOURCE_FINALIZATION
    JSON_API_CACHE_VALIDATION_ERRORS
    /debugging
    exports
    DEBUG_RELATIONSHIP_NOTIFICATIONS
    LOG_CACHE
    LOG_CACHE_POLICY
    LOG_GRAPH
    LOG_IDENTIFIERS
    LOG_INSTANCE_CACHE
    LOG_METRIC_COUNTS
    LOG_MUTATIONS
    LOG_NOTIFICATIONS
    LOG_OPERATIONS
    LOG_PAYLOADS
    LOG_REACT_SIGNAL_INTEGRATION
    LOG_REQUEST_STATUS
    LOG_REQUESTS
    /Namespaces
    /t
    /deprecations
    exports
    DEPRECATE_COMPUTED_CHAINS
    DEPRECATE_EMBER_INFLECTOR
    DEPRECATE_LEGACY_IMPORTS
    DEPRECATE_MANY_ARRAY_DUPLICATES
    DEPRECATE_NON_STRICT_ID
    DEPRECATE_NON_STRICT_TYPES
    DEPRECATE_NON_UNIQUE_PAYLOADS
    DEPRECATE_RELATIONSHIP_REMOTE_UPDATE_CLEARING_LOCAL_STATE
    DEPRECATE_STORE_EXTENDS_EMBER_OBJECT
    DEPRECATE_TRACKING_PACKAGE
    DISABLE_7X_DEPRECATIONS
    ENABLE_LEGACY_REQUEST_METHODS
    ENABLE_LEGACY_SCHEMA_SERVICE
  /configure
  - exports
    registerSignals
    setupSignals
  /reactive
  - exports
    SchemaService
    Checkout
    fromIdentity
    checkout
    commit
    createRequestSubscription
    getPromiseState
    getRequestState
    instantiateRecord
    registerDerivations
    teardownRecord
    withDefaults
  /request
  - exports
    withBrand
    createDeferred
    getPromiseResult
    setPromiseResult
    withReactiveResponse
    withResponseType
  /store
  - exports
    DefaultCachePolicy
    parseCacheControl
  /types
  - /cache
    /aliases
    /change
    /mutations
    /operations
    /relationship
    /graph
    /identifier
    /json
    /raw
    /params
    /record
    exports
    createIncludeValidator
    /request
    exports
    EnableHydration
    SkipCache
    /schema
    /concepts
    /fields
    exports
    /schema-service
    /spec
    /document
    /error
    /json-api-raw
    /symbols
    exports
    RecordStore
    RequestSignature
    ResourceType
    TransformName
    Type
    /utils
@warp-drive/json-api
- exports
  - JSONAPICache
@warp-drive/utilities
- exports
  - buildBaseURL
    buildQueryParams
    filterEmpty
    setBuildURLConfig
    sortQueryParams
  /active-record
  - exports
    createRecord
    deleteRecord
    findRecord
    query
    updateRecord
  /derivations
  - exports
    concat
    /Namespaces
    /concat
  /handlers
  - /Handlers
    /AutoCompress
    /Gate
    /MetaDocHandler
    /Constants
    /MAX_URL_LENGTH
    /SupportsRequestStreams
    /TAB_ASSIGNED
    /TAB_ID
    /Utility Functions
    /addTraceHeader
    /assertInvalidUrlLength
  /json-api
  - exports
    createRecord
    deleteRecord
    findRecord
    postQuery
    query
    serializePatch
    serializeResources
    setBuildURLConfig
    updateRecord
  /rest
  - exports
    createRecord
    deleteRecord
    findRecord
    query
    updateRecord
  /string
  - exports
    dasherize
    camelize
    capitalize
    clear
    clearRules
    irregular
    loadIrregular
    loadUncountable
    plural
    pluralize
    resetToDefaults
    setMaxLRUCacheSize
    singular
    singularize
    uncountable
    underscore
@warp-drive/legacy
- exports
  - ConfiguredStore
    useLegacyStore
  /adapter
  - exports
    Adapter
    BuildURLMixin
    /error
    exports
    AbortError
    AdapterError
    ConflictError
    ForbiddenError
    InvalidError
    NotFoundError
    ServerError
    TimeoutError
    UnauthorizedError
    /json-api
    exports
    JSONAPIAdapter
    /rest
    exports
    RESTAdapter
  /compat
  - exports
    LegacyNetworkHandler
    adapterFor
    cleanup
    normalize
    pushPayload
    serializeRecord
    serializerFor
    /builders
    exports
    findAll
    findRecord
    query
    queryRecord
    saveRecord
    /extensions
    exports
    EmberArrayLikeExtension
    EmberObjectArrayExtension
    EmberObjectExtension
    /utils
    exports
    configureAssertFn
    configureMismatchReporter
    configureTypeNormalization
    expectId
    formattedId
    formattedType
    isEquivId
    isEquivType
  /model
  - exports
    Model
    attr
    belongsTo
    buildSchema
    hasMany
    instantiateRecord
    modelFor
    restoreDeprecatedModelRequestBehaviors
    teardownRecord
    /migration-support
    exports
    DelegatingSchemaService
    registerDerivations
    withDefaults
    withRestoredDeprecatedModelRequestBehaviors
  /model-fragments
  - exports
    Fragment
    FragmentArray
    FragmentArrayExtension
    FragmentExtension
    modelFor
    registerFragmentExtensions
    withArrayDefaults
    withFragmentArrayDefaults
    withFragmentDefaults
    withLegacy
  /serializer
  - exports
    Serializer
    /json
    exports
    JSONSerializer
    /json-api
    exports
    JSONAPISerializer
    /rest
    exports
    EmbeddedRecordsMixin
    RESTSerializer
    /transform
    exports
    BooleanTransform
    DateTransform
    NumberTransform
    StringTransform
    Transform
  /store
  - exports
    restoreDeprecatedStoreBehaviors
@warp-drive/experiments
- /data-worker
  - exports
    DataWorker
    CacheHandler
  /document-storage
  - exports
    DocumentStorage
  /image-fetch
  - exports
    ImageFetch
  /image-worker
  - exports
    ImageWorker
  /pagination
  - exports
    defaultPageHints
    clearPaginationCache
    createPaginationLinksSubscription
    createPaginationSubscription
    getPaginationCache
    getPaginationLinks
    getPaginationState
  /storage
  - exports
    CacheStorage
    DEFAULT_CACHE_ID
    _initializeFields
    BooleanParam
    CacheResource
    configureLocalStorage
    configureSessionStorage
    effect
    field
    getCacheStorage
    getLocalStorage
    getSessionStorage
    input
    LocalResource
    NumberParam
    onStorageEvent
    param
    SessionResource
  /worker-fetch
  - exports
    WorkerFetch
Framework Packages
@warp-drive/ember
- exports
  - Await
    Request
    Throw
  /experiments
  - exports
    EachLink
    Paginate
  /install
  - exports
    buildSignalConfig
@warp-drive/react
- exports
  - WatcherContext
    ReactiveContext
    Request
    StoreProvider
    useStore
  /install
  - exports
    buildSignalConfig
    settled
@warp-drive/tc39-proposal-signals
- /install
  - exports
    buildSignalConfig
@warp-drive/alien-signals
- /install
  - exports
    buildSignalConfig
    registerSignalIntegration
  /primitives
  - exports
    Watcher
    consumeSignal
    createMemo
    createSignal
    hasSubscribers
    isTracking
    notifySignal
    readMemo
Tooling Packages
@warp-drive/holodeck
- exports
  - MockServerHandler
    getIsRecording
    installAdapterFor
    mock
    setConfig
    setIsRecording
    setTestId
  /mock
  - exports
    DELETE
    GET
    HEAD
    PATCH
    POST
    PUT
@warp-drive/schema-dsl
- /Entity Decorators
  - /ObjectSchema
    /Resource
    /trait
    /Trait
  /Field Decorators
  - /alias
    /array
    /attribute
    /belongsTo
    /createonly
    /derived
    /editonly
    /field
    /hash
    /hasMany
    /id
    /local
    /object
    /optional
    /readonly
    /schemaArray
    /schemaObject
eslint-plugin-warp-drive
- exports
  - export=
  /recommended
  - exports
    export=
  /rules
  - /no-create-record-rerender
    exports
    export=
    /no-external-request-patterns
    exports
    export=
    /no-invalid-relationships
    exports
    export=
    /no-invalid-resource-ids
    exports
    export=
    /no-invalid-resource-types
    exports
    export=
    /no-legacy-imports
    exports
    export=
    /no-legacy-request-patterns
    exports
    export=
    /no-test-module-hooks
    exports
    export=
    /require-request-error-block
    exports
    export=
    /template-always-use-request-content
    exports
    export=
    /template-require-request-error-block
    exports
    export=
@warp-drive/memory-alpha

Legacy API Docs

@ember-data/adapter
- /error
  /json-api
  /rest
@ember-data/active-record
- /request
@ember-data/legacy-compat
- /builders
  /utils
@ember-data/model
- /hooks
  /migration-support
@ember-data/json-api
- /request
@ember-data/store
- /configure
  /types
@ember-data/graph
@ember-data/request
- /fetch
@ember-data/request-utils
- exports
  - LifetimesService
  /handlers
  /string
@ember-data/rest
- /request
@ember-data/serializer
- /json
  /json-api
  /rest
  /transform
@ember-data/tracking
- exports
  - buildSignalConfig
@warp-drive/core-types
- /cache
  /graph
  /identifier
  /json
  - /raw
  /params
  /record
  /request
  /schema
  - /concepts
    /fields
  /spec
  - /document
    /error
    /json-api-raw
  /symbols
  /utils
@warp-drive/build-config
@warp-drive/schema-record

On this page

Realtime

Pardon Our Stardust!

This section is still in spacedock for construction.

Edit this page

Pager

Next pageInstallation

Released under the MIT License.

Setup

Resources

Configuration

Features

Common Setups

exports

/build-config

exports

/babel-macros

exports

/canary-features

exports

/debugging

exports

/Namespaces

/deprecations

exports

/configure

exports

/reactive

exports

/request

exports

/store

exports

/types

/cache

/json

/record

exports

/request

exports

/schema

/fields

/spec

/symbols

exports

exports

exports

/active-record

exports

/derivations

exports

/Namespaces

/handlers

/Handlers

/Constants

/Utility Functions

/json-api

exports

/rest

exports

/string

exports

exports

/adapter

exports

/error

exports

/json-api

exports

/rest

exports

/compat

exports

/builders

exports

/extensions

exports

/utils

exports

/model

exports

/migration-support

exports

/model-fragments

exports

/serializer

exports

/json