https://github.com/nuintun/inspect-attrs
An object attributes inspect tool.
https://github.com/nuintun/inspect-attrs
Last synced: 11 months ago
JSON representation
An object attributes inspect tool.
- Host: GitHub
- URL: https://github.com/nuintun/inspect-attrs
- Owner: nuintun
- License: mit
- Created: 2018-03-26T03:48:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-28T06:30:09.000Z (over 7 years ago)
- Last Synced: 2025-07-05T08:03:12.286Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# inspect-attrs
> An object attributes inspect tool.
>
> [![NPM Version][npm-image]][npm-url]
> [![Download Status][download-image]][npm-url]
> [![Linux Status][travis-image]][travis-url]
> [![Windows Status][appveyor-image]][appveyor-url]
> [![Test Coverage][coveralls-image]][coveralls-url]
> ![Node Version][node-image]
> [![Dependencies][david-image]][david-url]
# API
> `inspectAttrs(source: Object, rules: Object)`
>
> * `source`: The target object
> * `rules`: The inspect rules
> * `required`: `Boolean` Set attr is required
> * `type`: `String|Array` Set attr type
> * `default`: `Any` Set attr default value
> * `onRequired`: `String` Set custom required error message, `%s` equal the attr
> * `onTypeError`: `String` Set custom type error message, `%s` equal the attr
# Example
```js
import inspectAttrs from 'inspect-attrs';
let options = {};
options = inspectAttrs(options, {
root: {
type: String,
required: true
},
'css.loader': {
default: null,
type: [Function, null]
}
});
```
[travis-image]: http://img.shields.io/travis/nuintun/inspect-attrs.svg?style=flat-square&label=linux
[travis-url]: https://travis-ci.org/nuintun/inspect-attrs
[npm-image]: https://img.shields.io/npm/v/inspect-attrs.svg?style=flat-square
[npm-url]: https://www.npmjs.org/package/inspect-attrs
[download-image]: https://img.shields.io/npm/dm/inspect-attrs.svg?style=flat-square
[appveyor-image]: https://img.shields.io/appveyor/ci/nuintun/inspect-attrs/master.svg?style=flat-square&label=windows
[appveyor-url]: https://ci.appveyor.com/project/nuintun/inspect-attrs
[coveralls-image]: http://img.shields.io/coveralls/nuintun/inspect-attrs/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/nuintun/inspect-attrs?branch=master
[david-image]: https://img.shields.io/david/dev/nuintun/inspect-attrs/master.svg?style=flat-square
[david-url]: https://david-dm.org/nuintun/inspect-attrs?type=dev
[node-image]: https://img.shields.io/node/v/inspect-attrs.svg?style=flat-square