summaryrefslogtreecommitdiff
path: root/js/file_info.ts
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2018-10-15 07:29:50 +1100
committerRyan Dahl <ry@tinyclouds.org>2018-10-14 17:38:23 -0400
commit10a97679ac80b4304c75d33cbc59c5736d11deb1 (patch)
treeb51b9183ed251f61373069e5c4d35e39603bedb2 /js/file_info.ts
parent1840a1971317f5b8fc6e322b3a414b7f8a593c88 (diff)
Align JSDoc to style guide.
Diffstat (limited to 'js/file_info.ts')
-rw-r--r--js/file_info.ts30
1 files changed, 10 insertions, 20 deletions
diff --git a/js/file_info.ts b/js/file_info.ts
index c0029540f..029527ab1 100644
--- a/js/file_info.ts
+++ b/js/file_info.ts
@@ -1,8 +1,7 @@
// Copyright 2018 the Deno authors. All rights reserved. MIT license.
import * as msg from "gen/msg_generated";
-/**
- * A FileInfo describes a file and is returned by `stat`, `lstat`,
+/** A FileInfo describes a file and is returned by `stat`, `lstat`,
* `statSync`, `lstatSync`.
*/
export interface FileInfo {
@@ -10,52 +9,43 @@ export interface FileInfo {
readonly _isSymlink: boolean;
/** The size of the file, in bytes. */
len: number;
- /**
- * The last modification time of the file. This corresponds to the `mtime`
+ /** The last modification time of the file. This corresponds to the `mtime`
* field from `stat` on Unix and `ftLastWriteTime` on Windows. This may not
* be available on all platforms.
*/
modified: number | null;
- /**
- * The last access time of the file. This corresponds to the `atime`
+ /** The last access time of the file. This corresponds to the `atime`
* field from `stat` on Unix and `ftLastAccessTime` on Windows. This may not
* be available on all platforms.
*/
accessed: number | null;
- /**
- * The last access time of the file. This corresponds to the `birthtime`
+ /** The last access time of the file. This corresponds to the `birthtime`
* field from `stat` on Unix and `ftCreationTime` on Windows. This may not
* be available on all platforms.
*/
created: number | null;
- /**
- * The underlying raw st_mode bits that contain the standard Unix permissions
+ /** The underlying raw st_mode bits that contain the standard Unix permissions
* for this file/directory. TODO Match behavior with Go on windows for mode.
*/
mode: number | null;
- /**
- * Returns the file or directory name.
- */
+ /** Returns the file or directory name. */
name: string | null;
- /** Returns the file or directory path. */
+ /** Returns the file or directory path. */
path: string | null;
- /**
- * Returns whether this is info for a regular file. This result is mutually
+ /** Returns whether this is info for a regular file. This result is mutually
* exclusive to `FileInfo.isDirectory` and `FileInfo.isSymlink`.
*/
isFile(): boolean;
- /**
- * Returns whether this is info for a regular directory. This result is
+ /** Returns whether this is info for a regular directory. This result is
* mutually exclusive to `FileInfo.isFile` and `FileInfo.isSymlink`.
*/
isDirectory(): boolean;
- /**
- * Returns whether this is info for a symlink. This result is
+ /** Returns whether this is info for a symlink. This result is
* mutually exclusive to `FileInfo.isFile` and `FileInfo.isDirectory`.
*/
isSymlink(): boolean;