BlueGit

blue-star danique-bot

Files

danique-bot / node_modules / options / README.md

README.md

Import template
timfa Tim · pushed by timfa · 4 years ago
c788ad20 History
README.md 2.1 KiB Download Raw

options.js #

A very light-weight in-code option parsers for node.js.

Usage ##

var Options = require("options");

// Create an Options object
function foo(options) {
        var default_options = {
                foo : "bar"
        };
        
        // Create an option object with default value
        var opts = new Options(default_options);
        
        // Merge options
        opts = opts.merge(options);
        
        // Reset to default value
        opts.reset();
        
        // Copy selected attributes out
        var seled_att = opts.copy("foo");
        
        // Read json options from a file. 
        opts.read("options.file"); // Sync
        opts.read("options.file", function(err){ // Async
                if(err){ // If error occurs
                        console.log("File error.");
                }else{
                        // No error
                }
        });
        
        // Attributes defined or not
        opts.isDefinedAndNonNull("foobar");
        opts.isDefined("foobar");
}

License ##

(The MIT License)

Copyright (c) 2012 Einar Otto Stangvik <einaros@gmail.com>

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.

Source
1# options.js #
2
3A very light-weight in-code option parsers for node.js.
4
5## Usage ##
6
7``` js
8var Options = require("options");
9
10// Create an Options object
11function foo(options) {
12 var default_options = {
13 foo : "bar"
14 };
15
16 // Create an option object with default value
17 var opts = new Options(default_options);
18
19 // Merge options
20 opts = opts.merge(options);
21
22 // Reset to default value
23 opts.reset();
24
25 // Copy selected attributes out
26 var seled_att = opts.copy("foo");
27
28 // Read json options from a file.
29 opts.read("options.file"); // Sync
30 opts.read("options.file", function(err){ // Async
31 if(err){ // If error occurs
32 console.log("File error.");
33 }else{
34 // No error
35 }
36 });
37
38 // Attributes defined or not
39 opts.isDefinedAndNonNull("foobar");
40 opts.isDefined("foobar");
41}
42
43```
44
45
46## License ##
47
48(The MIT License)
49
50Copyright (c) 2012 Einar Otto Stangvik <einaros@gmail.com>
51
52Permission is hereby granted, free of charge, to any person obtaining
53a copy of this software and associated documentation files (the
54'Software'), to deal in the Software without restriction, including
55without limitation the rights to use, copy, modify, merge, publish,
56distribute, sublicense, and/or sell copies of the Software, and to
57permit persons to whom the Software is furnished to do so, subject to
58the following conditions:
59
60The above copyright notice and this permission notice shall be
61included in all copies or substantial portions of the Software.
62
63THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
64EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
65MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
66IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
67CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
68TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
69SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.