diff options
author | crowlKats <crowlkats@gmail.com> | 2020-03-13 10:22:22 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-13 10:22:22 +0100 |
commit | e435c2be158ce8657dbff0664b6db222fe4e586c (patch) | |
tree | b0e72033be2ce51a70fd2c2af23e6da131a642bb /cli/js/ops/fs | |
parent | 3ac642c183981a366e1db565c16b81f864b07ee4 (diff) |
Remove doc strings from cli/js TS files (#4329)
Co-authored-by: Ryan Dahl <ry@tinyclouds.org>
Diffstat (limited to 'cli/js/ops/fs')
-rw-r--r-- | cli/js/ops/fs/chmod.ts | 12 | ||||
-rw-r--r-- | cli/js/ops/fs/chown.ts | 18 | ||||
-rw-r--r-- | cli/js/ops/fs/copy_file.ts | 16 | ||||
-rw-r--r-- | cli/js/ops/fs/dir.ts | 17 | ||||
-rw-r--r-- | cli/js/ops/fs/link.ts | 10 | ||||
-rw-r--r-- | cli/js/ops/fs/make_temp.ts | 62 | ||||
-rw-r--r-- | cli/js/ops/fs/mkdir.ts | 20 | ||||
-rw-r--r-- | cli/js/ops/fs/open.ts | 34 | ||||
-rw-r--r-- | cli/js/ops/fs/read_dir.ts | 13 | ||||
-rw-r--r-- | cli/js/ops/fs/read_link.ts | 10 | ||||
-rw-r--r-- | cli/js/ops/fs/realpath.ts | 8 | ||||
-rw-r--r-- | cli/js/ops/fs/remove.ts | 16 | ||||
-rw-r--r-- | cli/js/ops/fs/rename.ts | 15 | ||||
-rw-r--r-- | cli/js/ops/fs/seek.ts | 14 | ||||
-rw-r--r-- | cli/js/ops/fs/stat.ts | 29 | ||||
-rw-r--r-- | cli/js/ops/fs/symlink.ts | 18 | ||||
-rw-r--r-- | cli/js/ops/fs/truncate.ts | 11 | ||||
-rw-r--r-- | cli/js/ops/fs/umask.ts | 6 | ||||
-rw-r--r-- | cli/js/ops/fs/utime.ts | 18 |
19 files changed, 0 insertions, 347 deletions
diff --git a/cli/js/ops/fs/chmod.ts b/cli/js/ops/fs/chmod.ts index 9e748672f..91e898360 100644 --- a/cli/js/ops/fs/chmod.ts +++ b/cli/js/ops/fs/chmod.ts @@ -1,22 +1,10 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "../dispatch_json.ts"; -/** Synchronously changes the permission of a specific file/directory of - * specified path. Ignores the process's umask. - * - * Deno.chmodSync("/path/to/file", 0o666); - * - * Requires `allow-write` permission. */ export function chmodSync(path: string, mode: number): void { sendSync("op_chmod", { path, mode }); } -/** Changes the permission of a specific file/directory of specified path. - * Ignores the process's umask. - * - * await Deno.chmod("/path/to/file", 0o666); - * - * Requires `allow-write` permission. */ export async function chmod(path: string, mode: number): Promise<void> { await sendAsync("op_chmod", { path, mode }); } diff --git a/cli/js/ops/fs/chown.ts b/cli/js/ops/fs/chown.ts index 6f871f313..d6e3702c6 100644 --- a/cli/js/ops/fs/chown.ts +++ b/cli/js/ops/fs/chown.ts @@ -1,28 +1,10 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "../dispatch_json.ts"; -/** Synchronously change owner of a regular file or directory. Linux/Mac OS - * only at the moment. - * - * Requires `allow-write` permission. - * - * @param path path to the file - * @param uid user id of the new owner - * @param gid group id of the new owner - */ export function chownSync(path: string, uid: number, gid: number): void { sendSync("op_chown", { path, uid, gid }); } -/** Change owner of a regular file or directory. Linux/Mac OS only at the - * moment. - * - * Requires `allow-write` permission. - * - * @param path path to the file - * @param uid user id of the new owner - * @param gid group id of the new owner - */ export async function chown( path: string, uid: number, diff --git a/cli/js/ops/fs/copy_file.ts b/cli/js/ops/fs/copy_file.ts index 6bd49fe2c..4c8c74667 100644 --- a/cli/js/ops/fs/copy_file.ts +++ b/cli/js/ops/fs/copy_file.ts @@ -1,26 +1,10 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "../dispatch_json.ts"; -/** Synchronously copies the contents and permissions of one file to another - * specified path, by default creating a new file if needed, else overwriting. - * Fails if target path is a directory or is unwritable. - * - * Deno.copyFileSync("from.txt", "to.txt"); - * - * Requires `allow-read` permission on fromPath. - * Requires `allow-write` permission on toPath. */ export function copyFileSync(fromPath: string, toPath: string): void { sendSync("op_copy_file", { from: fromPath, to: toPath }); } -/** Copies the contents and permissions of one file to another specified path, - * by default creating a new file if needed, else overwriting. Fails if target - * path is a directory or is unwritable. - * - * await Deno.copyFile("from.txt", "to.txt"); - * - * Requires `allow-read` permission on fromPath. - * Requires `allow-write` permission on toPath. */ export async function copyFile( fromPath: string, toPath: string diff --git a/cli/js/ops/fs/dir.ts b/cli/js/ops/fs/dir.ts index e9e95005b..14b6240ed 100644 --- a/cli/js/ops/fs/dir.ts +++ b/cli/js/ops/fs/dir.ts @@ -1,27 +1,10 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync } from "../dispatch_json.ts"; -/** - * **UNSTABLE**: maybe needs permissions. - * - * Return a string representing the current working directory. - * - * If the current directory can be reached via multiple paths (due to symbolic - * links), `cwd()` may return any one of them. - * - * Throws `Deno.errors.NotFound` if directory not available. - */ export function cwd(): string { return sendSync("op_cwd"); } -/** - * **UNSTABLE**: maybe needs permissions. - * - * Change the current working directory to the specified path. - * - * Throws `Deno.errors.NotFound` if directory not available. - */ export function chdir(directory: string): void { sendSync("op_chdir", { directory }); } diff --git a/cli/js/ops/fs/link.ts b/cli/js/ops/fs/link.ts index 0f083dd7b..24a874d47 100644 --- a/cli/js/ops/fs/link.ts +++ b/cli/js/ops/fs/link.ts @@ -1,20 +1,10 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "../dispatch_json.ts"; -/** Creates `newname` as a hard link to `oldname`. - * - * Deno.linkSync("old/name", "new/name"); - * - * Requires `allow-read` and `allow-write` permissions. */ export function linkSync(oldname: string, newname: string): void { sendSync("op_link", { oldname, newname }); } -/** Creates `newname` as a hard link to `oldname`. - * - * await Deno.link("old/name", "new/name"); - * - * Requires `allow-read` and `allow-write` permissions. */ export async function link(oldname: string, newname: string): Promise<void> { await sendAsync("op_link", { oldname, newname }); } diff --git a/cli/js/ops/fs/make_temp.ts b/cli/js/ops/fs/make_temp.ts index 1fbff41d0..cc8a76435 100644 --- a/cli/js/ops/fs/make_temp.ts +++ b/cli/js/ops/fs/make_temp.ts @@ -2,87 +2,25 @@ import { sendSync, sendAsync } from "../dispatch_json.ts"; export interface MakeTempOptions { - /** Directory where the temporary directory should be created (defaults to - * the env variable TMPDIR, or the system's default, usually /tmp). */ dir?: string; - /** String that should precede the random portion of the temporary - * directory's name. */ prefix?: string; - /** String that should follow the random portion of the temporary - * directory's name. */ suffix?: string; } -/** Synchronously creates a new temporary directory in the directory `dir`, - * its name beginning with `prefix` and ending with `suffix`. - * - * It returns the full path to the newly created directory. - * - * If `dir` is unspecified, uses the default directory for temporary files. - * Multiple programs calling this function simultaneously will create different - * directories. It is the caller's responsibility to remove the directory when - * no longer needed. - * - * const tempDirName0 = Deno.makeTempDirSync(); - * const tempDirName1 = Deno.makeTempDirSync({ prefix: 'my_temp' }); - * - * Requires `allow-write` permission. */ export function makeTempDirSync(options: MakeTempOptions = {}): string { return sendSync("op_make_temp_dir", options); } -/** Creates a new temporary directory in the directory `dir`, its name - * beginning with `prefix` and ending with `suffix`. - * - * It resolves to the full path to the newly created directory. - * - * If `dir` is unspecified, uses the default directory for temporary files. - * Multiple programs calling this function simultaneously will create different - * directories. It is the caller's responsibility to remove the directory when - * no longer needed. - * - * const tempDirName0 = await Deno.makeTempDir(); - * const tempDirName1 = await Deno.makeTempDir({ prefix: 'my_temp' }); - * - * Requires `allow-write` permission. */ export async function makeTempDir( options: MakeTempOptions = {} ): Promise<string> { return await sendAsync("op_make_temp_dir", options); } -/** Synchronously creates a new temporary file in the directory `dir`, its name - * beginning with `prefix` and ending with `suffix`. - * - * It returns the full path to the newly created file. - * - * If `dir` is unspecified, uses the default directory for temporary files. - * Multiple programs calling this function simultaneously will create different - * files. It is the caller's responsibility to remove the file when - * no longer needed. - * - * const tempFileName0 = Deno.makeTempFileSync(); - * const tempFileName1 = Deno.makeTempFileSync({ prefix: 'my_temp' }); - * - * Requires `allow-write` permission. */ export function makeTempFileSync(options: MakeTempOptions = {}): string { return sendSync("op_make_temp_file", options); } -/** Creates a new temporary file in the directory `dir`, its name - * beginning with `prefix` and ending with `suffix`. - * - * It resolves to the full path to the newly created file. - * - * If `dir` is unspecified, uses the default directory for temporary files. - * Multiple programs calling this function simultaneously will create different - * files. It is the caller's responsibility to remove the file when - * no longer needed. - * - * const tempFileName0 = await Deno.makeTempFile(); - * const tempFileName1 = await Deno.makeTempFile({ prefix: 'my_temp' }); - * - * Requires `allow-write` permission. */ export async function makeTempFile( options: MakeTempOptions = {} ): Promise<string> { diff --git a/cli/js/ops/fs/mkdir.ts b/cli/js/ops/fs/mkdir.ts index 0bd088def..8ecc51676 100644 --- a/cli/js/ops/fs/mkdir.ts +++ b/cli/js/ops/fs/mkdir.ts @@ -28,24 +28,10 @@ function mkdirArgs( } export interface MkdirOptions { - /** Defaults to `false`. If set to `true`, means that any intermediate - * directories will also be created (as with the shell command `mkdir -p`). - * Intermediate directories are created with the same permissions. - * When recursive is set to `true`, succeeds silently (without changing any - * permissions) if a directory already exists at the path. */ recursive?: boolean; - /** Permissions to use when creating the directory (defaults to `0o777`, - * before the process's umask). - * Ignored on Windows. */ mode?: number; } -/** Synchronously creates a new directory with the specified path. - * - * Deno.mkdirSync("new_dir"); - * Deno.mkdirSync("nested/directories", { recursive: true }); - * - * Requires `allow-write` permission. */ export function mkdirSync( path: string, optionsOrRecursive?: MkdirOptions | boolean, @@ -54,12 +40,6 @@ export function mkdirSync( sendSync("op_mkdir", mkdirArgs(path, optionsOrRecursive, mode)); } -/** Creates a new directory with the specified path. - * - * await Deno.mkdir("new_dir"); - * await Deno.mkdir("nested/directories", { recursive: true }); - * - * Requires `allow-write` permission. */ export async function mkdir( path: string, optionsOrRecursive?: MkdirOptions | boolean, diff --git a/cli/js/ops/fs/open.ts b/cli/js/ops/fs/open.ts index e166ef16b..0d3c23667 100644 --- a/cli/js/ops/fs/open.ts +++ b/cli/js/ops/fs/open.ts @@ -2,48 +2,14 @@ import { sendSync, sendAsync } from "../dispatch_json.ts"; export interface OpenOptions { - /** Sets the option for read access. This option, when `true`, means that the - * file should be read-able if opened. */ read?: boolean; - /** Sets the option for write access. This option, when `true`, means that - * the file should be write-able if opened. If the file already exists, - * any write calls on it will overwrite its contents, by default without - * truncating it. */ write?: boolean; - /**Sets the option for the append mode. This option, when `true`, means that - * writes will append to a file instead of overwriting previous contents. - * Note that setting `{ write: true, append: true }` has the same effect as - * setting only `{ append: true }`. */ append?: boolean; - /** Sets the option for truncating a previous file. If a file is - * successfully opened with this option set it will truncate the file to `0` - * length if it already exists. The file must be opened with write access - * for truncate to work. */ truncate?: boolean; - /** Sets the option to allow creating a new file, if one doesn't already - * exist at the specified path. Requires write or append access to be - * used. */ create?: boolean; - /** Defaults to `false`. If set to `true`, no file, directory, or symlink is - * allowed to exist at the target location. Requires write or append - * access to be used. When createNew is set to `true`, create and truncate - * are ignored. */ createNew?: boolean; } -/** A set of string literals which specify the open mode of a file. - * - * |Value |Description | - * |------|--------------------------------------------------------------------------------------------------| - * |`"r"` |Read-only. Default. Starts at beginning of file. | - * |`"r+"`|Read-write. Start at beginning of file. | - * |`"w"` |Write-only. Opens and truncates existing file or creates new one for writing only. | - * |`"w+"`|Read-write. Opens and truncates existing file or creates new one for writing and reading. | - * |`"a"` |Write-only. Opens existing file or creates new one. Each write appends content to the end of file.| - * |`"a+"`|Read-write. Behaves like `"a"` and allows to read from file. | - * |`"x"` |Write-only. Exclusive create - creates new file only if one doesn't exist already. | - * |`"x+"`|Read-write. Behaves like `x` and allows reading from file. | - */ export type OpenMode = "r" | "r+" | "w" | "w+" | "a" | "a+" | "x" | "x+"; export function openSync( diff --git a/cli/js/ops/fs/read_dir.ts b/cli/js/ops/fs/read_dir.ts index 75c821c33..c48104d4b 100644 --- a/cli/js/ops/fs/read_dir.ts +++ b/cli/js/ops/fs/read_dir.ts @@ -15,23 +15,10 @@ function res(response: ReadDirResponse): FileInfo[] { ); } -/** Synchronously reads the directory given by `path` and returns an array of - * `Deno.FileInfo`. - * - * const files = Deno.readdirSync("/"); - * - * Requires `allow-read` permission. */ export function readdirSync(path: string): FileInfo[] { return res(sendSync("op_read_dir", { path })); } -/** UNSTABLE: Maybe need to return an `AsyncIterable`. - * - * Reads the directory given by `path` and resolves to an array of `Deno.FileInfo`. - * - * const files = await Deno.readdir("/"); - * - * Requires `allow-read` permission. */ export async function readdir(path: string): Promise<FileInfo[]> { return res(await sendAsync("op_read_dir", { path })); } diff --git a/cli/js/ops/fs/read_link.ts b/cli/js/ops/fs/read_link.ts index b5ac82cd7..3c74e1f2e 100644 --- a/cli/js/ops/fs/read_link.ts +++ b/cli/js/ops/fs/read_link.ts @@ -1,20 +1,10 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "../dispatch_json.ts"; -/** Returns the destination of the named symbolic link. - * - * const targetPath = Deno.readlinkSync("symlink/path"); - * - * Requires `allow-read` permission. */ export function readlinkSync(path: string): string { return sendSync("op_read_link", { path }); } -/** Resolves to the destination of the named symbolic link. - * - * const targetPath = await Deno.readlink("symlink/path"); - * - * Requires `allow-read` permission. */ export async function readlink(path: string): Promise<string> { return await sendAsync("op_read_link", { path }); } diff --git a/cli/js/ops/fs/realpath.ts b/cli/js/ops/fs/realpath.ts index c8070edea..625e6702d 100644 --- a/cli/js/ops/fs/realpath.ts +++ b/cli/js/ops/fs/realpath.ts @@ -1,18 +1,10 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "../dispatch_json.ts"; -/** Returns absolute normalized path with symbolic links resolved synchronously. - * - * const realPath = Deno.realpathSync("./some/path"); - */ export function realpathSync(path: string): string { return sendSync("op_realpath", { path }); } -/** Returns absolute normalized path with symbolic links resolved. - * - * const realPath = await Deno.realpath("./some/path"); - */ export async function realpath(path: string): Promise<string> { return await sendAsync("op_realpath", { path }); } diff --git a/cli/js/ops/fs/remove.ts b/cli/js/ops/fs/remove.ts index 565035793..d5af82f9b 100644 --- a/cli/js/ops/fs/remove.ts +++ b/cli/js/ops/fs/remove.ts @@ -2,29 +2,13 @@ import { sendSync, sendAsync } from "../dispatch_json.ts"; export interface RemoveOptions { - /** Defaults to `false`. If set to `true`, path will be removed even if - * it's a non-empty directory. */ recursive?: boolean; } -/** Synchronously removes the named file or directory. Throws error if - * permission denied, path not found, or path is a non-empty directory and - * the `recursive` option isn't set to `true`. - * - * Deno.removeSync("/path/to/dir/or/file", { recursive: false }); - * - * Requires `allow-write` permission. */ export function removeSync(path: string, options: RemoveOptions = {}): void { sendSync("op_remove", { path, recursive: !!options.recursive }); } -/** Removes the named file or directory. Throws error if permission denied, - * path not found, or path is a non-empty directory and the `recursive` - * option isn't set to `true`. - * - * await Deno.remove("/path/to/dir/or/file", { recursive: false }); - * - * Requires `allow-write` permission. */ export async function remove( path: string, options: RemoveOptions = {} diff --git a/cli/js/ops/fs/rename.ts b/cli/js/ops/fs/rename.ts index 016ebc2d7..9f02c8bc0 100644 --- a/cli/js/ops/fs/rename.ts +++ b/cli/js/ops/fs/rename.ts @@ -1,25 +1,10 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "../dispatch_json.ts"; -/** Synchronously renames (moves) `oldpath` to `newpath`. If `newpath` already - * exists and is not a directory, `renameSync()` replaces it. OS-specific - * restrictions may apply when `oldpath` and `newpath` are in different - * directories. - * - * Deno.renameSync("old/path", "new/path"); - * - * Requires `allow-read` and `allow-write` permissions. */ export function renameSync(oldpath: string, newpath: string): void { sendSync("op_rename", { oldpath, newpath }); } -/** Renames (moves) `oldpath` to `newpath`. If `newpath` already exists and is - * not a directory, `rename()` replaces it. OS-specific restrictions may apply - * when `oldpath` and `newpath` are in different directories. - * - * await Deno.rename("old/path", "new/path"); - * - * Requires `allow-read` and `allow-write`. */ export async function rename(oldpath: string, newpath: string): Promise<void> { await sendAsync("op_rename", { oldpath, newpath }); } diff --git a/cli/js/ops/fs/seek.ts b/cli/js/ops/fs/seek.ts index 313d365c6..a3b055c95 100644 --- a/cli/js/ops/fs/seek.ts +++ b/cli/js/ops/fs/seek.ts @@ -2,13 +2,6 @@ import { sendSync, sendAsync } from "../dispatch_json.ts"; import { SeekMode } from "../../io.ts"; -/** Synchronously seek a file ID to the given offset under mode given by `whence`. - * - * Returns the number of cursor position. - * - * const file = Deno.openSync("/foo/bar.txt"); - * const position = Deno.seekSync(file.rid, 0, 0); - */ export function seekSync( rid: number, offset: number, @@ -17,13 +10,6 @@ export function seekSync( return sendSync("op_seek", { rid, offset, whence }); } -/** Seek a file ID to the given offset under mode given by `whence`. - * - * Resolves with the number of cursor position. - * - * const file = await Deno.open("/foo/bar.txt"); - * const position = await Deno.seek(file.rid, 0, 0); - */ export async function seek( rid: number, offset: number, diff --git a/cli/js/ops/fs/stat.ts b/cli/js/ops/fs/stat.ts index 6a764a8bb..032cc97ee 100644 --- a/cli/js/ops/fs/stat.ts +++ b/cli/js/ops/fs/stat.ts @@ -2,7 +2,6 @@ import { sendSync, sendAsync } from "../dispatch_json.ts"; import { FileInfo, FileInfoImpl } from "../../file_info.ts"; -/** @internal */ export interface StatResponse { isFile: boolean; isSymlink: boolean; @@ -23,13 +22,6 @@ export interface StatResponse { blocks: number; } -/** Resolves to a `Deno.FileInfo` for the specified `path`. If `path` is a - * symlink, information for the symlink will be returned. - * - * const fileInfo = await Deno.lstat("hello.txt"); - * assert(fileInfo.isFile()); - * - * Requires `allow-read` permission. */ export async function lstat(path: string): Promise<FileInfo> { const res = (await sendAsync("op_stat", { path, @@ -38,13 +30,6 @@ export async function lstat(path: string): Promise<FileInfo> { return new FileInfoImpl(res); } -/** Synchronously returns a `Deno.FileInfo` for the specified `path`. If - * `path` is a symlink, information for the symlink will be returned. - * - * const fileInfo = Deno.lstatSync("hello.txt"); - * assert(fileInfo.isFile()); - * - * Requires `allow-read` permission. */ export function lstatSync(path: string): FileInfo { const res = sendSync("op_stat", { path, @@ -53,13 +38,6 @@ export function lstatSync(path: string): FileInfo { return new FileInfoImpl(res); } -/** Resolves to a `Deno.FileInfo` for the specified `path`. Will always - * follow symlinks. - * - * const fileInfo = await Deno.stat("hello.txt"); - * assert(fileInfo.isFile()); - * - * Requires `allow-read` permission. */ export async function stat(path: string): Promise<FileInfo> { const res = (await sendAsync("op_stat", { path, @@ -68,13 +46,6 @@ export async function stat(path: string): Promise<FileInfo> { return new FileInfoImpl(res); } -/** Synchronously returns a `Deno.FileInfo` for the specified `path`. Will - * always follow symlinks. - * - * const fileInfo = Deno.statSync("hello.txt"); - * assert(fileInfo.isFile()); - * - * Requires `allow-read` permission. */ export function statSync(path: string): FileInfo { const res = sendSync("op_stat", { path, diff --git a/cli/js/ops/fs/symlink.ts b/cli/js/ops/fs/symlink.ts index 3bb7c3335..ad49bfdd7 100644 --- a/cli/js/ops/fs/symlink.ts +++ b/cli/js/ops/fs/symlink.ts @@ -3,15 +3,6 @@ import { sendSync, sendAsync } from "../dispatch_json.ts"; import * as util from "../../util.ts"; import { build } from "../../build.ts"; -/** **UNSTABLE**: `type` argument type may be changed to `"dir" | "file"`. - * - * Creates `newname` as a symbolic link to `oldname`. The type argument can be - * set to `dir` or `file`. Is only available on Windows and ignored on other - * platforms. - * - * Deno.symlinkSync("old/name", "new/name"); - * - * Requires `allow-read` and `allow-write` permissions. */ export function symlinkSync( oldname: string, newname: string, @@ -23,15 +14,6 @@ export function symlinkSync( sendSync("op_symlink", { oldname, newname }); } -/** **UNSTABLE**: `type` argument may be changed to "dir" | "file" - * - * Creates `newname` as a symbolic link to `oldname`. The type argument can be - * set to `dir` or `file`. Is only available on Windows and ignored on other - * platforms. - * - * await Deno.symlink("old/name", "new/name"); - * - * Requires `allow-read` and `allow-write` permissions. */ export async function symlink( oldname: string, newname: string, diff --git a/cli/js/ops/fs/truncate.ts b/cli/js/ops/fs/truncate.ts index 578e37aa3..861e843f8 100644 --- a/cli/js/ops/fs/truncate.ts +++ b/cli/js/ops/fs/truncate.ts @@ -13,21 +13,10 @@ function coerceLen(len?: number): number { return len; } -/** Synchronously truncates or extends the specified file, to reach the - * specified `len`. - * - * Deno.truncateSync("hello.txt", 10); - * - * Requires `allow-write` permission. */ export function truncateSync(path: string, len?: number): void { sendSync("op_truncate", { path, len: coerceLen(len) }); } -/** Truncates or extends the specified file, to reach the specified `len`. - * - * await Deno.truncate("hello.txt", 10); - * - * Requires `allow-write` permission. */ export async function truncate(path: string, len?: number): Promise<void> { await sendAsync("op_truncate", { path, len: coerceLen(len) }); } diff --git a/cli/js/ops/fs/umask.ts b/cli/js/ops/fs/umask.ts index ee56fecb5..38bf8ff6c 100644 --- a/cli/js/ops/fs/umask.ts +++ b/cli/js/ops/fs/umask.ts @@ -1,12 +1,6 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync } from "../dispatch_json.ts"; -/** - * **UNSTABLE**: maybe needs `allow-env` permissions. - * - * If `mask` is provided, sets the process umask. Always returns what the umask - * was before the call. - */ export function umask(mask?: number): number { return sendSync("op_umask", { mask }); } diff --git a/cli/js/ops/fs/utime.ts b/cli/js/ops/fs/utime.ts index f684ac80a..13cac8cb6 100644 --- a/cli/js/ops/fs/utime.ts +++ b/cli/js/ops/fs/utime.ts @@ -5,15 +5,6 @@ function toSecondsFromEpoch(v: number | Date): number { return v instanceof Date ? v.valueOf() / 1000 : v; } -/** **UNSTABLE**: needs investigation into high precision time. - * - * Synchronously changes the access and modification times of a file system - * object referenced by `path`. Given times are either in seconds (UNIX epoch - * time) or as `Date` objects. - * - * Deno.utimeSync("myfile.txt", 1556495550, new Date()); - * - * Requires `allow-write` permission. */ export function utimeSync( path: string, atime: number | Date, @@ -27,15 +18,6 @@ export function utimeSync( }); } -/** **UNSTABLE**: needs investigation into high precision time. - * - * Changes the access and modification times of a file system object - * referenced by `path`. Given times are either in seconds (UNIX epoch time) - * or as `Date` objects. - * - * await Deno.utime("myfile.txt", 1556495550, new Date()); - * - * Requires `allow-write` permission. */ export async function utime( path: string, atime: number | Date, |