https://github.com/breeze/breeze-client
Breeze for JavaScript clients
https://github.com/breeze/breeze-client
change-detection database entity orm query relational-databases
Last synced: 30 days ago
JSON representation
Breeze for JavaScript clients
- Host: GitHub
- URL: https://github.com/breeze/breeze-client
- Owner: Breeze
- License: mit
- Created: 2018-03-12T18:27:51.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-14T17:57:37.000Z (3 months ago)
- Last Synced: 2025-03-29T05:06:59.190Z (about 1 month ago)
- Topics: change-detection, database, entity, orm, query, relational-databases
- Language: TypeScript
- Homepage:
- Size: 841 KB
- Stars: 38
- Watchers: 12
- Forks: 18
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Breeze](http://breeze.github.io/doc-main/) Data Management for JavaScript Clients
**Breeze** is a library that helps you manage data in rich client applications. If you store data in a database, query and save those data as complex object graphs, and share these graphs across multiple screens of your JavaScript client, Breeze is for you.
Client-side querying, caching, dynamic object graphs, change tracking and notification, model validation, batch save, offline … all part of rich data management with Breeze. Breeze clients communicate with any remote service that speaks HTTP and JSON.
**Breeze** lets you develop applications using the same powerful idioms on the client and server. You can
- query with a rich query syntax
- navigate the graph of related entities
- track changes as you add/change/delete entities
- perform client-side validation
- save all changes in a single transaction
- use the same entity model on the server and client
## Install from npm
npm install breeze-client@mjs
or
npm install breeze-client
The version tagged `mjs` uses updated [Angular Package Format](https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/preview) and ES2020 .mjs modules. It has `esm2020` and `fesm2020` folders, but no UMD `bundles` folder.
If you want the latest module format, and don't care about UMD bundles, use `breeze-client@mjs`.
## Documentation
See the [docs](http://breeze.github.io/doc-js/features.html) for more info about what Breeze does and how to use it.
Set the [release notes](http://breeze.github.io/doc-js/release-notes.html) for changes in the latest version.
## Examples
See some [examples](https://github.com/Breeze/northwind-demo) of how to use breeze with Angular, Aurelia, React, and Vue in the [Northwind-Demo](https://github.com/Breeze/northwind-demo).
See the [TempHire](https://github.com/Breeze/temphire.angular) application for a richer example showing proper architectural patterns.
## Sources
The sources for this package are in the [breeze-client](https://github.com/Breeze/breeze-client) repo. Please file issues and pull requests against that repo.
## Upgrading Breeze
See the [UPGRADE](https://github.com/Breeze/breeze-client/blob/master/UPGRADE.md) document for information on upgrading from Breeze 1.x to 2.x.
## Building Breeze
See the [BUILD](https://github.com/Breeze/breeze-client/blob/master/BUILD.md) document for instructions on building the Breeze and its API docs.
If you have discovered a bug or missing feature, please create an issue in the [breeze-client github repo](https://github.com/Breeze/breeze-client).
If you have questions about using Breeze, please ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/breeze).
If you need help developing your application, please contact us at [IdeaBlade](mailto:[email protected]).