foster/deno
0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-03-03 09:31:22 -05:00
Code Issues Packages 1 Wiki Activity

Document lStatSync & statSync and correct FileInfo.

Browse source
This commit is contained in:
Aaron Power 2018-08-31 20:15:22 +01:00 • committed by Ryan Dahl
parent f131445a46
commit 9b7e5a2558
1 changed files with 49 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
js/os.ts
View file

@ -186,44 +186,88 @@ export function env(): { [index:string]: string } {
return createEnv(res);
}
/**
* A FileInfo describes a file and is returned by `stat`, `lstat`,
* `statSync`, `lstatSync`.
*/
export class FileInfo {
private _isFile: boolean;
private _isSymlink: boolean;
/** The size of the file, in bytes. */
len: number;
modified: number;
accessed: number;
// Creation time is not available on all platforms.
/**
* 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`
* 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`
* field from `stat` on Unix and `ftCreationTime` on Windows. This may not
* be available on all platforms.
*/
created: number | null;
/* @internal */
constructor(private _msg: fbs.StatSyncRes) {
const modified = this._msg.modified().toFloat64();
const accessed = this._msg.accessed().toFloat64();
const created = this._msg.created().toFloat64();
this._isFile = this._msg.isFile();
this._isSymlink = this._msg.isSymlink();
this.len = this._msg.len().toFloat64();
this.modified = this._msg.modified().toFloat64();
this.accessed = this._msg.accessed().toFloat64();
this.modified = modified ? modified : null;
this.accessed = accessed ? accessed : null;
this.created = created ? created : null;
}
/**
* Returns whether this is info for a regular file. This result is mutually
* exclusive to `FileInfo.isDirectory` and `FileInfo.isSymlink`.
*/
isFile() {
return this._isFile;
}
/**
* Returns whether this is info for a regular directory. This result is
* mutually exclusive to `FileInfo.isFile` and `FileInfo.isSymlink`.
*/
isDirectory() {
return !this._isFile && !this._isSymlink;
}
/**
* Returns whether this is info for a symlink. This result is
* mutually exclusive to `FileInfo.isFile` and `FileInfo.isDirectory`.
*/
isSymlink() {
return this._isSymlink;
}
}
/**
* Queries the file system for information on the path provided.
* If the given path is a symlink information about the symlink will
* be returned.
* @returns FileInfo
*/
export function lStatSync(filename: string): FileInfo {
return statSyncInner(filename, true);
}
/**
* Queries the file system for information on the path provided.
* `statSync` Will always follow symlinks.
* @returns FileInfo
*/
export function statSync(filename: string): FileInfo {
return statSyncInner(filename, false);
}