https://github.com/oada/change
An implementation of OADA Change
https://github.com/oada/change
Last synced: 8 months ago
JSON representation
An implementation of OADA Change
- Host: GitHub
- URL: https://github.com/oada/change
- Owner: OADA
- Created: 2021-05-06T18:25:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-14T17:49:18.000Z (about 5 years ago)
- Last Synced: 2025-09-30T06:31:58.368Z (8 months ago)
- Language: TypeScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @oada/change
An implementation of OADA Change
## What is OADA Change?
OADA Change is a format that represents an idempotent change to an OADA document.
## Usage
### Applying a change
```typescript
import * as oadaChange from '@oada/change';
const document = { a: 1, b: 2, c: 3 };
const change = { b: 4, c: { _delete: true } };
const result = oadaChange.applyChange(document, change);
console.log(result) // { a: 1, b: 4 }
```
### Generating a change
```typescript
import * as oadaChange from '@oada/change';
const document1 = { a: 1, b: 2, c: 3 };
const document2 = { a: 1, b: 4 };
const change = oadaChange.generateChange(document1, document2);
console.log(change) // { b: 4, c: { _delete: true } }
```