Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emberjs/data
A lightweight reactive data library for javascript applications. Designed over composable primitives.
https://github.com/emberjs/data
ember ember-data hacktoberfest javascript
Last synced: 30 days ago
JSON representation
A lightweight reactive data library for javascript applications. Designed over composable primitives.
- Host: GitHub
- URL: https://github.com/emberjs/data
- Owner: emberjs
- License: other
- Created: 2011-12-20T01:50:40.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T22:39:00.000Z (about 1 month ago)
- Last Synced: 2024-05-01T09:50:55.537Z (about 1 month ago)
- Topics: ember, ember-data, hacktoberfest, javascript
- Language: JavaScript
- Homepage: https://api.emberjs.com/ember-data/release
- Size: 254 MB
- Stars: 3,037
- Watchers: 151
- Forks: 1,325
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: ROADMAP.md
Lists
- awesome-for-beginners - Ember.js Data - for-New-Contributors)_ <br> A data persistence library for Ember.js. (JavaScript)
- awesome-ember - emberjs/data - ember-data repo (Code / EmberConf Videos)
README
The lightweight reactive data library for JavaScript applications
[](https://github.com/emberjs/data/actions?workflow=Main)
[](https://discord.gg/zT3asNS)
---
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 ♥️ by [Ember](https://emberjs.com)
- ⚛️ Supports any API: `GraphQL` `JSON:API` `REST` `tRPC` ...bespoke or a mix
**Tagged Releases**
- 
- 
- 
- 
- 
### 📖 On This Page
- [Overview](#overview)
- [Architecture](#-architecture)
- [Basic Installation](#basic-installation)
- [Advanced Installation](#advanced-installation)
- [Configuration](#configuration)
- [Deprecation Stripping](#deprecation-stripping)
- [randomUUID polyfill](#randomuuid-polyfill)
- [Removing inspector support in production](#removing-inspector-support-in-production)
- [Debugging](#debugging)
- [Ember Compatibility](#compatibility)
- [Contributing](#contributing)
# Overview
*Ember***Data** 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](https://api.emberjs.com/ember-data/release)
- [Community & Help](https://emberjs.com/community)
- [Contributing Guide](./CONTRIBUTING.md)
- [Usage Guide](https://guides.emberjs.com/release/models/)
- [RFCs](https://github.com/emberjs/rfcs/labels/T-ember-data)
- [Team](https://emberjs.com/team)
- [Blog](https://emberjs.com/blog)
## 🪜 Architecture
*Ember***Data** is both _resource_ centric and _document_ centric in it's approach to caching, requesting and presenting data. Your application's configuration and usage drives which is important and when.
The `Store` is a **coordinator**. When using a `Store` 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 configure *Ember***Data** to best suit their needs. This makes *Ember***Data** a powerful solution for applications regardless of their size and complexity.
*Ember***Data** 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.
*Ember***Data**'s power comes not from specific features, data formats, or adherence to specific API specs such as `JSON:API` `trpc` or `GraphQL`, but from solid conventions around requesting and mutating data developed over decades of experience scaling developer productivity.
## Basic Installation
Install using your javascript package manager of choice. For instance with [pnpm](https://pnpm.io/)
```no-highlight
pnpm add ember-data
```
`ember-data` is installed by default for new applications generated with `ember-cli`. You can check what version is installed by looking in the `devDependencies` hash of your project's [package.json](https://docs.npmjs.com/cli/v8/configuring-npm/package-json) file.
If you have generated a new `Ember` application using `ember-cli` but do
not wish to use `ember-data`, remove `ember-data` from your project's `package.json` file and run your package manager's install command to update your lockfile.
## Advanced Installation
*Ember***Data** is organized into primitives that compose together via public APIs.
- [@ember-data/store](./packages/store) is the core and handles coordination
- [@ember-data/tracking](./packages/tracking) is required when using the core and provides tracking primitives for change notification of Tracked properties
- [@ember-data/json-api](./packages/json-api) is a resource cache for JSON:API structured data. It integrates with the store via the hook `createCache`
- [@ember-data/model](./packages/model) is a presentation layer, it integrates with the store via the hooks `instantiateRecord` and `teardownRecord`.
- [@ember-data/adapter](./packages/adapter) provides various network API integrations for APIS built over specific REST or JSON:API conventions.
- [@ember-data/serializer](./packages/serializer) pairs with `@ember-data/adapter` to normalize and serialize data to and from an API format into the `JSON:API` format understood by `@ember-data/json-api`.
- [@ember-data/debug](./packages/debug) provides debugging support for the `ember-inspector`.
- [ember-data](./packages/-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 core
of 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 fully
public APIs, other libraries or applications may provide their own implementations. For instance, [ember-m3](https://github.com/hjdivad/ember-m3) is a commonly used presentation and cache implementation suitable for complex resource objects and graphs.
## Configuration
### Deprecation Stripping
*Ember***Data** 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.
```ts
let app = new EmberApp(defaults, {
emberData: {
compatWith: '4.8',
},
});
```
- [Full Documentation](https://api.emberjs.com/ember-data/release/modules/@ember-data%2Fdeprecations)
### randomUUID polyfill
*Ember***Data** uses `UUID V4` by default to generate identifiers for new data created on the client. Identifier generation is configurable, but we also for convenience will polyfill
the necessary feature if your browser support or deployment environment demands it. To
activate this polyfill:
```ts
let app = new EmberApp(defaults, {
emberData: {
polyfillUUID: true
},
});
```
### removing inspector support in production
If you do not want to ship inspector support in your production application, you can specify
that all support for it should be stripped from the build.
```ts
let app = new EmberApp(defaults, {
emberData: {
includeDataAdapterInProduction: false,
},
});
```
- [Full Documentation](https://api.emberjs.com/ember-data/release/modules/@ember-data%2Fdebug)
### Debugging
Many portions of the internals are helpfully instrumented with logging that can be activated
at build time. This instrumentation is always removed from production builds or any builds
that has not explicitly activated it. To activate it set the appropriate flag to `true`.
```ts
let app = new EmberApp(defaults, {
emberData: {
debug: {
LOG_PAYLOADS: false, // data store received to update cache with
LOG_OPERATIONS: false, // updates to cache remote state
LOG_MUTATIONS: false, // updates to cache local state
LOG_NOTIFICATIONS: false,
LOG_REQUESTS: false, // log Requests issued via the request manager
LOG_REQUEST_STATUS: false,
LOG_IDENTIFIERS: false,
LOG_GRAPH: false, // relationship storage
LOG_INSTANCE_CACHE: false, // instance creation/deletion
},
},
});
```
## Compatibility
The following table lists EmberData versions alongside information about
ember 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 of
ember-source they were release with (lockstep), as well as the range of versions of ember-source that the
project tested against at the point of release.
| Status | EmberData | Lockstep | Supported | Tested | Range |
| ------ | --------- | -------- | --------- | ------ | ----- |
| Latest |  | `5.3.0` | `4.8` `4.12` `5.*` | `3.28` `4.4` `4.8` `4.12` `5.2` `5.3` | `3.28.12`
`>= 4.*`
`>= 5.*` |
| LTS |  | `4.12.3` | `4.*` `5.*` | `3.28` `4.4` `4.8` `4.12` `5.0` | `3.28.12`
`>= 4.*`
`>= 5.*` |
| Prior LTS |  | `4.12.3` | `4.*` `5.*` | `3.28` `4.4` `4.8` `4.12` `5.0` | `3.28.12`
`>= 4.*`
`>= 5.*` |
| unsupported
(prior LTS) |  | `4.8.6` | `4.*` | `3.28` `4.4` `4.8` | `3.28.12`
`>= 4.*` |
| unsupported[^1] |  | `4.6.0` | `3.28` `4.*` | `3.28` `4.4` `4.5` `4.6` | `3.28.12`
`>= 4.*` |
| unsupported[^1]
(prior LTS) |  | `4.4.6` | `3.28` `4.*` | `3.28` `4.4` | `3.28.12`
`>= 4.*` |
[^1]: This version may receive special long-term patches to assist model-fragments users in creating a migration path onto 5.x and off of ModelFragments
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
## Code of Conduct
Refer to the [Code of Conduct](https://github.com/emberjs/data/blob/main/CODE_OF_CONDUCT.md) for community guidelines and inclusivity.
### License
This project is licensed under the [MIT License](LICENSE.md).