Readme cleanup in encoding and ws (denoland/deno#6209)

This commit is contained in:
Ch3ri0ur 2020-06-09 21:08:38 +02:00 committed by denobot
parent 6908dc02f4
commit 7d411434da
2 changed files with 31 additions and 18 deletions

View File

@ -77,6 +77,7 @@ function is as follows:
### Usage
```ts
import { parse } from "https://deno.land/std/encoding/csv.ts";
const string = "a,b,c\nd,e,f";
console.log(
@ -182,24 +183,10 @@ will output:
}
```
### Usage
#### Parse
### Basic usage
```ts
import { parse } from "./parser.ts";
import { readFileStrSync } from "../fs/read_file_str.ts";
const tomlObject = parse(readFileStrSync("file.toml"));
const tomlString = 'foo.bar = "Deno"';
const tomlObject22 = parse(tomlString);
```
#### Stringify
```ts
import { stringify } from "./parser.ts";
import { parse, stringify } from "https://deno.land/std/encoding/toml.ts";
const obj = {
bin: [
{ name: "deno", path: "cli/main.rs" },
@ -208,6 +195,32 @@ const obj = {
nib: [{ name: "node", path: "not_found" }],
};
const tomlString = stringify(obj);
console.log(tomlString);
// =>
// [[bin]]
// name = "deno"
// path = "cli/main.rs"
// [[bin]]
// name = "deno_core"
// path = "src/foo.rs"
// [[nib]]
// name = "node"
// path = "not_found"
const tomlObject = parse(tomlString);
console.log(tomlObject);
// =>
// {
// bin: [
// { name: "deno", path: "cli/main.rs" },
// { name: "deno_core", path: "src/foo.rs" }
// ],
// nib: [ { name: "node", path: "not_found" } ]
// }
```
## YAML

View File

@ -8,13 +8,13 @@ ws module is made to provide helpers to create WebSocket client/server.
```ts
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { serve } from "../../http/server.ts";
import { serve } from "https://deno.land/std/http/server.ts";
import {
acceptWebSocket,
isWebSocketCloseEvent,
isWebSocketPingEvent,
WebSocket,
} from "../../ws/mod.ts";
} from "https://deno.land/std/ws/mod.ts";
async function handleWs(sock: WebSocket) {
console.log("socket connected!");