Repository files navigation

The lightweight reactive data library for JavaScript applications

Wrangle your application's data management with scalable patterns for developer productivity.

• ⚡️ Committed to Best-In-Class Performance
• 🌲 Focused on being as svelte as possible
• 🚀 SSR Ready
• 🔜 Typescript Support
• 🐹 Built with♥️ byEmber
• ⚛️ Supports any API:GraphQLJSON:APIRESTtRPC ...bespoke or a mix

Tagged Releases

• Overview
  • Architecture
  • Basic Installation
  • Advanced Installation
• Configuration
  • Deprecation Stripping
  • randomUUID polyfill
  • Removing inspector support in production
  • Debugging
• Ember Compatibility
• Contributing

EmberData is a lightweight reactive data library for JavaScript applications that provides composable primitives for ordering query/mutation/peek flows, managing network and cache, and reducing data for presentation.

• API Documentation
• Community & Help
• Contributing Guide
• Usage Guide
• RFCs
• Team
• Blog

EmberData is bothresource centric anddocument centric in it's approach to caching, requesting and presenting data. Your application's configuration and usage drives which is important and when.

TheStore is acoordinator. When using aStore you configure what cache to use, how cache data should be presented to the UI, and where it should look for requested data when it is not available in the cache.

This coordination is handled opaquely to the nature of the requests issued and the format of the data being handled. This approach gives applications broad flexibility to configureEmberData to best suit their needs. This makesEmberData a powerful solution for applications regardless of their size and complexity.

EmberData is designed to scale, with a religious focus on performance and asset-size to keep its footprint small but speedy while still being able to handle large complex APIs in huge data-driven applications with no additional code and no added application complexity. It's goal is to prevent applications from writing code to manage data that is difficult to maintain or reason about.

EmberData's power comes not from specific features, data formats, or adherence to specific API specs such asJSON:APItrpc orGraphQL, but from solid conventions around requesting and mutating data developed over decades of experience scaling developer productivity.

Install using your javascript package manager of choice. For instance withpnpm

pnpm add ember-data

ember-data is installed by default for new applications generated withember-cli. You can check what version is installed by looking in thedevDependencies hash of your project'spackage.json file.

If you have generated a newEmber application usingember-cli but donot wish to useember-data, removeember-data from your project'spackage.json file and run your package manager's install command to update your lockfile.

EmberData is organized into primitives that compose together via public APIs.

• @ember-data/store is the core and handles coordination
• @ember-data/tracking is required when using the core and provides tracking primitives for change notification of Tracked properties
• @ember-data/json-api is a resource cache for JSON:API structured data. It integrates with the store via the hookcreateCache
• @ember-data/model is a presentation layer, it integrates with the store via the hooksinstantiateRecord andteardownRecord.
• @ember-data/adapter provides various network API integrations for APIS built over specific REST or JSON:API conventions.
• @ember-data/serializer pairs with@ember-data/adapter to normalize and serialize data to and from an API format into theJSON:API format understood by@ember-data/json-api.
• @ember-data/debug provides debugging support for theember-inspector.
• ember-data is a "meta" package which bundles all of these together for convenience

The packages interop with each other through well defined public API boundaries. The coreof the library is the store provided by@ember-data/store, while each of the other libraries plugs into the store when installed. Because these packages interop via fullypublic APIs, other libraries or applications may provide their own implementations. For instance,ember-m3 is a commonly used presentation and cache implementation suitable for complex resource objects and graphs.

EmberData allows users to opt-in and remove code that exists to support deprecated behaviors.

If your app has resolved all deprecations present in a given version, you may specify that version as your "compatibility" version to remove the code that supported the deprecated behavior from your app.

letapp=newEmberApp(defaults,{emberData:{compatWith:'4.8',},});

• Full Documentation

EmberData usesUUID V4 by default to generate identifiers for new data created on the client. Identifier generation is configurable, but we also for convenience will polyfillthe necessary feature if your browser support or deployment environment demands it. Toactivate this polyfill:

letapp=newEmberApp(defaults,{emberData:{polyfillUUID:true},});

If you do not want to ship inspector support in your production application, you can specifythat all support for it should be stripped from the build.

letapp=newEmberApp(defaults,{emberData:{includeDataAdapterInProduction:false,},});

• Full Documentation

Many portions of the internals are helpfully instrumented with logging that can be activatedat build time. This instrumentation is always removed from production builds or any buildsthat has not explicitly activated it. To activate it set the appropriate flag totrue.

letapp=newEmberApp(defaults,{emberData:{debug:{LOG_PAYLOADS:false,// data store received to update cache withLOG_OPERATIONS:false,// updates to cache remote stateLOG_MUTATIONS:false,// updates to cache local stateLOG_NOTIFICATIONS:false,LOG_REQUESTS:false,// log Requests issued via the request managerLOG_REQUEST_STATUS:false,LOG_IDENTIFIERS:false,LOG_GRAPH:false,// relationship storageLOG_INSTANCE_CACHE:false,// instance creation/deletion},},});

The following table lists EmberData versions alongside information aboutember compatibility.

• Lockstep: the latest version of ember-source at the time of release
• Supported: the versions of ember-source the release officially supports
• Tested: the versions of ember-source the project tested this release against
• Range: the peer-dep range the release states for ember-source

the version ofember-source they were release with (lockstep), as well as the range of versions of ember-source that theproject tested against at the point of release.

Status	EmberData	Lockstep	Supported	Tested	Range
Latest		5.3.0	4.84.125.*	3.284.44.84.125.25.3	3.28.12 >= 4.* >= 5.*
LTS		4.12.3	4.*5.*	3.284.44.84.125.0	3.28.12 >= 4.* >= 5.*
Prior LTS		4.12.3	4.*5.*	3.284.44.84.125.0	3.28.12 >= 4.* >= 5.*
unsupported (prior LTS)		4.8.6	4.*	3.284.44.8	3.28.12 >= 4.*
unsupported1		4.6.0	3.284.*	3.284.44.54.6	3.28.12 >= 4.*
unsupported1 (prior LTS)		4.4.6	3.284.*	3.284.4	3.28.12 >= 4.*

See theContributing guide for details.

Refer to theCode of Conduct for community guidelines and inclusivity.

This project is licensed under theMIT License.