Cleanup comments and internal variables (#4205)

This commit is contained in:
dubiousjim 2020-03-02 10:19:42 -05:00 committed by GitHub
parent 809019dc6e
commit 6cd46fa3ef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 681 additions and 572 deletions

View file

@ -23,12 +23,13 @@ export interface StatResponse {
blocks: number;
}
/** Queries the file system for information on the path provided. If the given
* path is a symlink information about the symlink will be returned.
/** 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(filename: string): Promise<FileInfo> {
const res = (await sendAsync("op_stat", {
filename,
@ -37,13 +38,13 @@ export async function lstat(filename: string): Promise<FileInfo> {
return new FileInfoImpl(res);
}
/** Queries the file system for information on the path provided synchronously.
* If the given path is a symlink information about the symlink will be
* returned.
/** 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(filename: string): FileInfo {
const res = sendSync("op_stat", {
filename,
@ -52,12 +53,13 @@ export function lstatSync(filename: string): FileInfo {
return new FileInfoImpl(res);
}
/** Queries the file system for information on the path provided. `stat` Will
* always follow symlinks.
/** 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(filename: string): Promise<FileInfo> {
const res = (await sendAsync("op_stat", {
filename,
@ -66,12 +68,13 @@ export async function stat(filename: string): Promise<FileInfo> {
return new FileInfoImpl(res);
}
/** Queries the file system for information on the path provided synchronously.
* `statSync` Will always follow symlinks.
/** 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(filename: string): FileInfo {
const res = sendSync("op_stat", {
filename,