@zenfs/core 0.0.1

package/dist/emulation/promises.d.ts

@@ -0,0 +1,309 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { ReadStream, WriteStream, FSWatcher, symlink as _symlink } from 'node:fs';
+import * as constants from './constants';
+export { constants };
+import { FileContents } from '../filesystem';
+import { Stats } from '../stats';
+/**
+ * Renames a file
+ * @param oldPath
+ * @param newPath
+ */
+export declare function rename(oldPath: string, newPath: string): Promise<void>;
+/**
+ * Test whether or not the given path exists by checking with the file system.
+ * @param path
+ */
+export declare function exists(path: string): Promise<boolean>;
+/**
+ * `stat`.
+ * @param path
+ * @returns Stats
+ */
+export declare function stat(path: string): Promise<Stats>;
+/**
+ * `lstat`.
+ * `lstat()` is identical to `stat()`, except that if path is a symbolic link,
+ * then the link itself is stat-ed, not the file that it refers to.
+ * @param path
+ * @return [ZenFS.node.fs.Stats]
+ */
+export declare function lstat(path: string): Promise<Stats>;
+/**
+ * `truncate`.
+ * @param path
+ * @param len
+ */
+export declare function truncate(path: string, len?: number): Promise<void>;
+/**
+ * `unlink`.
+ * @param path
+ */
+export declare function unlink(path: string): Promise<void>;
+/**
+ * file open.
+ * @see http://www.manpagez.com/man/2/open/
+ * @param path
+ * @param flags
+ * @param mode defaults to `0644`
+ */
+export declare function open(path: string, flag: string, mode?: number | string): Promise<number>;
+/**
+ * Synchronously reads the entire contents of a file.
+ * @param filename
+ * @param options
+ * @option options [String] encoding The string encoding for the file contents. Defaults to `null`.
+ * @option options [String] flag Defaults to `'r'`.
+ * @return [String | ZenFS.node.Buffer]
+ */
+export declare function readFile(filename: string, options?: {
+    flag?: string;
+}): Promise<Buffer>;
+export declare function readFile(filename: string, options: {
+    encoding: string;
+    flag?: string;
+}): Promise<string>;
+export declare function readFile(filename: string, encoding: string): Promise<string>;
+/**
+ * Synchronously writes data to a file, replacing the file if it already
+ * exists.
+ *
+ * The encoding option is ignored if data is a buffer.
+ * @param filename
+ * @param data
+ * @param options
+ * @option options [String] encoding Defaults to `'utf8'`.
+ * @option options [Number] mode Defaults to `0644`.
+ * @option options [String] flag Defaults to `'w'`.
+ */
+export declare function writeFile(filename: string, data: FileContents, options?: {
+    encoding?: string;
+    mode?: number | string;
+    flag?: string;
+}): Promise<void>;
+export declare function writeFile(filename: string, data: FileContents, encoding?: string): Promise<void>;
+export declare function writeFile(filename: string, data: FileContents, options?: {
+    encoding?: string;
+    mode?: number | string;
+    flag?: string;
+} | string): Promise<void>;
+/**
+ * Asynchronously append data to a file, creating the file if it not yet
+ * exists.
+ *
+ * @example Usage example
+ *   fs.appendFile('message.txt', 'data to append', function (err) {
+ *     if (err) throw err;
+ *     console.log('The "data to append" was appended to file!');
+ *   });
+ * @param filename
+ * @param data
+ * @param options
+ * @option options [String] encoding Defaults to `'utf8'`.
+ * @option options [Number] mode Defaults to `0644`.
+ * @option options [String] flag Defaults to `'a'`.
+ */
+export declare function appendFile(filename: string, data: FileContents, options?: {
+    encoding?: string;
+    mode?: number | string;
+    flag?: string;
+}): Promise<void>;
+export declare function appendFile(filename: string, data: FileContents, encoding?: string): Promise<void>;
+/**
+ * `fstat`.
+ * `fstat()` is identical to `stat()`, except that the file to be stat-ed is
+ * specified by the file descriptor `fd`.
+ * @param fd
+ * @return [ZenFS.node.fs.Stats]
+ */
+export declare function fstat(fd: number): Promise<Stats>;
+/**
+ * close.
+ * @param fd
+ */
+export declare function close(fd: number): Promise<void>;
+/**
+ * ftruncate.
+ * @param fd
+ * @param len
+ */
+export declare function ftruncate(fd: number, len?: number): Promise<void>;
+/**
+ * fsync.
+ * @param fd
+ */
+export declare function fsync(fd: number): Promise<void>;
+/**
+ * fdatasync.
+ * @param fd
+ */
+export declare function fdatasync(fd: number): Promise<void>;
+/**
+ * Write buffer to the file specified by `fd`.
+ * Note that it is unsafe to use fs.write multiple times on the same file
+ * without waiting for it to return.
+ * @param fd
+ * @param buffer Buffer containing the data to write to
+ *   the file.
+ * @param offset Offset in the buffer to start reading data from.
+ * @param length The amount of bytes to write to the file.
+ * @param position Offset from the beginning of the file where this
+ *   data should be written. If position is null, the data will be written at
+ *   the current position.
+ */
+export declare function write(fd: number, buffer: Buffer, offset: number, length: number, position?: number): Promise<number>;
+export declare function write(fd: number, data: string, position?: number | null, encoding?: BufferEncoding): Promise<number>;
+/**
+ * Read data from the file specified by `fd`.
+ * @param fd
+ * @param buffer The buffer that the data will be
+ *   written to.
+ * @param offset The offset within the buffer where writing will
+ *   start.
+ * @param length An integer specifying the number of bytes to read.
+ * @param position An integer specifying where to begin reading from
+ *   in the file. If position is null, data will be read from the current file
+ *   position.
+ */
+export declare function read(fd: number, buffer: Buffer, offset: number, length: number, position?: number): Promise<{
+    bytesRead: number;
+    buffer: Buffer;
+}>;
+/**
+ * `fchown`.
+ * @param fd
+ * @param uid
+ * @param gid
+ */
+export declare function fchown(fd: number, uid: number, gid: number): Promise<void>;
+/**
+ * `fchmod`.
+ * @param fd
+ * @param mode
+ */
+export declare function fchmod(fd: number, mode: number | string): Promise<void>;
+/**
+ * Change the file timestamps of a file referenced by the supplied file
+ * descriptor.
+ * @param fd
+ * @param atime
+ * @param mtime
+ */
+export declare function futimes(fd: number, atime: number | Date, mtime: number | Date): Promise<void>;
+/**
+ * `rmdir`.
+ * @param path
+ */
+export declare function rmdir(path: string): Promise<void>;
+/**
+ * `mkdir`.
+ * @param path
+ * @param mode defaults to `0777`
+ */
+export declare function mkdir(path: string, mode?: number | string): Promise<void>;
+/**
+ * `readdir`. Reads the contents of a directory.
+ * @param path
+ * @return [String[]]
+ */
+export declare function readdir(path: string): Promise<string[]>;
+/**
+ * `link`.
+ * @param srcpath
+ * @param dstpath
+ */
+export declare function link(srcpath: string, dstpath: string): Promise<void>;
+/**
+ * `symlink`.
+ * @param srcpath
+ * @param dstpath
+ * @param type can be either `'dir'` or `'file'` (default is `'file'`)
+ */
+export declare function symlink(srcpath: string, dstpath: string, type?: _symlink.Type): Promise<void>;
+/**
+ * readlink.
+ * @param path
+ * @return [String]
+ */
+export declare function readlink(path: string): Promise<string>;
+/**
+ * `chown`.
+ * @param path
+ * @param uid
+ * @param gid
+ */
+export declare function chown(path: string, uid: number, gid: number): Promise<void>;
+/**
+ * `lchown`.
+ * @param path
+ * @param uid
+ * @param gid
+ */
+export declare function lchown(path: string, uid: number, gid: number): Promise<void>;
+/**
+ * `chmod`.
+ * @param path
+ * @param mode
+ */
+export declare function chmod(path: string, mode: string | number): Promise<void>;
+/**
+ * `lchmod`.
+ * @param path
+ * @param mode
+ */
+export declare function lchmod(path: string, mode: number | string): Promise<void>;
+/**
+ * Change file timestamps of the file referenced by the supplied path.
+ * @param path
+ * @param atime
+ * @param mtime
+ */
+export declare function utimes(path: string, atime: number | Date, mtime: number | Date): Promise<void>;
+/**
+ * Change file timestamps of the file referenced by the supplied path.
+ * @param path
+ * @param atime
+ * @param mtime
+ */
+export declare function lutimes(path: string, atime: number | Date, mtime: number | Date): Promise<void>;
+/**
+ * `realpath`.
+ * @param path
+ * @param cache An object literal of mapped paths that can be used to
+ *   force a specific path resolution or avoid additional `fs.stat` calls for
+ *   known real paths.
+ * @return [String]
+ */
+export declare function realpath(path: string, cache?: {
+    [path: string]: string;
+}): Promise<string>;
+export declare function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): Promise<void>;
+export declare function watchFile(filename: string, options: {
+    persistent?: boolean;
+    interval?: number;
+}, listener: (curr: Stats, prev: Stats) => void): Promise<void>;
+export declare function unwatchFile(filename: string, listener?: (curr: Stats, prev: Stats) => void): Promise<void>;
+export declare function watch(filename: string, listener?: (event: string, filename: string) => any): Promise<FSWatcher>;
+export declare function watch(filename: string, options: {
+    persistent?: boolean;
+}, listener?: (event: string, filename: string) => any): Promise<FSWatcher>;
+/**
+ * `access`.
+ * @param path
+ * @param mode
+ */
+export declare function access(path: string, mode?: number): Promise<void>;
+export declare function createReadStream(path: string, options?: {
+    flags?: string;
+    encoding?: string;
+    fd?: number;
+    mode?: number;
+    autoClose?: boolean;
+}): Promise<ReadStream>;
+export declare function createWriteStream(path: string, options?: {
+    flags?: string;
+    encoding?: string;
+    fd?: number;
+    mode?: number;
+}): Promise<WriteStream>;