WarpDrive

Skip to content

Main Navigation Guides API Docs Contributing

Appearance

Sidebar Navigation

The Manual

Introduction

Configuration

Overview

Setup

Universal

Ember

Linting

Old Package Setup

Overview

Setup

Universal

Ember

Requests

Overview

Builders

Typing Requests

Handlers

Using "Just Fetch"

Caching

Data

Schemas

About

Misc

Links Mode

Typescript

Overview

Installation

Configuration

Why Brands

Typing Models

Typing Includes

Requests

Requests

Overview

Request Management

Examples

Auth

Reactivity

Reactivity

Polaris

Overview

Legacy

Overview

Relational Data

Relational Data

Features

Inverses

Polymorphism

Configuration

One To One

One To Many

Many To None

Many To One

Many To Many

Migrating

Two Store Migration

Cookbook

Incremental Adoption Guide

Cookbook

Naming Conventions

Community Resources

Terminology

Contributing

Become A Contributor

Issues

Key Concepts

Linking To Applications

Project Architecture

Rfc Process

Setting Up The Project

Submitting Prs

Terminology

Writing Api Docs

Concepts

Builders

Handlers

Mutations

Normalization

Operations

Reactive Control Flow

Requests

Schemas

Serialization

Transformation

API Docs

@warp-drive/core

build-config

Functions

setConfig

babel-macros

Functions

macros

canary-features

Variables

JSON_API_CACHE_VALIDATION_ERRORS

debugging

Variables

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_REQUEST_STATUS

LOG_REQUESTS

deprecations

Variables

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_SCHEMA_SERVICE

env

macros

configure

reactive

Classes

SchemaRecord

SchemaService

Type Aliases

Transformation

Variables

Checkout

Functions

fromIdentity

instantiateRecord

registerDerivations

teardownRecord

withDefaults

request

Classes

Context

Interfaces

CacheHandler

Future

Handler

Type Aliases

Awaitable

Deferred

ManagedRequestPriority

NextFn

Functions

createDeferred

getPromiseResult

setPromiseResult

store

Classes

DefaultCachePolicy

Interfaces

CacheControlValue

Type Aliases

PolicyConfig

Functions

parseCacheControl

types

Interfaces

BaseFinderOptions

FindRecordOptions

ModelSchema

SchemaService

Type Aliases

CacheCapabilitiesManager

FindAllOptions

LegacyResourceQuery

QueryOptions

cache

Interfaces

Cache

Type Aliases

RelationshipDiff

aliases

Type Aliases

change

Interfaces

mutations

Interfaces

Type Aliases

operations

Interfaces

Type Aliases

relationship

Interfaces

Type Aliases

graph

Interfaces

DeleteRecordOperation

Operation

ReplaceRelatedRecordOperation

ReplaceRelatedRecordsOperation

SortRelatedRecords

UnknownOperation

UpdateRelationshipOperation

Type Aliases

LocalRelationshipOperation

RemoteRelationshipOperation

identifier

Interfaces

ExistingRecordIdentifier

Identifier

NewRecordIdentifier

Type Aliases

IdentifierBucket

RequestKey

ResourceKey

StableDocumentIdentifier

StableRecordIdentifier

Variables

CACHE_OWNER

DEBUG_CLIENT_ORIGINATED

DEBUG_IDENTIFIER_BUCKET

DEBUG_STALE_CACHE_OWNER

json

raw

Interfaces

Type Aliases

params

Type Aliases

QueryParamsSerializationOptions

QueryParamsSource

Serializable

SerializablePrimitive

record

Interfaces

TypedRecordInstance

Type Aliases

_StringSatisfiesIncludes

ExtractSuggestedCacheTypes

Includes

OpaqueRecordInstance

StringSatisfiesIncludes

TypeFromInstance

TypeFromInstanceOrString

Functions

createIncludeValidator

request

Interfaces

ImmutableHeaders

RequestContext

RequestInfo

ResponseInfo

StructuredDataDocument

StructuredErrorDocument

Type Aliases

CacheOptions

ConstrainedRequestOptions

CreateRequestOptions

DeleteRequestOptions

FindRecordOptions

FindRecordRequestOptions

HTTPMethod

ImmutableCreateRequestOptions

ImmutableDeleteRequestOptions

ImmutableRequestInfo

ImmutableUpdateRequestOptions

PostQueryRequestOptions

QueryRequestOptions

RemotelyAccessibleIdentifier

StructuredDocument

UpdateRequestOptions

Variables

EnableHydration

IS_FUTURE

SkipCache

STRUCTURED

Functions

withBrand

runtime

Functions

getRuntimeConfig

setLogging

schema

concepts

Type Aliases

fields

Interfaces

Type Aliases

Functions

fields.type-test

spec

document

Interfaces

Type Aliases

error

Interfaces

json-api-raw

Interfaces

Type Aliases

symbols

Variables

RecordStore

RequestSignature

ResourceType

TransformName

Type

utils

Type Aliases

Mutable

WithPartial

utils

string

Variables

STRING_DASHERIZE_CACHE

@warp-drive/experiments

data-worker

Classes

DataWorker

Variables

CacheHandler

document-storage

Classes

DocumentStorage

image-fetch

Classes

ImageFetch

image-worker

Classes

ImageWorker

persisted-cache

worker-fetch

Classes

WorkerFetch

@warp-drive/json-api

Classes

JSONAPICache

@warp-drive/legacy

adapter

Classes

Adapter

Interfaces

BuildURLMixin

Variables

BuildURLMixin

error

Classes

AbortError

AbortError

ConflictError

ConflictError

ForbiddenError

ForbiddenError

InvalidError

InvalidError

NotFoundError

NotFoundError

ServerError

ServerError

TimeoutError

TimeoutError

UnauthorizedError

UnauthorizedError

Variables

AdapterError

json-api

Classes

JSONAPIAdapter

rest

Classes

RESTAdapter

Interfaces

FetchRequestInit

JQueryRequestInit

Type Aliases

QueryState

RequestData

compat

Interfaces

MinimumAdapterInterface

MinimumSerializerInterface

Type Aliases

AdapterPayload

CompatStore

LegacyStoreCompat

SerializerOptions

Variables

LegacyNetworkHandler

Functions

adapterFor

cleanup

normalize

pushPayload

serializeRecord

serializerFor

builders

Functions

findAll

findRecord

query

queryRecord

saveRecord

utils

Functions

configureAssertFn

configureMismatchReporter

configureTypeNormalization

expectId

formattedId

formattedType

isEquivId

isEquivType

model

Classes

AsyncHasMany

ManyArray

Model

Functions

attr

belongsTo

buildSchema

hasMany

instantiateRecord

modelFor

teardownRecord

migration-support

Classes

DelegatingSchemaService

Type Aliases

WithLegacy

WithLegacyDerivations

Functions

registerDerivations

withDefaults

serializer

Classes

Serializer

json

Classes

JSONSerializer

json-api

Classes

JSONAPISerializer

rest

Classes

EmbeddedRecordsMixin

RESTSerializer

transform

Classes

BooleanTransform

DateTransform

NumberTransform

StringTransform

Interfaces

Transform

Variables

Transform

@warp-drive/utilities

*

Functions

createRecord

deleteRecord

findRecord

query

updateRecord

active-record

Functions

createRecord

deleteRecord

findRecord

query

updateRecord

handlers

Classes

AutoCompress

Variables

SupportsRequestStreams

index

Interfaces

BuildURLConfig

CreateRecordUrlOptions

DeleteRecordUrlOptions

FindManyUrlOptions

FindRecordUrlOptions

FindRelatedCollectionUrlOptions

FindRelatedResourceUrlOptions

GenericUrlOptions

QueryUrlOptions

UpdateRecordUrlOptions

Type Aliases

UrlOptions

Functions

buildBaseURL

buildQueryParams

filterEmpty

setBuildURLConfig

sortQueryParams

json-api

Functions

createRecord

deleteRecord

findRecord

postQuery

query

serializePatch

serializeResources

setBuildURLConfig

updateRecord

string

Variables

dasherize

Functions

camelize

capitalize

clear

clearRules

irregular

loadIrregular

loadUncountable

plural

pluralize

resetToDefaults

setMaxLRUCacheSize

singular

singularize

uncountable

underscore

Legacy Packages

@ember-data/active-record

Functions

createRecord

deleteRecord

findRecord

query

updateRecord

@ember-data/adapter

error

Classes

AbortError

ConflictError

ForbiddenError

InvalidError

NotFoundError

ServerError

TimeoutError

UnauthorizedError

Variables

default

index

Classes

default

Interfaces

BuildURLMixin

Variables

BuildURLMixin

json-api

Classes

default

rest

Classes

default

Interfaces

FetchRequestInit

JQueryRequestInit

Type Aliases

QueryState

RequestData

@ember-data/graph

@ember-data/json-api

index

Classes

default

request

Functions

createRecord

deleteRecord

findRecord

postQuery

query

serializePatch

serializeResources

setBuildURLConfig

updateRecord

@ember-data/legacy-compat

builders

Functions

findAll

findRecord

query

queryRecord

saveRecord

index

Interfaces

MinimumAdapterInterface

MinimumSerializerInterface

Type Aliases

AdapterPayload

CompatStore

LegacyStoreCompat

SerializerOptions

Variables

LegacyNetworkHandler

Functions

adapterFor

cleanup

normalize

pushPayload

serializeRecord

serializerFor

utils

Functions

configureAssertFn

configureMismatchReporter

configureTypeNormalization

expectId

formattedId

formattedType

isEquivId

isEquivType

@ember-data/model

hooks

index

Classes

AsyncHasMany

default

ManyArray

Functions

attr

belongsTo

buildSchema

hasMany

instantiateRecord

modelFor

teardownRecord

migration-support

Classes

DelegatingSchemaService

Type Aliases

WithLegacy

WithLegacyDerivations

Functions

registerDerivations

withDefaults

@ember-data/request

fetch

Classes

default

index

Classes

Context

default

Interfaces

CacheHandler

Future

Handler

RequestContext

RequestInfo

ResponseInfo

StructuredDataDocument

StructuredErrorDocument

Type Aliases

Awaitable

Deferred

ImmutableRequestInfo

ManagedRequestPriority

NextFn

StructuredDocument

Functions

createDeferred

getPromiseResult

setPromiseResult

@ember-data/request-utils

deprecation-support

handlers

Classes

AutoCompress

Variables

SupportsRequestStreams

index

Classes

CachePolicy

LifetimesService

Interfaces

BuildURLConfig

CacheControlValue

CreateRecordUrlOptions

DeleteRecordUrlOptions

FindManyUrlOptions

FindRecordUrlOptions

FindRelatedCollectionUrlOptions

FindRelatedResourceUrlOptions

GenericUrlOptions

QueryUrlOptions

UpdateRecordUrlOptions

Type Aliases

PolicyConfig

UrlOptions

Functions

buildBaseURL

buildQueryParams

filterEmpty

parseCacheControl

setBuildURLConfig

sortQueryParams

string

Variables

dasherize

Functions

camelize

capitalize

clear

clearRules

irregular

loadIrregular

loadUncountable

plural

pluralize

resetToDefaults

setMaxLRUCacheSize

singular

singularize

uncountable

underscore

@ember-data/rest

Functions

createRecord

deleteRecord

findRecord

query

updateRecord

@ember-data/serializer

index

Classes

default

json

Classes

default

json-api

Classes

default

rest

Classes

default

EmbeddedRecordsMixin

transform

Classes

BooleanTransform

DateTransform

NumberTransform

StringTransform

Interfaces

default

Variables

default

@ember-data/store

configure

index

Classes

default

Document

Interfaces

CachePolicy

StoreRequestContext

Type Aliases

CacheOperation

DocumentCacheOperation

NotificationType

StoreRequestInput

Variables

CacheHandler

Functions

recordIdentifierFor

setIdentifierForgetMethod

setIdentifierGenerationMethod

setIdentifierResetMethod

setIdentifierUpdateMethod

setKeyInfoForResource

storeFor

types

Interfaces

BaseFinderOptions

FindRecordOptions

ModelSchema

SchemaService

Type Aliases

CacheCapabilitiesManager

FindAllOptions

LegacyResourceQuery

QueryOptions

@ember-data/tracking

Functions

buildSignalConfig

@warp-drive/build-config

babel-macros

Functions

macros

canary-features

Variables

JSON_API_CACHE_VALIDATION_ERRORS

debugging

Variables

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_REQUEST_STATUS

LOG_REQUESTS

deprecations

Variables

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_SCHEMA_SERVICE

index

Type Aliases

WarpDriveConfig

Functions

setConfig

@warp-drive/core-types

cache

Interfaces

Cache

Type Aliases

RelationshipDiff

aliases

Type Aliases

ResourceBlob

change

Interfaces

Change

mutations

Interfaces

AddToResourceRelationshipMutation

RemoveFromResourceRelationshipMutation

ReplaceRelatedRecordMutation

ReplaceRelatedRecordsMutation

SortRelatedRecordsMutation

Type Aliases

Mutation

operations

Interfaces

AddResourceOperation

AddToDocumentOperation

AddToResourceRelationshipOperation

MergeOperation

Op

RemoveDocumentOperation

RemoveFromDocumentOperation

RemoveFromResourceRelationshipOperation

RemoveResourceOperation

UpdateResourceFieldOperation

UpdateResourceOperation

UpdateResourceRelationshipOperation

Type Aliases

Operation

relationship

Interfaces

CollectionRelationship

ResourceRelationship

Type Aliases

Relationship

graph

Interfaces

DeleteRecordOperation

Operation

ReplaceRelatedRecordOperation

ReplaceRelatedRecordsOperation

SortRelatedRecords

UnknownOperation

UpdateRelationshipOperation

Type Aliases

LocalRelationshipOperation

RemoteRelationshipOperation

identifier

Interfaces

ExistingRecordIdentifier

Identifier

NewRecordIdentifier

Type Aliases

IdentifierBucket

RequestKey

ResourceKey

StableDocumentIdentifier

StableRecordIdentifier

Variables

CACHE_OWNER

DEBUG_CLIENT_ORIGINATED

DEBUG_IDENTIFIER_BUCKET

DEBUG_STALE_CACHE_OWNER

index

Interfaces

BaseFinderOptions

FindRecordOptions

ModelSchema

SchemaService

Type Aliases

CacheCapabilitiesManager

FindAllOptions

LegacyResourceQuery

QueryOptions

json

raw

Interfaces

ObjectValue

Type Aliases

ArrayValue

PrimitiveValue

Value

params

Type Aliases

QueryParamsSerializationOptions

QueryParamsSource

Serializable

SerializablePrimitive

record

Interfaces

TypedRecordInstance

Type Aliases

_StringSatisfiesIncludes

ExtractSuggestedCacheTypes

Includes

OpaqueRecordInstance

StringSatisfiesIncludes

TypeFromInstance

TypeFromInstanceOrString

Functions

createIncludeValidator

request

Interfaces

ImmutableHeaders

RequestContext

RequestInfo

ResponseInfo

StructuredDataDocument

StructuredErrorDocument

Type Aliases

CacheOptions

ConstrainedRequestOptions

CreateRequestOptions

DeleteRequestOptions

FindRecordOptions

FindRecordRequestOptions

HTTPMethod

ImmutableCreateRequestOptions

ImmutableDeleteRequestOptions

ImmutableRequestInfo

ImmutableUpdateRequestOptions

PostQueryRequestOptions

QueryRequestOptions

RemotelyAccessibleIdentifier

StructuredDocument

UpdateRequestOptions

Variables

EnableHydration

IS_FUTURE

SkipCache

STRUCTURED

Functions

withBrand

runtime

Functions

getRuntimeConfig

setLogging

schema

concepts

Type Aliases

Derivation

HashFn

Transformation

fields

Interfaces

ArrayField

CollectionField

DerivedField

GenericField

HashField

IdentityField

LegacyAliasField

LegacyAttributeField

LegacyBelongsToField

LegacyHasManyField

LegacyResourceSchema

LinksModeBelongsToField

LinksModeHasManyField

LocalField

ObjectAliasField

ObjectField

ObjectSchema

PolarisAliasField

PolarisResourceSchema

ResourceField

SchemaArrayField

SchemaObjectField

Type Aliases

FieldSchema

LegacyField

LegacyModeFieldSchema

LegacyRelationshipField

ObjectFieldSchema

PolarisModeFieldSchema

ResourceSchema

Schema

Functions

isLegacyResourceSchema

isResourceSchema

objectSchema

resourceSchema

spec

document

Interfaces

CollectionResourceDataDocument

ResourceErrorDocument

ResourceMetaDocument

SingleResourceDataDocument

Type Aliases

ResourceDataDocument

ResourceDocument

error

Interfaces

ApiError

json-api-raw

Interfaces

CollectionResourceRelationship

Links

PaginationLinks

ResourceIdentifier

SingleResourceRelationship

Type Aliases

CollectionResourceDocument

EmptyResourceDocument

InnerRelationshipDocument

Link

LinkObject

Meta

NewResourceObject

ResourceIdentifierObject

ResourceObject

ResourceRelationshipsObject

SingleResourceDocument

symbols

Variables

RecordStore

RequestSignature

ResourceType

TransformName

Type

utils

Type Aliases

Mutable

WithPartial

@warp-drive/schema-record

Namespaces

fromIdentity

Classes

SchemaRecord

SchemaService

Type Aliases

Transformation

Variables

Checkout

Functions

fromIdentity

instantiateRecord

registerDerivations

teardownRecord

withDefaults

On this page

Documentation / @warp-drive/core-types / spec/document

Interfaces

CollectionResourceDataDocument
ResourceErrorDocument
ResourceMetaDocument
SingleResourceDataDocument

Type Aliases

ResourceDataDocument
ResourceDocument

Pager

Previous pageresourceSchema

Next pageCollectionResourceDataDocument

Released under the MIT License.

Copyright © 2025 Ember.js and Contributors