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.

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

fix(std/encoding/csv) Correct readme formatting due to dprint issues #8503

Merged
merged 2 commits into from
Nov 26, 2020
Merged
Changes from all commits
Commits
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
73 changes: 38 additions & 35 deletions std/encoding/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,31 +102,32 @@ function is as follows:

`DataItem: Record<string, unknown> | unknown[]`

```ts
const data = [
{
name: "Deno",
repo: { org: "denoland", name: "deno" },
runsOn: ["Rust", "TypeScript"],
},
];
```
```ts
const data = [
{
name: "Deno",
repo: { org: "denoland", name: "deno" },
runsOn: ["Rust", "TypeScript"],
},
];
```

- **`columns`** is a list of instructions for how to target and transform the
data for each column of output. This is also where you can provide an explicit
header name for the column.

`Column`:

- The most essential aspect of a column is accessing the property holding the
data for that column on each object in the data array. If that member is at
the top level, `Column` can simply be a property accessor, which is either a
`string` (if it's a plain object) or a `number` (if it's an array).

```ts
const columns = [
"name",
];
```
```ts
const columns = [
"name",
];
```

Each property accessor will be used as the header for the column:

Expand All @@ -138,12 +139,12 @@ function is as follows:
objects/arrays), then a simple property accessor won't work, so an array of
them will be required.

```ts
const columns = [
["repo", "name"],
["repo", "org"],
];
```
```ts
const columns = [
["repo", "name"],
["repo", "org"],
];
```

When using arrays of property accessors, the header names inherit the value
of the last accessor in each array:
Expand All @@ -158,27 +159,29 @@ function is as follows:

- **`fn?: (value: any) => string | Promise<string>`** is an optional
function to transform the targeted data into the desired format

- **`header?: string`** is the optional value to use for the column header
name

- **`prop: PropertyAccessor | PropertyAccessor[]`** is the property accessor
(`string` or `number`) or array of property accessors used to access the
data on each object

```ts
const columns = [
"name",
{
prop: ["runsOn", 0],
header: "language 1",
fn: (str: string) => str.toLowerCase(),
},
{
prop: ["runsOn", 1],
header: "language 2",
fn: (str: string) => str.toLowerCase(),
},
];
```
```ts
const columns = [
"name",
{
prop: ["runsOn", 0],
header: "language 1",
fn: (str: string) => str.toLowerCase(),
},
{
prop: ["runsOn", 1],
header: "language 2",
fn: (str: string) => str.toLowerCase(),
},
];
```

| name | language 1 | language 2 |
| :--: | :--------: | :--------: |
Expand Down