Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tnfe/jscalpel
A small feature library that makes it easier to manipulate objects
https://github.com/tnfe/jscalpel
es6 javascript jscalpel object objects parser path react vue
Last synced: 12 days ago
JSON representation
A small feature library that makes it easier to manipulate objects
- Host: GitHub
- URL: https://github.com/tnfe/jscalpel
- Owner: tnfe
- License: mit
- Created: 2017-09-05T07:57:36.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T06:42:16.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T15:41:01.877Z (20 days ago)
- Topics: es6, javascript, jscalpel, object, objects, parser, path, react, vue
- Language: JavaScript
- Homepage: https://tnfe.github.io/jscalpel/
- Size: 1.39 MB
- Stars: 27
- Watchers: 5
- Forks: 8
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A small feature library that makes it easier to manipulate objects
[](https://www.npmjs.org/package/jscalpel)
[](https://npmjs.org/package/jscalpel)
## Overview
It is tiny but very useful and can help you handle javascript native objects. Data-driven interface development is very common today, we are in the [angular](https://github.com/angular/angular), [react](http://www.github.com/facebook/react), [vue](http://www.github.com/vuejs/vue) will encounter a lot of object processing, including set the default value, query, assignment, etc., [jscalpel](http://www.github.com/tnfe/jscalpel) is born for this scene.
jscalpel is little poor, gzip less than **3k**, so a library you can use it anytime, anywhere without worrying about anything.
## Document
#### View the document please visit [https://tnfe.github.io/jscalpel/](https://tnfe.github.io/jscalpel/)
[中文文档](https://tnfe.github.io/jscalpel/index_zh.html)
## Installation
#### Install using npm
[](https://npmjs.org/package/jscalpel)
```
npm install jscalpel --save
yarn add jscalpel --save
```
## Useage
#### Es6
```javascript
import Jscalpel from 'jscalpel'
```
#### Include in html
```javascript
```
## APIS
parameter
type
default value
use
isRequired
required version
target
string/object
{}
target
true
all
deep
boolean
false
whether or not to copy the target object in depth
false
all
prefix
string
undefined
public prefix, automatically added for the keys
false
all
success
function
function () {}
The function that was called when the analysis was successful
true
^0.6.2
error
function
function () {}
The function that is called when the analysis fails.
false
^0.6.2
path
string/array/function
[]
path
false
^0.6.2
plugins
array
[]
A plug-in set, similar to the webpack plugins.
false
^0.6.2
## [Online Demos](https://jsfiddle.net/as3tLkdy/27/?utm_source=website&utm_medium=embed&utm_campaign=as3tLkdy)
## Code
#### 1. simple pattern
```javascript
// mock data
var data = {
status: '0',
data: {
response: {
code: 1,
msg: 'response msg'
}
}
}
// super easy
jscalpel.get(data, 'data.response.code'); // return 1
// deep copy object
jscalpel.toCopy(data) !== data; // return true;
jscalpel.set(data, 'data.response.code', 0);
jscalpel.get(data, 'data.response.code') // return 0;
// bind data
var jscalpelIns = jscalpel({
target: data
})
jscalpelIns.get('data.response.code') // returned 1;
jscalpelIns.set('data.response.code', 12);
jscalpelIns.set({
'status': '1'
})
jscalpelIns.get('data.response.code') // returned 12
jscalpelIns.get('status') // returned 1
jscalpelIns.has('data.response.code') // returned true
jscalpelIns.del('data.reponse.code')
jscalpelIns.get('data.reponse.code') // returned undefined;
jscalpelIns.has('data.reponse.code') // returned false;
```
#### 2.advanced patterns
```
const res = {
data: {
article: [{
articleId: 0,
title: 'jscalpel'
}]
},
response: {
code: '0',
msg: 'success'
}
}
jscalpel({
target: res,
path: ['data.article.0', 'response.msg'],
success: (article, msg) => {
console.log('keys=>array=>output:', article, msg);
}
})
jscalpel({
target: res,
path: 'response.msg',
success: (msg) => {
console.log('keys=>string=>output:',msg);
}
});
```
#### 3.use prefix
```
jscalpel({
target: res,
prefix: 'response',
path: ['code', 'msg'],
success: (code, msg) => {
console.log('prefix=>output:', code, msg);
}
})
```
#### 4.dynamic path
```
jscalpel({
target: res,
path: () => ['code', 'msg'].map((key) => `response.${key}`),
success: (code, msg) => {
console.log('dynamic=>output:', code, msg);
}
})
jscalpel({
target: res,
deep: true,
prefix: 'response',
path: ['code', 'msg'],
success: (code, msg, finalRes, keys) => {
console.log( finalRes === res);
console.log('deep into callback:', code, msg, finalRes, keys);
}
});
```
#### 5.use plugins
```
const logicMap = {
'code': {
match: ({value, name}) => value === '0',
success: ({value, name}) => {
console.log('logicPlugin', value, name);
}
}
}
jscalpel({
target: res,
deep: true,
prefix: 'response',
path: ['code', 'msg'],
plugins: [jscalpel.jscalpelType, jscalpel.jscalpelLogic(logicMap)],
success: (code, msg, finalRes, keys) => {
console.log( finalRes === res);
console.log('deep into callback:', code, msg, finalRes, keys);
}
})
```
## Related projects
[jscalpel-orm](https://github.com/tnfe/jscalpel-orm)
It is convenient for you to extract the required fields from one object to generate another object.
## Changelog
#### 2017.9.14
Add jscalpelLogic plugin, reduce ifelse, make run logic configurable
#### 2018.3.08
add orm
#### 2018.9.04
add get method
```javascript
import { get } from 'jscalpel';
// get(data, path ,defaultValue);
```
#### 2018.12.30
```javascript
import { set, get, toCopy } from 'jscalpel';
// deep copy object
toCopy(data) !== data; // return true;
// set path value
set(data, 'data.response.code', 0);
get(data, 'data.response.code') // return 0;
```
#### 2021.8.31
publish 2.0.0
## License
[The MIT License](https://opensource.org/licenses/MIT).