Skip to content

Commit

Permalink
Added info for parsing option renameHeaders to docs (#182)
Browse files Browse the repository at this point in the history
  • Loading branch information
asabhaney authored and doug-martin committed Apr 29, 2017
1 parent b1706d8 commit b4d3c92
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ All methods accept the following `options`
* `ignoreEmpty=false`: If you wish to ignore empty rows.
* `discardUnmappedColumns=false`: If you want to discard columns that do not map to a header.
* `strictColumnHandling=false`: If you want to consider empty lines/lines with too few fields as errors - Only to be used with `headers=true`
* `renameHeaders=false`: If you want the first line of the file to be removed and replaced by the one provided in the `headers` option - Only to be used with `headers=[String]`
* `delimiter=','`: If your data uses an alternate delimiter such as `;` or `\t`.
* **NOTE** When specifying an alternate `delimiter` you may only pass in a single character delimiter
* `quote='"'`: The character to use to escape values that contain a delimiter. If you set to `null` then all quoting will be ignored
Expand Down
24 changes: 12 additions & 12 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<link rel="stylesheet" href="./assets/css/bootstrap.min.css">
<link rel="stylesheet" href="./assets/css/prettify.css">
<style type="text/css">


/*.subnav-inner {*/
/*width: 100%;*/
Expand Down Expand Up @@ -138,31 +138,31 @@
<span class="icon-bar"></span>
<span class="icon-bar"> </span>
</a>

<a href="./index.html" class="brand">fast-csv</a>

<div class="nav-collapse">
<ul class="nav">

<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Docs<b class="caret"></b></a>
<ul class="dropdown-menu">

<li><a href="./History.html">Change Log</a></li>

</ul>







</ul>

<ul class="nav pull-right">

<li class="divider-vertical"></li>
<li><a href="https://github.com/C2FO/fast-csv" target="#github" class="pull-right">github</a></li>
</ul>

</div>
</div>
</div>
Expand Down Expand Up @@ -192,6 +192,7 @@ <h3 id="parsing">Parsing</h3>
<li><code>ignoreEmpty=false</code>: If you wish to ignore empty rows.</li>
<li><code>discardUnmappedColumns=false</code>: If you want to discard columns that do not map to a header.</li>
<li><code>strictColumnHandling=false</code>: If you want to consider empty lines/lines with too few fields as errors - Only to be used with <code>headers=true</code></li>
<li><code>renameHeaders=false</code>: If you want the first line of the file to be removed and replaced by the one provided in the <code>headers</code> option - Only to be used with <code>headers=[String]</code></li>
<li><code>delimiter=&#39;,&#39;</code>: If your data uses an alternate delimiter such as <code>;</code> or <code>\t</code>.<ul>
<li><strong>NOTE</strong> When specifying an alternate <code>delimiter</code> you may only pass in a single character delimiter</li>
</ul>
Expand Down Expand Up @@ -866,4 +867,3 @@ <h2 id="meta">Meta</h2>

</body>
</html>

0 comments on commit b4d3c92

Please sign in to comment.