EmberData/WarpDrive Packages Have Been Simplified

Looking for the Old Package Setup Guide?

Configuration

WarpDrive is highly configurable. The library is designed as a series of small packages and primitives with clear interface-driven boundaries between each other and brought together by configuration.

Below, we detail the installation for the most common configurations.

Installation

💡 TIP

WarpDrive uses npm channel tags to simplify installation. Available channels include:

• @lts | @latest | @beta | @canary

Replace @latest in the commands below with a different channel as desired.

pnpm

pnpm add -E @warp-drive/core@latest @warp-drive/json-api@latest

npm

npm add -E @warp-drive/core@latest @warp-drive/json-api@latest

yarn

yarn add -E @warp-drive/core@latest @warp-drive/json-api@latest

bun

bun add --exact @warp-drive/core@latest @warp-drive/json-api@latest

Lockstep Versioning

⚠️ Caution

WarpDrive packages follow lockstep: dependencies and peer-dependencies between WarpDrive packages are version-locked at the time of publish.

We find this means its best to use exact versions instead of ranges as all WarpDrive packages should be upgraded together at once.

All of the installation commands listed in this guide pin the version for this reason.

Other Packages

Install @warp-drive/utilities for commonly needed request builder, handler and string utils.

pnpm

pnpm add -E @warp-drive/utilities@latest

npm

npm add -E @warp-drive/utilities@latest

yarn

yarn add -E @warp-drive/utilities@latest

bun

bun add --exact @warp-drive/utilities@latest

Install @warp-drive/experiments for bleeding edge unstable features we're prototyping like SharedWorker and PersistedCache.

pnpm

pnpm add -E @warp-drive/experiments@latest

npm

npm add -E @warp-drive/experiments@latest

yarn

yarn add -E @warp-drive/experiments@latest

bun

bun add --exact @warp-drive/experiments@latest

🐹 For Ember.js Only

Install @warp-drive/ember

pnpm

pnpm add -E @warp-drive/ember@latest

npm

npm add -E @warp-drive/ember@latest

yarn

yarn add -E @warp-drive/ember@latest

bun

bun add --exact @warp-drive/ember@latest

Optionally, for Ember Inspector support install @ember-data/debug

pnpm

pnpm add -E @ember-data/debug@latest

npm

npm add -E @ember-data/debug@latest

yarn

yarn add-E @ember-data/debug@latest

bun

bun add --exact @ember-data/debug@latest

Optionally, to use the legacy concepts such as Models, Adapters, or Serializers install the following packages:

TIP

Also Install These Packages To Use LegacyMode Schemas

pnpm

pnpm add -E @warp-drive/utilities@latest @warp-drive/legacy@latest

npm

npm add -E @warp-drive/utilities@latest @warp-drive/legacy@latest

yarn

yarn add -E @warp-drive/utilities@latest @warp-drive/legacy@latest

bun

bun add --exact @warp-drive/utilities@latest @warp-drive/legacy@latest