docs(csv): more examples for stringify and CsvStringifyStream
#5606
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iuioiua
reviewed
Aug 2, 2024
csv/stringify.ts
Outdated
| * assertEquals(stringify(data), `Rick,70\r\nMorty,14\r\n`); | ||
| * ``` | ||
| * | ||
| * @example an array of objects and specify columns |
There was a problem hiding this comment.
Could you please tweak the example titles to have the correct casing, like those in #5605?
magurotuna
commented
Aug 2, 2024
Comment on lines
+55
to
+74
| * @example Write TSV to a file | ||
| * ```ts | ||
| * import { CsvStringifyStream } from "@std/csv/stringify-stream"; | ||
| * import { assertEquals } from "@std/assert/equals"; | ||
| * | ||
| * async function writeTsvToTempFile(): Promise<string> { | ||
| * const path = await Deno.makeTempFile(); | ||
| * using file = await Deno.open(path, { write: true }); | ||
| * | ||
| * const readable = ReadableStream.from([ | ||
| * { id: 1, name: "one" }, | ||
| * { id: 2, name: "two" }, | ||
| * { id: 3, name: "three" }, | ||
| * ]); | ||
| * | ||
| * await readable | ||
| * .pipeThrough( | ||
| * new CsvStringifyStream({ | ||
| * columns: ["id", "name"], | ||
| * separator: "\t", |
There was a problem hiding this comment.
I'd like to add more examples to give as many guides as stringify function, but in order to achieve this we need to address #5219 (comment)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5606 +/- ##
=======================================
Coverage 96.37% 96.37%
=======================================
Files 466 466
Lines 37587 37587
Branches 5542 5542
=======================================
Hits 36226 36226
Misses 1319 1319
Partials 42 42 ☔ View full report in Codecov by Sentry. |
iuioiua
approved these changes
Aug 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.