57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
|
|
||
|
|
# configurable
|
||
|
|
|
||
|
|
Configuration mixin.
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
Make something configurable:
|
||
|
|
|
||
|
|
```js
|
||
|
|
var Configurable = require('configurable');
|
||
|
|
|
||
|
|
// plain obj
|
||
|
|
var obj = {};
|
||
|
|
Configurable(obj);
|
||
|
|
|
||
|
|
// returns the obj itself
|
||
|
|
var obj = Configurable({});
|
||
|
|
|
||
|
|
// make a prototype configurable
|
||
|
|
Configurable(MyThing.prototype);
|
||
|
|
```
|
||
|
|
|
||
|
|
```js
|
||
|
|
.get(name)
|
||
|
|
.set(name, val)
|
||
|
|
.set(obj)
|
||
|
|
.enable(name)
|
||
|
|
.disable(name)
|
||
|
|
.enabled(name)
|
||
|
|
.disabled(name)
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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.
|