kickable
v1.0.0
Published
Kickable is a service meant to answer the question "Can I Kick It?"
Downloads
2
Readme
kickable
kickable is a microservice built to answer the age old question, "Can I Kick It?"
What is a kickable?
Currently only the word "it" is kickable.
| NPM | Builds | Coverage | Vulnerabilities | | :------------- | :------------- | :------------- | :------------- | | | | | | | | | | | | | |
Installation
Requires Node.js 6+, iojs is not currently supported
$ npm install kickable --save
Build Documentation
Outputs code documentation files to the ./doc/api
folder.
$ npm run doc
$ npm run analyze
Test + Coverage
Outputs code coverage files to the ./doc/coverage
folder.
$ npm run test
CURRENT COVERAGE REPORT
API
api.kick(it)
Returns true if the string it
is determined to be kickable.
parameters:
- it {String} The value to determine as kickable
returns: {Bool} true if it
is determined to be kickable, otherwise false.
What's next?
- Case Insensitivity
- Support for configuring kickable items other than
it
. - Return true if the item is known to be a kickable noun, ie. ball, wall, door; otherwise false ( sky, feelings, comments )"
Discuss
Builds
Coverage
Vulnerabilities
Questions or comments can also be posted on the kickable Github issues page.
Maintainers
Hector Gray (Twitter: @defstream)
Contribute
Pull Requests welcome. Please make sure all tests pass:
$ npm test
Please submit Github issues for any feature enhancements, bugs or documentation problems.
License
MIT