diff options
Diffstat (limited to 'node_modules/only/Readme.md')
| -rw-r--r-- | node_modules/only/Readme.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/node_modules/only/Readme.md b/node_modules/only/Readme.md new file mode 100644 index 00000000..48130d9b --- /dev/null +++ b/node_modules/only/Readme.md @@ -0,0 +1,58 @@ + +# only + + Return whitelisted properties of an object. + +## Installation + + $ npm install only + +## API + + An array or space-delimited string may be given: + +```js +var obj = { + name: 'tobi', + last: 'holowaychuk', + email: 'tobi@learnboost.com', + _id: '12345' +}; + +var user = only(obj, 'name last email'); +``` + +yields: + +```js +{ + name: 'tobi', + last: 'holowaychuk', + email: 'tobi@learnboost.com' +} +``` + +## License + +(The MIT License) + +Copyright (c) 2012 TJ Holowaychuk <tj@vision-media.ca> + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +'Software'), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file |
