You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update overviews with recent library improvements (#9777)
* docs: update overviews with recent library improvements
* make docs preview even easier
* update more docs
* begin adding ember docs
* add all the docs
-[Removing inspector support in production](#removing-inspector-support-in-production)
52
-
-[Debugging](#debugging)
53
-
-[Contributing](#contributing)
54
-
55
-
# Overview
56
-
57
-
*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.
*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.
70
-
71
-
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.
72
-
73
-
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 suite their needs. This makes *Ember***Data** a powerful solution for applications regardless of their size and complexity.
74
-
75
-
*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.
76
-
77
-
*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.
@@ -91,101 +92,33 @@ not wish to use `ember-data`, remove `ember-data` from your project's `package.j
91
92
92
93
## Advanced Installation
93
94
94
-
*Ember***Data** is organized into primitives that compose together via public APIs.
95
-
96
-
-[@ember-data/request](./packages/request) provides managed `fetch` via its RequestManager and can be used without any other parts of EmberData.
97
-
-[@ember-data/store](./packages/store) is the "core" of EmberData and handles coordination between the RequestManager, the Cache, and Presentation Concerns.
98
-
-[@ember-data/tracking](./packages/tracking) is currently required when using the core and provides tracking primitives for change notification of Tracked properties.
99
-
-[@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`
100
-
-[@ember-data/model](./packages/model) is a presentation layer, it integrates with the store via the hooks `instantiateRecord` and `teardownRecord`.
101
-
-[@ember-data/debug](./packages/debug) provides (optional) debugging support for the `ember-inspector`.
102
-
103
-
104
-
Some EmberData APIs are older than others, and these still interop via well-defined public API boundaries but are
105
-
no longer the ideal approach.
106
-
107
-
-[@ember-data/legacy-compat](./packages/legacy-compat) provides support for older paradigms that are being phased out
108
-
-[@ember-data/adapter](./packages/adapter) provides various network API integrations for APIS built over specific REST or JSON:API conventions. It integrates with the Store via `store.adapterFor`, and with the request pipeline via the `LegacyNetworkHandler` available via `@ember-data/legacy-compat` which utilizes the Minimum Adapter Interface.
109
-
-[@ember-data/serializer](./packages/serializer) pairs with `@ember-data/adapter` and the `LegacyNetworkHandler` to normalize and serialize data to and from an API format into the `JSON:API` format understood by `@ember-data/json-api`.
95
+
*Ember***Data** is organized into primitives that compose together via public APIs. These primitives are organized into
96
+
small packages encapsulating these boundaries. These packages
-[@ember-data/request-utils](../packages/request-utils) provides optional utilities for managing requests and string manipulation
102
+
-[@ember-data/store](../packages/store) provides core functionality around coordinating caching and reactivity
103
+
-[@ember-data/tracking](../packages/tracking) enables integration with Ember's reactivity system
104
+
-[@ember-data/json-api](../packages/json-api) provides a cache for data in the [{JSON:API}](https://jsonapi.org) format.
105
+
-[@ember-data/debug](../packages/debug) provides (optional) debugging support for the `ember-inspector`.
106
+
-[@warp-drive/build-config](../packages/build-config) provides a build plugin which ensures proper settings configuration for deprecations, optional features, development/testing support and debug logging.
107
+
-[@warp-drive/core-types](../packages/core-types) provides core types and symbols used by all other packages
108
+
-[@warp-drive/schema-record](../packages/schema-record) provides a flexible, schema-based approach to reactive data.
109
+
-[@warp-drive/ember](../packages/ember) provides Ember specific components and utilities for reactive control-flow and declarative state management.
110
+
111
+
Some EmberData APIs are older than others, and these still interop via well-defined
112
+
public API boundaries but are no longer the ideal approach.
113
+
114
+
-[@ember-data/model](../packages/model) provides a class-based approach to declaring schemas for reactive data.
115
+
-[@ember-data/legacy-compat](../packages/legacy-compat) provides support for the older adapter/serializer request paradigm that is being phased out
116
+
-[@ember-data/adapter](../packages/adapter) provides various network API integrations for APIs built over specific REST or `{JSON:API}` conventions.
117
+
-[@ember-data/serializer](../packages/serializer) provides an approach to normalizing and serializing data to and from an API format into the `{JSON:API}` format.
110
118
111
119
And finally:
112
120
113
-
-[ember-data](./packages/-ember-data) is a "meta" package which bundles all of these together for convenience
114
-
115
-
The packages interop with each other through well defined public API boundaries. The core
116
-
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
117
-
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.
118
-
119
-
## Configuration
120
-
121
-
### Deprecation Stripping
122
-
123
-
*Ember***Data** allows users to opt-in and remove code that exists to support deprecated behaviors.
124
-
125
-
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.
*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
140
-
the necessary feature if your browser support or deployment environment demands it. To
141
-
activate this polyfill:
142
-
143
-
```ts
144
-
let app =newEmberApp(defaults, {
145
-
emberData: {
146
-
polyfillUUID: true,
147
-
},
148
-
});
149
-
```
150
-
151
-
### removing inspector support in production
152
-
153
-
If you do not want to ship inspector support in your production application, you can specify
154
-
that all support for it should be stripped from the build.
0 commit comments