# breeze-client

> Breeze data management for JavaScript clients

Latest version **3.0.0** (published 2026-10-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install breeze-client
pnpm add breeze-client
yarn add breeze-client
bun add breeze-client
```

Provides the command `breeze-gen-entities`.

## Health

**Score 55/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

Negative: declining downloads.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2026-10-01 |
| First published | 2015-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=20 |
| Dependencies | 0 |
| Unpacked size | 2.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | IdeaBlade |
| Maintainers | jtraband, ideablade, wardbell, steveschmitt, marcelgood |
| Keywords | breeze, breezejs, spa, data binding, change tracking, query, linq, cache, graph, relational, orm, entity, model, typescript, esm |

## Links

- npm: https://www.npmjs.com/package/breeze-client
- Repository: https://github.com/Breeze/breeze-client-v3
- Homepage: https://github.com/Breeze/breeze-client-v3#readme
- Issues: https://github.com/Breeze/breeze-client-v3/issues
- npm.io page: https://npm.io/package/breeze-client

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2026-10-01
- 2.2.2 (mjs) — 2025-07-21
- 2.2.1-cjs (umd) — 2025-07-21
- 2.2.1 — 2025-07-21
- 2.2.0 — 2025-07-17
- 2.2.0-cjs — 2025-07-17
- 2.1.7-mjs — 2025-07-17
- 2.1.7 — 2025-07-17
- 2.1.6-mjs — 2025-07-02
- 2.1.6 — 2025-07-02
- 2.1.5-mjs — 2023-05-09
- 2.1.5 — 2023-05-09
- 2.1.4-mjs — 2023-01-02
- 2.1.4 — 2023-01-02
- 2.1.3-mjs — 2023-01-01
- … 58 more at https://npm.io/package/breeze-client/versions

## README

<p align="center"><a href="http://breeze.github.io/" target="_blank"><img src="http://breeze.github.io/images/logos/BreezeJsB.png" alt="Breeze" width="100"/></a></p>

# Breeze Data Management for JavaScript Clients

**Breeze** is a library from [IdeaBlade](https://www.ideablade.com/) that helps you manage
data in rich client applications. If you store data in a database, query and save it as
complex object graphs, and share those graphs across screens, 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 talk to any remote service that speaks HTTP and JSON.

> **This is breeze-client 3**, published to npm as `breeze-client` 3.0.0.
> 2.x is maintained in [breeze-client](https://github.com/Breeze/breeze-client).

## What v3 is

Same public API, rewritten for modern TypeScript, with a build you can read in one sitting.

- **ESM only**, one package, one npm tag. No CommonJS, no UMD, no `mjs`/`cjs` dist-tags.
- **One `tsc` invocation.** No ng-packagr, no second `node_modules`, no `downlevel-dts`.
- **No runtime dependencies.**
- **Knockout, jQuery, AngularJS and OData removed**, including CSDL/EDMX metadata parsing.
- Angular support moves to its own package so Angular and RxJS stay out of the core build.

Source is 42 files / 15,630 lines, down from 51 / 19,708.

## Documentation

| | |
|---|---|
| [UPGRADE.md](./UPGRADE.md) | **Converting an app from 2.x** — every consumer-facing change |
| [TESTING.md](./TESTING.md) | **Running the tests** — creating the database, starting the server |
| [DOCS.md](./DOCS.md) | **Building and viewing the docs** — the guides and the API reference |
| [BUILD-AND-PACK.md](./BUILD-AND-PACK.md) | **Packing the library and trying it in another app** without publishing |
| [CHANGES-DEV.md](./CHANGES-DEV.md) | Structural changes, for people working on Breeze itself |
| [STATUS.md](./STATUS.md) | What is done, what is in flight, what is next |

The user documentation is at [breeze.github.io/breeze-client-v3](https://breeze.github.io/breeze-client-v3/).
The 2.x documentation is still at [breeze.github.io/doc-js](https://breeze.github.io/doc-js/?v2).

## Install

```bash
npm install breeze-client
```

```ts
import { EntityManager, EntityQuery } from 'breeze-client';

const em = new EntityManager('/breeze/Northwind');
const { results } = await em.executeQuery(EntityQuery.from('Customers').take(10));
```

That is all a Breeze .NET server needs. There are no adapters to import or register, and
property names are camel-cased by default: `CompanyName` on the server is `companyName`
on the client. If your server already sends the names the client should use, call
`NamingConvention.none.setAsDefault()` at startup, before creating an `EntityManager`.
2.x defaulted to `none` — see [UPGRADE.md](./UPGRADE.md).

## Building

```bash
npm install
npm run typecheck     # tsc --noEmit
npm run build         # -> dist/
```

## Server

The .NET server lives in
[breeze-server-v3](https://github.com/Breeze/breeze-server-v3). The integration tests in
this repo run against it.

---

If you have discovered a bug or missing feature, please create an issue.

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:info@ideablade.com).

---
_Source: https://npm.io/package/breeze-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._