foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-21 15:04:11 -05:00
Code Issues Packages 1 Wiki Activity

docs(fs): add default info of OpenOptions (#16104)

Browse source
This commit is contained in:
Hirotaka Tagawa / wafuwafu13 2022-10-04 00:22:40 +09:00 committed by GitHub
parent d13c88e70d
commit a4a628dc6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
cli/dts/lib.deno.ns.d.ts vendored
View file

@ -1975,27 +1975,27 @@ declare namespace Deno {
*
* @category File System */
export interface OpenOptions {
/** Sets the option for read access. This option, when `true`, means that
/** Defaults to `true`. Sets the option for read access. This option, when `true`, means that
* the file should be read-able if opened. */
read?: boolean;
/** Sets the option for write access. This option, when `true`, means that
/** Defaults to `false`. Sets the option for write access. This option, when `true`, means that
* the file should be write-able if opened. If the file already exists,
* any write calls on it will overwrite its contents, by default without
* truncating it. */
write?: boolean;
/** Sets the option for the append mode. This option, when `true`, means
/** Defaults to `false`. Sets the option for the append mode. This option, when `true`, means
* that writes will append to a file instead of overwriting previous
* contents.
*
* Note that setting `{ write: true, append: true }` has the same effect as
* setting only `{ append: true }`. */
append?: boolean;
/** Sets the option for truncating a previous file. If a file is
/** Defaults to `false`. Sets the option for truncating a previous file. If a file is
* successfully opened with this option set it will truncate the file to `0`
* size if it already exists. The file must be opened with write access
* for truncate to work. */
truncate?: boolean;
/** Sets the option to allow creating a new file, if one doesn't already
/** Defaults to `false`. Sets the option to allow creating a new file, if one doesn't already
* exist at the specified path. Requires write or append access to be
* used. */
create?: boolean;