From a3a09146cec58231aa43e16a9cb7c55b0dac470b Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Thu, 27 Nov 2014 20:38:25 -0700 Subject: [PATCH] Fixed docs (issue #122) and removed unnecessary .html extensions --- demo.html | 8 ++++---- docs.html | 12 ++++++------ faq.html | 14 +++++++------- index.html | 12 ++++++------ 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/demo.html b/demo.html index 1362fb4..5a7c41d 100644 --- a/demo.html +++ b/demo.html @@ -22,10 +22,10 @@ GitHub - + Demo - + Docs @@ -35,7 +35,7 @@
- + FAQ @@ -189,7 +189,7 @@   Get Papa Parse on GitHub - +   Documentation
diff --git a/docs.html b/docs.html index e327518..36d006d 100644 --- a/docs.html +++ b/docs.html @@ -20,10 +20,10 @@ GitHub - + Demo - + Docs
@@ -33,7 +33,7 @@
- + FAQ @@ -333,14 +333,14 @@ var csv = Papa.unparse({
  • dynamicTyping If true, numeric and boolean data will be converted to their type instead of remaining strings.
  • preview If > 0, only that many rows will be parsed.
  • encoding The encoding to use when opening files locally.
    • -
  • worker Whether or not to use a worker thread. Using a worker will keep your page reactive, but may be slightly slower.
    • +
  • worker Whether or not to use a worker thread. Using a worker will keep your page reactive, but may be slightly slower.
  • comments Specify a string that indicates a comment (like "#" or "//"). If your CSV file has commented lines, and Papa will skip them. This feature is disabled by default.
    • - step To stream the input, define a callback function to receive results row-by-row rather than together at the end: + step To stream the input, define a callback function to receive results row-by-row rather than together at the end: step: function(results, handle) { console.log("Row data:", results.data); console.log("Row errors:", results.errors); @@ -357,7 +357,7 @@ var csv = Papa.unparse({
    • error A callback to execute if FileReader encounters an error. The function should receive two arguments: the error and the File.
    • download If true, this indicates that the string you passed in is actually a URL from which to download a file and parse it.
      • -
    • keepEmptyRows If true, rows that are empty will be included in the results as an empty array. This is useful if you want to maintain line (or at least row) parity with the original input.
      • +
    • skipEmptyLines If true, lines that are completely empty will be skipped. An empty line is defined to be one which evaluates to empty string.
    • chunk A callback, much like step, which activates streaming and is executed after every whole chunk of the file is loaded and parsed, rather than every row. Works only with local and remote files. Do not use both chunk and step callbacks together. As arguments, it receives the results, the streamer, and if parsing a local file, the File object. You can pause, resume, and abort parsing from within this function.
    • fastMode When enabled, fast mode executes parsing much more quickly. Only use this if you know your input won't have quoted fields.
    diff --git a/faq.html b/faq.html index 688aeb9..bacb1ba 100644 --- a/faq.html +++ b/faq.html @@ -20,10 +20,10 @@ GitHub - + Demo - + Docs
    @@ -33,7 +33,7 @@
    - + FAQ @@ -119,12 +119,12 @@

    Can Papa load and parse huge files?

    - Yes. Parsing huge text files is facilitated by streaming, where the file is loaded a little bit at a time, parsed, and the results are sent to your step callback function, row-by-row. + Yes. Parsing huge text files is facilitated by streaming, where the file is loaded a little bit at a time, parsed, and the results are sent to your step callback function, row-by-row.

    How do I stream my input?

    - Just specify a step callback function. Results will not be available after parsing is finished, however. You have to inspect the results one row at a time. + Just specify a step callback function. Results will not be available after parsing is finished, however. You have to inspect the results one row at a time.

    What is a stream and when should I stream files?

    @@ -165,7 +165,7 @@

    Can I pause and resume parsing?

    - Yes, as long as you are streaming and not using a worker. Your step callback is passed a ParserHandle which has pause, resume, and abort functions. + Yes, as long as you are streaming and not using a worker. Your step callback is passed a ParserHandle which has pause, resume, and abort functions.

    @@ -186,7 +186,7 @@

    How do I use a worker?

    - Just specify worker: true in your config. You'll also need to make a complete callback (unless you're streaming) so that you can get the results, because using a worker makes the parse function asynchronous. + Just specify worker: true in your config. You'll also need to make a complete callback (unless you're streaming) so that you can get the results, because using a worker makes the parse function asynchronous.

    When should I use a worker?

    diff --git a/index.html b/index.html index 7da22ba..2aa9a53 100644 --- a/index.html +++ b/index.html @@ -29,10 +29,10 @@ GitHub - + Demo - + Docs
    @@ -42,7 +42,7 @@
    - + FAQ @@ -166,7 +166,7 @@ Papa.parse(fileOrString, {   Get Papa Parse on GitHub - +   Try the demo
    @@ -399,7 +399,7 @@ var results = Papa.parse(csv, {
    // Output is a properly-formatted CSV string. -// See the docs for more configurability. +// See the docs for more configurability. var csv = Papa.unparse(yourData);
    @@ -427,7 +427,7 @@ var csv = Papa.unparse(yourData);       Get Papa Parse on GitHub - +   Try the demo