Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chunkSize documented #818

Merged
merged 2 commits into from Jul 23, 2020
Merged

chunkSize documented #818

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14de07b
chunkSize documented
akshaybabloo Jul 23, 2020
b214f57
added link to configurable
akshaybabloo Jul 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/docs.html
View file
Open in desktop
Expand Up @@ -444,6 +444,7 @@ <h5 id="config-default">Default Config With All Options</h5>
downloadRequestBody: undefined,
skipEmptyLines: false,
chunk: undefined,
chunkSize: undefined,
fastMode: undefined,
beforeFirstChunk: undefined,
withCredentials: undefined,
Expand Down Expand Up @@ -631,6 +632,14 @@ <h5 id="config-details">Config Options</h5>
A callback function, identical to step, which activates streaming. However, this function is executed after every <i>chunk</i> 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. For the function signature, see the documentation for the step function.
</td>
</tr>
<tr>
<td>
<code>chunkSize</code>
</td>
<td>
Overrides <code>Papa.LocalChunkSize</code> and <code>Papa.RemoteChunkSize</code>.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should explain what do both values instead of just saing that it overrides the behaviour.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I didn't do that because I thought they were already explained at the end of the document. Do you want me to link them to https://www.papaparse.com/docs#configurable or should I explain them here again?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes please, just add the link.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added 😄

</td>
</tr>
<tr>
<td>
<code>fastMode</code>
Expand Down