Skip to content

Commit

Permalink
docs: improve PathReference documentation (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsherret authored Feb 12, 2023
1 parent d03fc71 commit 5ae66f8
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 80 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ const srcDir = $.path("src").resolve();
await $`echo ${srcDir}`;
```

There are a lot of helper methods here, so check the documentation for more details.
There are a lot of helper methods here, so check the [documentation on PathReference](https://deno.land/x/dax/src/path.ts/~/PathReference) for more details.

## Helper functions

Expand Down Expand Up @@ -622,7 +622,7 @@ console.log(response.code);
console.log(await response.json());
```

See the [documentation on `RequestBuilder`](https://doc.deno.land/https/deno.land/x/dax/mod.ts) for more details. It should be as flexible as `fetch`, but uses a builder API (ex. set headers via `.header(...)`).
See the [documentation on `RequestBuilder`](https://deno.land/x/dax/src/request.ts?s=RequestBuilder) for more details. It should be as flexible as `fetch`, but uses a builder API (ex. set headers via `.header(...)`).

### Showing progress

Expand Down
1 change: 1 addition & 0 deletions mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import { wasmInstance } from "./src/lib/mod.ts";
import { RequestBuilder, withProgressBarFactorySymbol } from "./src/request.ts";
import { createPathReference } from "./src/path.ts";

export { FsFileWrapper, PathReference } from "./src/path.ts";
export { CommandBuilder, CommandResult } from "./src/command.ts";
export type { CommandContext, CommandHandler, CommandPipeReader, CommandPipeWriter } from "./src/command_handler.ts";
export type {
Expand Down
Loading

0 comments on commit 5ae66f8

Please sign in to comment.