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

docs(csv): improve API docs #4920

Merged
merged 3 commits into from
Jun 3, 2024
+231 −60
Merged

docs(csv): improve API docs #4920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b09c49d
docs(csv): improve API docs
kt3k May 31, 2024
644962b
tweaks
iuioiua Jun 2, 2024
62a17d8
Merge branch 'main' into document-csv
iuioiua Jun 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _tools/check_docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ const ENTRY_POINTS = [
"../cli/mod.ts",
"../crypto/mod.ts",
"../collections/mod.ts",
"../csv/mod.ts",
"../data_structures/mod.ts",
"../datetime/mod.ts",
"../encoding/mod.ts",
Expand Down
80 changes: 76 additions & 4 deletions csv/_io.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,16 +215,88 @@ function runeCount(s: string): number {
/**
* A ParseError is returned for parsing errors.
* Line numbers are 1-indexed and columns are 0-indexed.
*
* @example Usage
* ```ts
* import { parse, ParseError } from "@std/csv/parse";
*
* try {
* parse(`a "word","b"`);
* } catch (error) {
* if (error instanceof ParseError) {
* console.error(error.message);
* }
* }
* ```
*/
export class ParseError extends SyntaxError {
/** Line where the record starts*/
/**
* Line where the record starts.
*
* @example Usage
* ```ts
* import { parse, ParseError } from "@std/csv/parse";
*
* try {
* parse(`a "word","b"`);
* } catch (error) {
* if (error instanceof ParseError) {
* console.error(error.startLine);
* }
* }
* ```
*/
startLine: number;
/** Line where the error occurred */
/**
* Line where the error occurred.
*
* @example Usage
* ```ts
* import { parse, ParseError } from "@std/csv/parse";
*
* try {
* parse(`a "word","b"`);
* } catch (error) {
* if (error instanceof ParseError) {
* console.error(error.line);
* }
* }
* ```
*/
line: number;
/** Column (rune index) where the error occurred */
/**
* Column (rune index) where the error occurred.
*
* @example Usage
* ```ts
* import { parse, ParseError } from "@std/csv/parse";
*
* try {
* parse(`a "word","b"`);
* } catch (error) {
* if (error instanceof ParseError) {
* console.error(error.column);
* }
* }
* ```
*/
column: number | null;

/** Constructs a new instance. */
/**
* Constructs a new instance.
*
* @example Usage
* ```ts no-eval
* import { ParseError } from "@std/csv/parse";
*
* throw new ParseError(1, 2, 3, "error message");
* ```
*
* @param start Line where the record starts
* @param line Line where the error occurred
* @param column Column The index where the error occurred
* @param message Error message
*/
constructor(
start: number,
line: number,
Expand Down
80 changes: 72 additions & 8 deletions csv/csv_parse_stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,20 @@ export type RowType<T> = T extends undefined ? string[]
* A `CsvParseStream` expects input conforming to
* {@link https://www.rfc-editor.org/rfc/rfc4180.html | RFC 4180}.
*
* @example
* @example Usage
* ```ts
* import { CsvParseStream } from "@std/csv/csv-parse-stream";
* const res = await fetch("https://example.com/data.csv");
* const parts = res.body!
* .pipeThrough(new TextDecoderStream())
* .pipeThrough(new CsvParseStream());
*
* const source = ReadableStream.from([
* "name,age",
* "Alice,34",
* "Bob,24",
* "Charlie,45",
* ]);
* const parts = source.pipeThrough(new CsvParseStream());
* ```
*
* @typeParam T The type of options for the stream.
*/
export class CsvParseStream<
const T extends CsvParseStreamOptions | undefined = undefined,
Expand All @@ -89,7 +95,23 @@ export class CsvParseStream<

#headers: readonly string[] = [];

/** Construct a new instance. */
/** Construct a new instance.
*
* @example Usage
* ```ts
* import { CsvParseStream } from "@std/csv/csv-parse-stream";
*
* const source = ReadableStream.from([
* "name,age",
* "Alice,34",
* "Bob,24",
* "Charlie,45",
* ]);
* const parts = source.pipeThrough(new CsvParseStream());
* ```
*
* @param options Options for the stream.
*/
constructor(options?: T) {
this.#options = {
...defaultReadOptions,
Expand Down Expand Up @@ -170,12 +192,54 @@ export class CsvParseStream<
}
}

/** The instance's {@linkcode ReadableStream}. */
/**
* The instance's {@linkcode ReadableStream}.
*
* @example Usage
* ```ts
* import { CsvParseStream } from "@std/csv/csv-parse-stream";
*
* const source = ReadableStream.from([
* "name,age",
* "Alice,34",
* "Bob,24",
* "Charlie,45",
* ]);
* const parseStream = new CsvParseStream();
* const parts = source.pipeTo(parseStream.writable);
* for await (const part of parseStream.readable) {
* console.log(part);
* }
* ```
*
* @returns The instance's {@linkcode ReadableStream}.
*/
get readable(): ReadableStream<RowType<T>> {
return this.#readable as ReadableStream<RowType<T>>;
}

/** The instance's {@linkcode WritableStream}. */
/**
* The instance's {@linkcode WritableStream}.
*
* @example Usage
* ```ts
* import { CsvParseStream } from "@std/csv/csv-parse-stream";
*
* const source = ReadableStream.from([
* "name,age",
* "Alice,34",
* "Bob,24",
* "Charlie,45",
* ]);
* const parseStream = new CsvParseStream();
* const parts = source.pipeTo(parseStream.writable);
* for await (const part of parseStream.readable) {
* console.log(part);
* }
* ```
*
* @returns The instance's {@linkcode WritableStream}.
*/
get writable(): WritableStream<string> {
return this.#lines.writable;
}
Expand Down
35 changes: 31 additions & 4 deletions csv/csv_stringify_stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ export interface CsvStringifyStreamOptions {
/**
* Convert each chunk to a CSV record.
*
* @example
* @example Usage
* ```ts
* import { CsvStringifyStream } from "@std/csv/csv-stringify-stream";
*
* const file = await Deno.open("data.csv", { create: true, write: true });
* const path = await Deno.makeTempFile();
*
* const file = await Deno.open(path, { create: true, write: true });
* const readable = ReadableStream.from([
* { id: 1, name: "one" },
* { id: 2, name: "two" },
Expand All @@ -37,15 +39,40 @@ export interface CsvStringifyStreamOptions {
* .pipeThrough(new CsvStringifyStream({ columns: ["id", "name"] }))
* .pipeThrough(new TextEncoderStream())
* .pipeTo(file.writable);
* ````
* ```
*
* @typeParam TOptions The type of options for the stream.
*/
export class CsvStringifyStream<TOptions extends CsvStringifyStreamOptions>
extends TransformStream<
TOptions["columns"] extends Array<string> ? Record<string, unknown>
: Array<unknown>,
string
> {
/** Construct a new instance. */
/**
* Construct a new instance.
*
* @example Usage
* ```ts
* import { CsvStringifyStream } from "@std/csv/csv-stringify-stream";
*
* const path = await Deno.makeTempFile();
*
* const file = await Deno.open(path, { create: true, 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"] }))
* .pipeThrough(new TextEncoderStream())
* .pipeTo(file.writable);
* ```
*
* @param options Options for the stream.
*/
constructor(options?: TOptions) {
const {
separator,
Expand Down
36 changes: 15 additions & 21 deletions csv/parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,45 +304,39 @@ export interface ParseOptions extends ReadOptions {
* Csv parse helper to manipulate data.
* Provides an auto/custom mapper for columns.
*
* @example
* @example Usage
* ```ts
* import { parse } from "@std/csv/parse";
* import { assertEquals } from "@std/assert/assert-equals";
*
* const string = "a,b,c\nd,e,f";
*
* console.log(
* await parse(string, {
* skipFirstRow: false,
* }),
* );
* // output:
* // [["a", "b", "c"], ["d", "e", "f"]]
* assertEquals(parse(string), [["a", "b", "c"], ["d", "e", "f"]]);
* ```
*
* @param input Input to parse.
* @returns If you don't provide `opt.skipFirstRow` and `opt.columns`, it returns `string[][]`.
* If you provide `opt.skipFirstRow` or `opt.columns`, it returns `Record<string, unknown>[]`.
* @param input The input to parse.
* @returns The parsed data.
*/
export function parse(input: string): string[][];
/**
* Csv parse helper to manipulate data.
* Provides an auto/custom mapper for columns.
*
* @example
* @example Usage
* ```ts
* import { parse } from "@std/csv/parse";
* import { assertEquals } from "@std/assert/assert-equals";
*
* const string = "a,b,c\nd,e,f";
*
* console.log(
* await parse(string, {
* skipFirstRow: false,
* }),
* );
* // output:
* // [["a", "b", "c"], ["d", "e", "f"]]
* assertEquals(parse(string, { skipFirstRow: false }), [["a", "b", "c"], ["d", "e", "f"]]);
* assertEquals(parse(string, { skipFirstRow: true }), [{ a: "d", b: "e", c: "f" }]);
* assertEquals(parse(string, { columns: ["x", "y", "z"] }), [{ x: "a", y: "b", z: "c" }, { x: "d", y: "e", z: "f" }]);
* ```
*
* @param input Input to parse.
* @param opt options of the parser.
* @typeParam T The options' type for parsing.
* @param input The input to parse.
* @param opt The options for parsing.
* @returns If you don't provide `opt.skipFirstRow` and `opt.columns`, it returns `string[][]`.
* If you provide `opt.skipFirstRow` or `opt.columns`, it returns `Record<string, unknown>[]`.
*/
Expand Down
Loading