@fncts/node 0.0.1

package/fs/api.d.ts

@@ -0,0 +1,150 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { HKT } from "@fncts/typelevel/HKT";
+import { Newtype } from "@fncts/base/data/Newtype";
+import { IO, FIO } from "@fncts/io/IO";
+import { Stream } from "@fncts/io/Stream";
+import { Byte } from "@fncts/base/data/Byte";
+import { Sink } from "@fncts/io/Sink/definition";
+import { Maybe } from "@fncts/base/data/Maybe";
+import { Conc } from "@fncts/base/collection/immutable/Conc";
+import { Channel } from "@fncts/io/Channel";
+import * as fs from "fs";
+declare type ErrnoException = NodeJS.ErrnoException;
+interface FileDescriptorN extends HKT {
+    readonly [HKT.T]: FileDescriptor;
+}
+export interface FileDescriptor extends Newtype<{
+    readonly FileDescriptor: unique symbol;
+}, number> {
+}
+export declare const FileDescriptor: import("@fncts/base/data/Newtype").NewtypeIso<FileDescriptorN>;
+export declare function access(path: fs.PathLike, mode: number | undefined): FIO<ErrnoException, void>;
+export declare function appendFile(path: fs.PathLike | FileDescriptor, data: string | Buffer, options?: fs.WriteFileOptions): FIO<ErrnoException, void>;
+export declare function chmod(path: fs.PathLike, mode: fs.Mode): FIO<ErrnoException, void>;
+export declare function close(fd: FileDescriptor): FIO<ErrnoException, void>;
+export declare function chown(path: fs.PathLike, uid: number, gid: number): FIO<ErrnoException, void>;
+export declare function copyFile(src: fs.PathLike, dest: fs.PathLike, flags: number): FIO<ErrnoException, void>;
+interface CreateReadStreamOptions {
+    chunkSize?: number;
+    flags?: fs.OpenMode;
+    mode?: string | number;
+    start?: number;
+    end?: number;
+}
+export declare function createReadStream(path: fs.PathLike, options?: CreateReadStreamOptions): Stream<unknown, ErrnoException, Byte>;
+interface CreateWriteSinkOptions {
+    flags?: fs.OpenMode;
+    mode?: string | number;
+    start?: number;
+}
+export declare function createWriteSink<InErr>(path: fs.PathLike, options?: CreateWriteSinkOptions): Sink<unknown, InErr | ErrnoException, Byte, never, void>;
+export declare function fchmod(fd: FileDescriptor, mode: fs.Mode): FIO<ErrnoException, void>;
+export declare function fchown(fd: FileDescriptor, uid: number, gid: number): FIO<ErrnoException, void>;
+export declare function fdatasync(fd: FileDescriptor): FIO<ErrnoException, void>;
+export declare function fstat(fd: FileDescriptor): FIO<ErrnoException, fs.Stats>;
+export declare function fsync(fd: FileDescriptor): FIO<ErrnoException, void>;
+export declare function ftruncate(fd: FileDescriptor, len: number): FIO<ErrnoException, void>;
+export declare function futimes(fd: FileDescriptor, atime: string | number | Date, mtime: string | number | Date): FIO<ErrnoException, void>;
+export declare function lchmod(path: fs.PathLike, mode: fs.Mode): FIO<ErrnoException, void>;
+export declare function lchown(path: fs.PathLike, uid: number, gid: number): FIO<ErrnoException, void>;
+export declare function lutimes(path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): FIO<ErrnoException, void>;
+export declare function link(path: fs.PathLike, newPath: fs.PathLike): FIO<ErrnoException, void>;
+export declare function lstat(path: fs.PathLike): FIO<ErrnoException, fs.Stats>;
+export declare function mkdir(path: fs.PathLike, options?: {
+    recursive?: boolean;
+    mode?: fs.Mode;
+}): FIO<ErrnoException, Maybe<string>>;
+export declare function mkdtemp(prefix: string, options?: {
+    encoding?: BufferEncoding;
+}): FIO<ErrnoException, string>;
+export declare function open(path: fs.PathLike, flags: fs.OpenMode, mode?: string | number): FIO<NodeJS.ErrnoException, FileDescriptor>;
+export declare class Dir {
+    readonly path: string;
+    private readonly _dir;
+    constructor(dir: fs.Dir);
+    close(): FIO<ErrnoException, void>;
+    read(): FIO<ErrnoException, Maybe<fs.Dirent>>;
+}
+export declare function opendir(path: fs.PathLike, options?: fs.OpenDirOptions): FIO<ErrnoException, Dir>;
+export declare function read(fd: FileDescriptor, length: number, position?: number): FIO<ErrnoException, readonly [number, Buffer]>;
+export declare function readFile(file: fs.PathOrFileDescriptor, options: {
+    flag?: string;
+    encoding: BufferEncoding;
+}): FIO<ErrnoException, string>;
+export declare function readFile(file: fs.PathOrFileDescriptor, options?: {
+    flag?: string;
+}): FIO<ErrnoException, Buffer>;
+export declare function readdir(path: fs.PathLike, options?: {
+    encoding?: BufferEncoding;
+    withFileTypes?: false;
+}): FIO<ErrnoException, ReadonlyArray<string>>;
+export declare function readdir(path: fs.PathLike, options: {
+    encoding: "buffer";
+    withFileTypes?: false;
+}): FIO<ErrnoException, ReadonlyArray<Buffer>>;
+export declare function readdir(path: fs.PathLike, options: {
+    encoding?: BufferEncoding;
+    withFileTypes: true;
+}): FIO<ErrnoException, ReadonlyArray<Dir>>;
+export declare function realpath(path: fs.PathLike, options?: {
+    encoding?: BufferEncoding;
+}): FIO<ErrnoException, string>;
+export declare function realpath(path: fs.PathLike, options: {
+    encoding: "buffer";
+}): FIO<ErrnoException, Buffer>;
+export declare function realpathNative(path: fs.PathLike, options?: {
+    encoding?: BufferEncoding;
+}): FIO<ErrnoException, string>;
+export declare function realpathNative(path: fs.PathLike, options: {
+    encoding: "buffer";
+}): FIO<ErrnoException, Buffer>;
+export declare function rename(oldPath: fs.PathLike, newPath: fs.PathLike): FIO<ErrnoException, void>;
+export declare function rm(path: fs.PathLike, options?: fs.RmOptions): FIO<ErrnoException, void>;
+export declare function rmdir(path: fs.PathLike, options?: fs.RmDirOptions): FIO<ErrnoException, void>;
+export declare function stat(path: fs.PathLike, options?: {
+    bigint?: false;
+}): FIO<ErrnoException, fs.Stats>;
+export declare function stat(path: fs.PathLike, options: {
+    bigint: true;
+}): FIO<ErrnoException, fs.BigIntStats>;
+export declare function symlink(target: fs.PathLike, path: fs.PathLike): FIO<ErrnoException, void>;
+export declare function truncate(path: fs.PathLike, len?: number): FIO<ErrnoException, void>;
+export declare function unlink(path: fs.PathLike): FIO<ErrnoException, void>;
+export declare function utimes(path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): FIO<ErrnoException, void>;
+export declare function write(fd: FileDescriptor, buffer: Conc<Byte>, position?: number): FIO<ErrnoException, number>;
+export interface WriteFileOptions {
+    readonly encoding?: BufferEncoding;
+    readonly mode?: fs.Mode;
+    readonly flag?: string;
+}
+export declare function writeFile(file: fs.PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): IO<unknown, ErrnoException, void>;
+export declare function writev(fd: FileDescriptor, buffers: ReadonlyArray<Uint8Array>, position?: number): FIO<ErrnoException, number>;
+export declare function watch(filename: fs.PathLike, options: {
+    persistent?: boolean;
+    recursive?: boolean;
+    encoding: "buffer";
+}): Stream<unknown, Error, {
+    eventType: "rename" | "change";
+    filename: Buffer;
+}>;
+export declare function watch(filename: fs.PathLike, options?: {
+    persistent?: boolean;
+    recursive?: boolean;
+    encoding?: BufferEncoding;
+}): Stream<unknown, Error, {
+    eventType: "rename" | "change";
+    filename: string;
+}>;
+export declare function watchFile(filename: fs.PathLike, options: {
+    bigint: true;
+    persistent?: boolean;
+    interval?: number;
+}): Stream<unknown, never, [fs.BigIntStats, fs.BigIntStats]>;
+export declare function watchFile(filename: fs.PathLike, options?: {
+    bigint?: false;
+    persistent?: boolean;
+    interval?: number;
+}): Stream<unknown, never, [fs.Stats, fs.Stats]>;
+export {};

package/fs.d.ts

@@ -0,0 +1 @@
+export * from "./fs/api.js";

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@fncts/node",
+  "version": "0.0.1",
+  "dependencies": {
+    "@fncts/io": "0.0.8"
+  },
+  "exports": {
+    "./*": {
+      "import": "./_mjs/*.mjs",
+      "require": "./_cjs/*.cjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}