https://github.com/junosuarez/chai-interface
node module: chai assertions about an object's interface
https://github.com/junosuarez/chai-interface
Last synced: 2 months ago
JSON representation
node module: chai assertions about an object's interface
- Host: GitHub
- URL: https://github.com/junosuarez/chai-interface
- Owner: junosuarez
- License: mit
- Created: 2013-01-30T03:21:54.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2016-02-18T23:33:37.000Z (over 10 years ago)
- Last Synced: 2026-02-12T11:41:27.406Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 9.77 KB
- Stars: 7
- Watchers: 7
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# chai-interface
chai assertions about an object's interface
## installation
$ npm install chai-interface
## usage
```js
var chai = require('chai')
chai.should()
chai.use(require('chai-interface'))
var foo = {
bar: true,
baz: 'green',
qux: 37,
quack: function () {},
ducks: [1, 2, 3]
}
foo.should.have.interface({
bar: Boolean,
baz: String,
qux: Number,
quack: Function,
ducks: Array
})
```
Also, more complex, nested objects!
```js
var user = {
name: {
first: 'Betty',
last: 'Dodson'
},
emails: {
work: 'b.dodson@megacorp.com',
home: 'butterflychica947@lol.com',
school: 'bdodso4@stateu.edu'
}
}
user.should.have.interface({
name: {
first: String,
last: String
},
emails: {
work: String,
home: String,
school: String
}
})
```
## example error message
Interface not as expected:
{
"bars": {
"actual": "Array",
"expected": "Array",
"actualValue": [
"a",
"b",
"c"
]
}
}
## by the power of [tracery](https://github.com/AgileDiagnosis/tracery)
`chai-interface` does interface checking using `tracery`
## contributors
jden @leJDen
Please submit pull requests and issues through github.
## license
MIT
(c) 2013 Agile Diagnosis, Inc.
see LICENSE.md