summaryrefslogtreecommitdiff
path: root/cli/js/files.ts
diff options
context:
space:
mode:
authorcrowlKats <crowlkats@gmail.com>2020-03-13 10:22:22 +0100
committerGitHub <noreply@github.com>2020-03-13 10:22:22 +0100
commite435c2be158ce8657dbff0664b6db222fe4e586c (patch)
treeb0e72033be2ce51a70fd2c2af23e6da131a642bb /cli/js/files.ts
parent3ac642c183981a366e1db565c16b81f864b07ee4 (diff)
Remove doc strings from cli/js TS files (#4329)
Co-authored-by: Ryan Dahl <ry@tinyclouds.org>
Diffstat (limited to 'cli/js/files.ts')
-rw-r--r--cli/js/files.ts34
1 files changed, 0 insertions, 34 deletions
diff --git a/cli/js/files.ts b/cli/js/files.ts
index 945390ca0..b9da1363f 100644
--- a/cli/js/files.ts
+++ b/cli/js/files.ts
@@ -22,12 +22,6 @@ import {
} from "./ops/fs/open.ts";
export { OpenOptions, OpenMode } from "./ops/fs/open.ts";
-/** Synchronously open a file and return an instance of the `File` object.
- *
- * const file = Deno.openSync("/foo/bar.txt", { read: true, write: true });
- *
- * Requires `allow-read` and `allow-write` permissions depending on mode.
- */
export function openSync(path: string, mode?: OpenOptions): File;
export function openSync(path: string, mode?: OpenMode): File;
export function openSync(
@@ -48,12 +42,6 @@ export function openSync(
return new File(rid);
}
-/** Open a file and resolve to an instance of the `File` object.
- *
- * const file = await Deno.open("/foo/bar.txt", { read: true, write: true });
- *
- * Requires `allow-read` and `allow-write` permissions depending on mode.
- */
export async function open(path: string, options?: OpenOptions): Promise<File>;
export async function open(path: string, mode?: OpenMode): Promise<File>;
export async function open(
@@ -74,29 +62,14 @@ export async function open(
return new File(rid);
}
-/** Creates a file if none exists or truncates an existing file and returns
- * an instance of `Deno.File`.
- *
- * const file = Deno.createSync("/foo/bar.txt");
- *
- * Requires `allow-read` and `allow-write` permissions.
- */
export function createSync(path: string): File {
return openSync(path, "w+");
}
-/** Creates a file if none exists or truncates an existing file and resolves to
- * an instance of `Deno.File`.
- *
- * const file = await Deno.create("/foo/bar.txt");
- *
- * Requires `allow-read` and `allow-write` permissions.
- */
export function create(path: string): Promise<File> {
return open(path, "w+");
}
-/** The Deno abstraction for reading and writing files. */
export class File
implements
Reader,
@@ -137,17 +110,10 @@ export class File
}
}
-/** An instance of `Deno.File` for `stdin`. */
export const stdin = new File(0);
-/** An instance of `Deno.File` for `stdout`. */
export const stdout = new File(1);
-/** An instance of `Deno.File` for `stderr`. */
export const stderr = new File(2);
-/** Check if OpenOptions is set to valid combination of options.
- * @returns Tuple representing if openMode is valid and error message if it's not
- * @internal
- */
function checkOpenOptions(options: OpenOptions): void {
if (Object.values(options).filter(val => val === true).length === 0) {
throw new Error("OpenOptions requires at least one option to be true");