foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-26 17:19:06 -05:00
Code Issues Packages 1 Wiki Activity

Chmod API documentation improvements (#4427)

Browse source
This commit is contained in:
Chris Knight 2020-03-19 01:25:01 +00:00 committed by GitHub
parent 2a34cbfaf9
commit 54d1f299dc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
cli/js/lib.deno.ns.d.ts vendored
View file

@ -948,6 +948,10 @@ declare namespace Deno {
*
* Deno.chmodSync("/path/to/file", 0o666);
*
* For a full description, see [chmod](#chmod)
*
* NOTE: This API currently has no effect on Windows
*
* Requires `allow-write` permission. */
export function chmodSync(path: string, mode: number): void;
@ -956,6 +960,26 @@ declare namespace Deno {
*
* await Deno.chmod("/path/to/file", 0o666);
*
* The mode is a sequence of 3 octal numbers. The first/left-most number
* specifies the permissions for the owner. The second number specifies the
* permissions for the group. The last/right-most number specifies the
* permissions for others. For example, with a mode of 0o764, the owner (7) can
* read/write/execute, the group (6) can read/write and everyone else (4) can
* read only.
*
* | Number | Description |
* | ------ | ----------- |
* | 7 | read, write, and execute |
* | 6 | read and write |
* | 5 | read and execute |
* | 4 | read only |
* | 3 | write and execute |
* | 2 | write only |
* | 1 | execute only |
* | 0 | no permission |
*
* NOTE: This API currently has no effect on Windows
*
* Requires `allow-write` permission. */
export function chmod(path: string, mode: number): Promise<void>;