Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fwh1990/data-commander
Migrate data from schema.
https://github.com/fwh1990/data-commander
Last synced: about 4 hours ago
JSON representation
Migrate data from schema.
- Host: GitHub
- URL: https://github.com/fwh1990/data-commander
- Owner: fwh1990
- License: mit
- Created: 2021-06-21T06:45:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-31T02:10:50.000Z (about 3 years ago)
- Last Synced: 2024-10-29T15:13:35.531Z (17 days ago)
- Language: TypeScript
- Homepage:
- Size: 244 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# data-commander
Migrate data from schema.
[](https://github.com/fwh1990/data-commander/blob/main/LICENSE)
[](https://github.com/fwh1990/data-commander/actions)
[](https://codecov.io/gh/fwh1990/data-commander)
[](https://www.npmjs.com/package/data-commander)
# Installation
```bash
yarn add data-commander
```
# Usage
## Migrate
```typescript
import { Commander, SetCommand, DeleteCommand } from 'data-commander';
const data = {
x: 1,
y: 2,
};
const commander = new Commander([
new SetCommand(['x'], 10),
new DeleteCommand(['y']),
]);
commander.execute(data);
console.log(data); // { x: 10 }
```
# Create Schema
```typescript
const data = {
x: 1,
y: 2,
};
const commander = new Commander([
new SetCommand(['x'], 10),
new DeleteCommand(['y']),
]);
const schema = commander.execute({});
// {
// up: [
// { type: 'set', path: ['x'], data: 10 },
// { type: 'delete', path: ['y'], data: null }
// ],
// down: [
// {type: 'set', path: ['y'], data: 2 },
// { type: 'set', path: ['x'], data: 1 }
// ],
// id: 'c5rgDxMM_pML9079'
// }
```
## Migrate or Revert
```typescript
const data = {
x: 1,
y: 2,
};
const commander = new Commander([
new SetCommand(['x'], 10),
new DeleteCommand(['y']),
]);
const schema = commander.execute(data);
console.log(data); // { x: 10 }
Commander.fromSchema(schema).revert(data);
console.log(data); // { x: 1, y: 2 }
Commander.fromSchema(schema).migrate(data);
console.log(data); // { x: 10 }
```
# Commands
## SetCommand
Set a value to specific path.
```typescript
const data = {};
const commander = new Commander([
new SetCommand(['test'], { hello: 'world' })
]);
commander.execute(data);
console.log(data); // { test: { hello: 'world' } }
```
## DeleteCommand
Delete a specific object property or array item.
```typescript
const data = { a: 1, b: 2 };
const commander = new Commander([
new DeleteCommand(['a'])
]);
commander.execute(data);
console.log(data); // { b: 2 }
```
## InsertCommand
Insert an item to array with specific index.
```typescript
const data = ['a', 'b'];
const commander = new Commander([
new InsertCommand(['1'], 'c')
]);
commander.execute(data);
console.log(data); // ['a', 'c', 'b']
commander.execute(data);
console.log(data); // ['a', 'c', 'c', 'b']
```
## LpushCommand
Left push an item to array.
```typescript
const data = ['a', 'b'];
const commander = new Commander([
new LpushCommand([], 'c')
]);
commander.execute(data);
console.log(data); // ['c', 'a', 'b']
commander.execute(data);
console.log(data); // ['c', 'c', 'a', 'b']
```
## RpushCommand
Right push an item to array.
```typescript
const data = ['a', 'b'];
const commander = new Commander([
new RpushCommand([], 'c')
]);
commander.execute(data);
console.log(data); // ['a', 'b', 'c']
commander.execute(data);
console.log(data); // ['a', 'b', 'c', 'c']
```
## MergeCommand
Merge deep object to another object.
```typescript
const data = {
x: {
y: 1,
z: 3,
},
};
const commander = new Commander([
new MergeCommand({
x: {
y: 2,
m: {
n: 4,
},
},
}),
]);
commander.execute(data);
console.log(data);
// {
// x: {
// y: 2,
// z: 3,
// m: {
// n: 4
// }
// }
// }
```
OR merge an array item.
```typescript
const data = ['a', 'b'];
const commander = new Commander([
new MergeCommand(['4': 'c']),
]);
commander.execute(data);
console.log(data); // [ 'a', 'b', , , 'c' ]
```