Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(471)

Unified Diff: node_modules/vulcanize/node_modules/update-notifier/node_modules/latest-version/node_modules/package-json/node_modules/registry-url/node_modules/rc/node_modules/ini/README.md

Issue 877193002: Upgrade vulcanize to 0.7.6. (Closed) Base URL: https://chromium.googlesource.com/infra/third_party/npm_modules.git@master
Patch Set: Created 5 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: node_modules/vulcanize/node_modules/update-notifier/node_modules/latest-version/node_modules/package-json/node_modules/registry-url/node_modules/rc/node_modules/ini/README.md
diff --git a/node_modules/vulcanize/node_modules/update-notifier/node_modules/latest-version/node_modules/package-json/node_modules/registry-url/node_modules/rc/node_modules/ini/README.md b/node_modules/vulcanize/node_modules/update-notifier/node_modules/latest-version/node_modules/package-json/node_modules/registry-url/node_modules/rc/node_modules/ini/README.md
index acbe8ec895fb587320f18163f4312bc21de18785..33df258297db7f8d9ee8fa27899e5e617a270d03 100644
--- a/node_modules/vulcanize/node_modules/update-notifier/node_modules/latest-version/node_modules/package-json/node_modules/registry-url/node_modules/rc/node_modules/ini/README.md
+++ b/node_modules/vulcanize/node_modules/update-notifier/node_modules/latest-version/node_modules/package-json/node_modules/registry-url/node_modules/rc/node_modules/ini/README.md
@@ -1,7 +1,7 @@
An ini format parser and serializer for node.
-Sections are treated as nested objects. Items before the first heading
-are saved on the object directly.
+Sections are treated as nested objects. Items before the first
+heading are saved on the object directly.
## Usage
@@ -34,40 +34,62 @@ You can read, manipulate and write the ini-file like so:
delete config.paths.default.datadir
config.paths.default.array.push('fourth value')
- fs.writeFileSync('./config_modified.ini', ini.stringify(config, 'section'))
+ fs.writeFileSync('./config_modified.ini', ini.stringify(config, { section: 'section' }))
-This will result in a file called `config_modified.ini` being written to the filesystem with the following content:
+This will result in a file called `config_modified.ini` being written
+to the filesystem with the following content:
[section]
- scope = local
+ scope=local
[section.database]
- user = dbuser
- password = dbpassword
- database = use_another_database
+ user=dbuser
+ password=dbpassword
+ database=use_another_database
[section.paths.default]
- tmpdir = /tmp
- array[] = first value
- array[] = second value
- array[] = third value
- array[] = fourth value
+ tmpdir=/tmp
+ array[]=first value
+ array[]=second value
+ array[]=third value
+ array[]=fourth value
## API
### decode(inistring)
+
Decode the ini-style formatted `inistring` into a nested object.
### parse(inistring)
+
Alias for `decode(inistring)`
-### encode(object, [section])
-Encode the object `object` into an ini-style formatted string. If the optional parameter `section` is given, then all top-level properties of the object are put into this section and the `section`-string is prepended to all sub-sections, see the usage example above.
+### encode(object, [options])
-### stringify(object, [section])
-Alias for `encode(object, [section])`
+Encode the object `object` into an ini-style formatted string. If the
+optional parameter `section` is given, then all top-level properties
+of the object are put into this section and the `section`-string is
+prepended to all sub-sections, see the usage example above.
+
+The `options` object may contain the following:
+
+* `section` A string which will be the first `section` in the encoded
+ ini data. Defaults to none.
+* `whitespace` Boolean to specify whether to put whitespace around the
+ `=` character. By default, whitespace is omitted, to be friendly to
+ some persnickety old parsers that don't tolerate it well. But some
+ find that it's more human-readable and pretty with the whitespace.
+
+For backwards compatibility reasons, if a `string` options is passed
+in, then it is assumed to be the `section` value.
+
+### stringify(object, [options])
+
+Alias for `encode(object, [options])`
### safe(val)
-Escapes the string `val` such that it is safe to be used as a key or value in an ini-file. Basically escapes quotes. For example
+
+Escapes the string `val` such that it is safe to be used as a key or
+value in an ini-file. Basically escapes quotes. For example
ini.safe('"unsafe string"')
@@ -76,4 +98,5 @@ would result in
"\"unsafe string\""
### unsafe(val)
+
Unescapes the string `val`

Powered by Google App Engine
This is Rietveld 408576698