Added fs.constants

src/FS.ts

@@ -8,6 +8,8 @@ import Cred from './cred';
 
 import type { ReadStream, WriteStream, FSWatcher } from 'node:fs';
 
+export * as constants from './constants';
+
 /**
  * Wraps a callback function, ensuring it is invoked through setTimeout with a delay of 0.
  * @hidden

src/constants.ts

@@ -0,0 +1,158 @@
+/*
+FS Constants
+See https://nodejs.org/api/fs.html#file-access-constants
+*/
+
+// File Access Constants
+
+/** Constant for fs.access(). File is visible to the calling process. */
+export const F_OK = 0;
+
+/** Constant for fs.access(). File can be read by the calling process. */
+export const R_OK = 4;
+
+/** Constant for fs.access(). File can be written by the calling process. */
+export const W_OK = 2;
+
+/** Constant for fs.access(). File can be executed by the calling process. */
+export const X_OK = 1;
+
+// File Copy Constants
+
+/** Constant for fs.copyFile. Flag indicating the destination file should not be overwritten if it already exists. */
+export const COPYFILE_EXCL = 1;
+
+/**
+ * Constant for fs.copyFile. Copy operation will attempt to create a copy-on-write reflink.
+ * If the underlying platform does not support copy-on-write, then a fallback copy mechanism is used.
+ */
+export const COPYFILE_FICLONE = 2;
+
+/**
+ * Constant for fs.copyFile. Copy operation will attempt to create a copy-on-write reflink.
+ * If the underlying platform does not support copy-on-write, then the operation will fail with an error.
+ */
+export const COPYFILE_FICLONE_FORCE = 4;
+
+// File Open Constants
+
+/** Constant for fs.open(). Flag indicating to open a file for read-only access. */
+export const O_RDONLY = 0;
+
+/** Constant for fs.open(). Flag indicating to open a file for write-only access. */
+export const O_WRONLY = 1;
+
+/** Constant for fs.open(). Flag indicating to open a file for read-write access. */
+export const O_RDWR = 2;
+
+/** Constant for fs.open(). Flag indicating to create the file if it does not already exist. */
+export const O_CREAT = 0o100; // Node internal is 
+
+/** Constant for fs.open(). Flag indicating that opening a file should fail if the O_CREAT flag is set and the file already exists. */
+export const O_EXCL = 0o200;
+
+/**
+ * Constant for fs.open(). Flag indicating that if path identifies a terminal device,
+ * opening the path shall not cause that terminal to become the controlling terminal for the process
+ * (if the process does not already have one).
+ */
+export const O_NOCTTY = 0o400;
+
+/** Constant for fs.open(). Flag indicating that if the file exists and is a regular file, and the file is opened successfully for write access, its length shall be truncated to zero. */
+export const O_TRUNC = 0o1000;
+
+/** Constant for fs.open(). Flag indicating that data will be appended to the end of the file. */
+export const O_APPEND = 0o2000;
+
+/** Constant for fs.open(). Flag indicating that the open should fail if the path is not a directory. */
+export const O_DIRECTORY = 0o200000;
+
+/**
+ * constant for fs.open().
+ * Flag indicating reading accesses to the file system will no longer result in
+ * an update to the atime information associated with the file.
+ * This flag is available on Linux operating systems only.
+ */
+export const O_NOATIME = 0o1000000;
+
+/** Constant for fs.open(). Flag indicating that the open should fail if the path is a symbolic link. */
+export const O_NOFOLLOW = 0o400000;
+
+/** Constant for fs.open(). Flag indicating that the file is opened for synchronous I/O. */
+export const O_SYNC = 0o4010000;
+
+/** Constant for fs.open(). Flag indicating that the file is opened for synchronous I/O with write operations waiting for data integrity. */
+export const O_DSYNC = 0o10000;
+
+/** Constant for fs.open(). Flag indicating to open the symbolic link itself rather than the resource it is pointing to. */
+export const O_SYMLINK = 0o100000;
+
+/** Constant for fs.open(). When set, an attempt will be made to minimize caching effects of file I/O. */
+export const O_DIRECT = 0o40000;
+
+/** Constant for fs.open(). Flag indicating to open the file in nonblocking mode when possible. */
+export const O_NONBLOCK = 0o4000;
+
+// File Type Constants
+
+/** Constant for fs.Stats mode property for determining a file's type. Bit mask used to extract the file type code. */
+export const S_IFMT = 0o170000;
+
+/** Constant for fs.Stats mode property for determining a file's type. File type constant for a regular file. */
+export const S_IFREG = 0o100000;
+
+/** Constant for fs.Stats mode property for determining a file's type. File type constant for a directory. */
+export const S_IFDIR = 0o40000;
+
+/** Constant for fs.Stats mode property for determining a file's type. File type constant for a character-oriented device file. */
+export const S_IFCHR = 0o20000;
+
+/** Constant for fs.Stats mode property for determining a file's type. File type constant for a block-oriented device file. */
+export const S_IFBLK = 0o60000;
+
+/** Constant for fs.Stats mode property for determining a file's type. File type constant for a FIFO/pipe. */
+export const S_IFIFO = 0o10000;
+
+/** Constant for fs.Stats mode property for determining a file's type. File type constant for a symbolic link. */
+export const S_IFLNK = 0o120000;
+
+/** Constant for fs.Stats mode property for determining a file's type. File type constant for a socket. */
+export const S_IFSOCK = 0o140000;
+
+// File Mode Constants
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by owner. */
+export const S_IRWXU = 0o700;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by owner. */
+export const S_IRUSR = 0o400;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by owner. */
+export const S_IWUSR = 0o200;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by owner. */
+export const S_IXUSR = 0o100;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by group. */
+export const S_IRWXG = 0o70;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by group. */
+export const S_IRGRP = 0o40;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by group. */
+export const S_IWGRP = 0o20;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by group. */
+export const S_IXGRP = 0o10;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by others. */
+export const S_IRWXO = 7;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by others. */
+export const S_IROTH = 4;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by others. */
+export const S_IWOTH = 2;
+
+/** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by others. */
+export const S_IXOTH = 1;