summaryrefslogtreecommitdiff
path: root/cli/js/file_info.ts
diff options
context:
space:
mode:
authordubiousjim <dubiousjim@gmail.com>2020-03-07 22:29:12 -0500
committerGitHub <noreply@github.com>2020-03-07 22:29:12 -0500
commit0dd131d4a512e8e8370b571d6801eabb4cb30e58 (patch)
tree24471f2f1c33cd6516b0cd1bc8efeb07576b83ad /cli/js/file_info.ts
parent8d1ba3552fbbcae9284fdab63cc6613045684d01 (diff)
Rename perm to mode (#4276)
There's a lot of variation in doc comments and internal code about whether chmod/0o777-style permissions are called `mode` or `perm`. (For example, mkdir and writeFile choose differently.) Had proposed earlier to go consistently with `perm`, but on balance devs prefer to go with `mode`.
Diffstat (limited to 'cli/js/file_info.ts')
-rw-r--r--cli/js/file_info.ts7
1 files changed, 4 insertions, 3 deletions
diff --git a/cli/js/file_info.ts b/cli/js/file_info.ts
index 71ecbee89..5e4da2a77 100644
--- a/cli/js/file_info.ts
+++ b/cli/js/file_info.ts
@@ -30,9 +30,10 @@ export interface FileInfo {
*
* _Linux/Mac OS only._ */
ino: number | null;
- /** 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.
- */
+ /** **UNSTABLE**: Match behavior with Go on windows for `mode`.
+ *
+ * The underlying raw `st_mode` bits that contain the standard Unix
+ * permissions for this file/directory. */
mode: number | null;
/** Number of hard links pointing to this file.
*