diff options
| author | ruki <waruqi@gmail.com> | 2018-11-08 00:38:48 +0800 |
|---|---|---|
| committer | ruki <waruqi@gmail.com> | 2018-11-07 21:53:09 +0800 |
| commit | 26105034da4fcce7ac883c899d781f016559310d (patch) | |
| tree | c459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/hoek/README.md | |
| parent | 2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff) | |
| download | xmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip | |
switch to vuepress
Diffstat (limited to 'node_modules/hoek/README.md')
| -rw-r--r-- | node_modules/hoek/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/node_modules/hoek/README.md b/node_modules/hoek/README.md new file mode 100644 index 00000000..ec7bc253 --- /dev/null +++ b/node_modules/hoek/README.md @@ -0,0 +1,30 @@ + + +Utility methods for the hapi ecosystem. This module is not intended to solve every problem for everyone, but rather as a central place to store hapi-specific methods. If you're looking for a general purpose utility module, check out [lodash](https://github.com/lodash/lodash) or [underscore](https://github.com/jashkenas/underscore). + +[](http://travis-ci.org/hapijs/hoek) + +<a href="https://andyet.com"><img src="https://s3.amazonaws.com/static.andyet.com/images/%26yet-logo.svg" align="right" /></a> + +Lead Maintainer: [Nathan LaFreniere](https://github.com/nlf) + +**hoek** is sponsored by [&yet](https://andyet.com) + +## Usage + +The *Hoek* library contains some common functions used within the hapi ecosystem. It comes with useful methods for Arrays (clone, merge, applyToDefaults), Objects (removeKeys, copy), Asserting and more. + +For example, to use Hoek to set configuration with default options: +```javascript +const Hoek = require('hoek'); + +const default = {url : "www.github.com", port : "8000", debug : true}; + +const config = Hoek.applyToDefaults(default, {port : "3000", admin : true}); + +// In this case, config would be { url: 'www.github.com', port: '3000', debug: true, admin: true } +``` + +## Documentation + +[**API Reference**](API.md) |
