summaryrefslogtreecommitdiff
path: root/node_modules/hoek/README.md
diff options
context:
space:
mode:
authorArman Shah <[email protected]>2018-02-19 23:50:04 -0800
committerArman Shah <[email protected]>2018-02-19 23:50:04 -0800
commitae34dcfd3823a609ba7182f2d6eda593be876f7d (patch)
treeb9d7f2884c4999349418cbdc4f9ab46d113e0afd /node_modules/hoek/README.md
parentInitial commit (diff)
downloadlauncher-ae34dcfd3823a609ba7182f2d6eda593be876f7d.tar.xz
launcher-ae34dcfd3823a609ba7182f2d6eda593be876f7d.zip
add base files
Diffstat (limited to 'node_modules/hoek/README.md')
-rw-r--r--node_modules/hoek/README.md30
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 0000000..ec7bc25
--- /dev/null
+++ b/node_modules/hoek/README.md
@@ -0,0 +1,30 @@
+![hoek Logo](https://raw.github.com/hapijs/hoek/master/images/hoek.png)
+
+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).
+
+[![Build Status](https://secure.travis-ci.org/hapijs/hoek.svg)](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)