# @orbit/record-cache

> Orbit base classes used to access and maintain a set of records.

Latest version **0.17.2** (published 2022-03-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @orbit/record-cache
pnpm add @orbit/record-cache
yarn add @orbit/record-cache
bun add @orbit/record-cache
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.17.2 |
| Published | 2022-03-06 |
| First published | 2019-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2340 |
| Maintainers | dgeb |
| Keywords | orbit, orbit.js, data, synchronization |

## Links

- npm: https://www.npmjs.com/package/@orbit/record-cache
- Repository: https://github.com/orbitjs/orbit
- Homepage: https://github.com/orbitjs/orbit#readme
- Issues: https://github.com/orbitjs/orbit/issues
- npm.io page: https://npm.io/package/@orbit/record-cache

## Dependencies (4)

- [@orbit/core](https://npm.io/package/@orbit/core.md) ^0.17.0
- [@orbit/data](https://npm.io/package/@orbit/data.md) ^0.17.0
- [@orbit/utils](https://npm.io/package/@orbit/utils.md) ^0.17.0
- [@orbit/records](https://npm.io/package/@orbit/records.md) ^0.17.0

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 0.17.2 (latest) — 2022-03-06
- 0.17.0-beta.26 (beta) — 2022-01-22
- 0.17.0 — 2022-01-31
- 0.17.0-beta.25 — 2021-08-12
- 0.17.0-beta.24 — 2021-07-26
- 0.17.0-beta.23 — 2021-07-18
- 0.17.0-beta.22 — 2021-07-16
- 0.17.0-beta.21 — 2021-07-07
- 0.17.0-beta.20 — 2021-07-04
- 0.17.0-beta.19 — 2021-07-03
- 0.17.0-beta.18 — 2021-06-22
- 0.17.0-beta.17 — 2021-06-11
- 0.17.0-beta.16 — 2021-05-22
- 0.17.0-beta.14 — 2021-02-22
- 0.17.0-beta.13 — 2021-02-22
- … 29 more at https://npm.io/package/@orbit/record-cache/versions

## README

# @orbit/record-cache

A record cache is an abstraction used to access and maintain a set of records.

Record caches should extend one of the following base classes:

- `SyncRecordCache` - when records can be accessed synchronously

- `AsyncRecordCache` - when records must be accessed asynchronously

## Installation

Install with yarn:

```
yarn add @orbit/record-cache
```

Or with npm:

```
npm install @orbit/record-cache
```

## Contributing

### Installation

To install dependencies:

```
yarn install
```

### Building

Distributions can be built to the `/dist` directory by running:

```
yarn build
```

### Testing

#### CI Testing

Test in CI mode by running:

```
yarn test
```

#### Browser Testing

Test within a browser
(at [http://localhost:8080/](http://localhost:8080/)) by running:

```
yarn start
```

## License

Copyright 2014-2021 Cerebris Corporation. MIT License (see LICENSE for details).

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