💡 Looking for the Legacy Package Configuration 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.
Installation
pnpm add -E @warp-drive/core@latest @warp-drive/json-api@latestnpm add -E @warp-drive/core@latest @warp-drive/json-api@latestyarn add -E @warp-drive/core@latest @warp-drive/json-api@latestbun add --exact @warp-drive/core@latest @warp-drive/json-api@latest💡 TIP
WarpDrive uses npm channel tags to simplify installation. Replace @latest in any installation command in this guide with a different channel as desired. Available channels include:
@lts|@latest|@beta|@canary
Lockstep Versioning
WarpDrive packages follow a lockstep versioning approach: all dependencies and peer-dependencies between the project's own packages are version-locked at the time of publish.
For instance, @warp-drive/utilities@5.6.0 has a peer-dependency on @warp-drive/core@5.6.0. If any other version were present (even a differing patch version such as 5.6.1) it would create a conflict.
⚠️ Caution
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 add -E @warp-drive/utilities@latestnpm add -E @warp-drive/utilities@latestyarn add -E @warp-drive/utilities@latestbun add --exact @warp-drive/utilities@latestInstall @warp-drive/experiments for bleeding edge unstable features we're prototyping like SharedWorker and PersistedCache.
pnpm add -E @warp-drive/experiments@latestnpm add -E @warp-drive/experiments@latestyarn add -E @warp-drive/experiments@latestbun add --exact @warp-drive/experiments@latest🐹 For Ember.js Only
Install @warp-drive/ember
pnpm add -E @warp-drive/ember@latestnpm add -E @warp-drive/ember@latestyarn add -E @warp-drive/ember@latestbun add --exact @warp-drive/ember@latestOptionally, for Ember Inspector support install @ember-data/debug
pnpm add -E @ember-data/debug@latestnpm add -E @ember-data/debug@latestyarn add-E @ember-data/debug@latestbun add --exact @ember-data/debug@latestOptionally, 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 add -E @warp-drive/utilities@latest @warp-drive/legacy@latestnpm add -E @warp-drive/utilities@latest @warp-drive/legacy@latestyarn add -E @warp-drive/utilities@latest @warp-drive/legacy@latestbun add --exact @warp-drive/utilities@latest @warp-drive/legacy@latest