Skip to content

Commit 4746114

Browse files
authored
docs(fs): add missing docs (#6400)
1 parent 50f7c0c commit 4746114

File tree

4 files changed

+17
-3
lines changed

4 files changed

+17
-3
lines changed

_tools/check_docs.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,17 @@ const ENTRY_POINTS = [
6262
"../front_matter/mod.ts",
6363
"../front_matter/unstable_yaml.ts",
6464
"../fs/mod.ts",
65+
"../fs/unstable_chmod.ts",
66+
"../fs/unstable_link.ts",
6567
"../fs/unstable_lstat.ts",
68+
"../fs/unstable_make_temp_dir.ts",
69+
"../fs/unstable_read_dir.ts",
70+
"../fs/unstable_read_file.ts",
71+
"../fs/unstable_read_link.ts",
72+
"../fs/unstable_real_path.ts",
73+
"../fs/unstable_rename.ts",
6674
"../fs/unstable_stat.ts",
75+
"../fs/unstable_symlink.ts",
6776
"../fs/unstable_types.ts",
6877
"../html/mod.ts",
6978
"../html/unstable_is_valid_custom_element_name.ts",

fs/unstable_read_dir.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import type { DirEntry } from "./unstable_types.ts";
99
* {@linkcode DirEntry}. The order of entries is not guaranteed.
1010
*
1111
* @example Usage
12-
* ```ts
12+
* ```ts no-assert
1313
* import { readDir } from "@std/fs/unstable-read-dir";
1414
*
1515
* for await (const dirEntry of readDir("/")) {
@@ -23,6 +23,9 @@ import type { DirEntry } from "./unstable_types.ts";
2323
*
2424
* @tags allow-read
2525
* @category File System
26+
*
27+
* @param path The path to the directory to read.
28+
* @returns An async iterable of {@linkcode DirEntry}.
2629
*/
2730
export async function* readDir(path: string | URL): AsyncIterable<DirEntry> {
2831
if (isDeno) {

fs/unstable_read_file.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { mapError } from "./_map_error.ts";
1111
* Requires `allow-read` permission.
1212
*
1313
* @example Usage
14-
* ```ts
14+
* ```ts no-assert
1515
* import { readFile } from "@std/fs/unstable-read-file";
1616
* const decoder = new TextDecoder("utf-8");
1717
* const data = await readFile("README.md");
@@ -49,7 +49,7 @@ export async function readFile(
4949
* Requires `allow-read` permission.
5050
*
5151
* @example Usage
52-
* ```ts
52+
* ```ts no-assert
5353
* import { readFileSync } from "@std/fs/unstable-read-file";
5454
* const decoder = new TextDecoder("utf-8");
5555
* const data = readFileSync("README.md");

fs/unstable_symlink.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import type { SymlinkOptions } from "./unstable_types.ts";
2222
*
2323
* @param oldpath The path of the resource pointed by the symbolic link.
2424
* @param newpath The path of the symbolic link.
25+
* @param options Options when creating a symbolic link.
2526
*/
2627
export async function symlink(
2728
oldpath: string | URL,
@@ -61,6 +62,7 @@ export async function symlink(
6162
*
6263
* @param oldpath The path of the resource pointed by the symbolic link.
6364
* @param newpath The path of the symbolic link.
65+
* @param options Options when creating a symbolic link.
6466
*/
6567
export function symlinkSync(
6668
oldpath: string | URL,

0 commit comments

Comments
 (0)