From 108d91ceccba3570272fa2a297aa3cbc728b0911 Mon Sep 17 00:00:00 2001 From: janisdd Date: Thu, 7 Feb 2019 19:29:57 +0100 Subject: [PATCH] - added table for unparse config options (#628) --- docs/docs.html | 85 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 77 insertions(+), 8 deletions(-) diff --git a/docs/docs.html b/docs/docs.html index 59c87d5..f84d0ad 100644 --- a/docs/docs.html +++ b/docs/docs.html @@ -228,7 +228,7 @@
- 
Papa.unparse(data[, config])
+ 
Papa.unparse(data[, config])
@@ -243,19 +243,88 @@
  • - config is an optional object with any of these properties: - 
    // defaults shown
+								config is an optional config object
+
    • + +
    +
    + +
    +
    Default Unparse Config with all options
    +
    + +
    + 
    
 {
-	quotes: false,
+	quotes: false, //or array of booleans
 	quoteChar: '"',
 	delimiter: ",",
 	header: true,
 	newline: "\r\n",
 	skipEmptyLines: false, //or 'greedy'
-}
    - Set quotes to true to always enclose each field in quotes, or an array of true/false values correlating to specific to columns to force-quote. The character used to quote can be customized using quoteChar. The delimiter can be any valid delimiting character. The newline character(s) may also be customized. Setting header to false will omit the header row. Setting skipEmptyLines to true will skip completely empty rows (those which evaluate to an empty string). If set to 'greedy', rows that don't have any content (those which have only whitespace after unparsing) will also be skipped.     - - +} + +
    + +
    + +
    +
    Unparse Config Options
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    OptionExplanation
    + quotes + + If true, forces all fields to be enclosed in quotes. If an array of true/false values, specifies which fields should be force-quoted (first boolean is for the first column, second boolean for the second column, ...). +
    quoteChar + The character used to quote fields. +
    + delimiter + + The delimiting character. It must not be found in Papa.BAD_DELIMITERS. +
    + header + + If false, will omit the header row. If data is an array of arrays this option is ignored. If data is an array of objects the keys of the first object are the header row. If data is an object with the keys fields and data the fields are the header row. +
    + newline + + The newline sequence. Must be one of "\r", "\n", or "\r\n". +
    + skipEmptyLines + + If true, lines that are completely empty (those which evaluate to an empty string) will be skipped. If set to 'greedy', lines that don't have any content (those which have only whitespace after parsing) will also be skipped. +