yann-fs v1.6.0

fs

Description

Only the fs extras asynchronous method is supported, and then the then and catch of the promise are intercepted and processed

Usage

mjs

import fs, { remove } from 'yann-fs';

const [err, data] = await fs.remove(path);
// or
const [err, data] = await remove(path);

cjs

const fs = require('yann-fs);

const [err, data] = await fs.remove(path);

API

export function copy(
  src: string,
  dest: string,
  options?: fse.CopyOptions | undefined
): Promise<[Error, undefined] | [null, void]>;

export function emptyDir(
  path: string
): Promise<[Error, undefined] | [null, void]>;

export function ensureFile(
  path: string
): Promise<[Error, undefined] | [null, void]>;

export function ensureDir(
  path: string,
  options?: fse.EnsureOptions | number
): Promise<[Error, undefined] | [null, void]>;

export function move(
  src: string,
  dest: string,
  options?: fse.MoveOptions
): Promise<[Error, undefined] | [null, void]>;

export function outputFile(
  file: string,
  data: any,
  options?: fse.WriteFileOptions | BufferEncoding | string
): Promise<[Error, undefined] | [null, void]>;

export function outputJson(
  file: string,
  data: any,
  options?: fse.WriteOptions | BufferEncoding | string
): Promise<[Error, undefined] | [null, void]>;

export function writeJson(
  file: string,
  object: any,
  options?: fse.WriteOptions | BufferEncoding | string
): Promise<[Error, undefined] | [null, void]>;

export function writeFile(
  file: number | fse.PathLike,
  data: any,
  options?: fse.WriteFileOptions | BufferEncoding | string
): Promise<[Error, undefined] | [null, void]>;

export function pathExists(
  path: string
): Promise<[Error, undefined] | [null, boolean]>;

export function readJson(
  file: string,
  options?: fse.ReadOptions | BufferEncoding | string
): Promise<[Error, undefined] | [null, any]>;

export function remove(dir: string): Promise<[Error, undefined] | [null, void]>;

export function ensureLink(
  src: string,
  dest: string
): Promise<[Error, undefined] | [null, void]>;

export function ensureSymlink(
  src: string,
  dest: string,
  type?: fse.SymlinkType
): Promise<[Error, undefined] | [null, void]>;

export function stat(
  path: PathLike
): Promise<[Error, undefined] | [null, Stats]>;

export function appendFile(
  file: PathLike | number,
  data: any,
  options?:
    | {
        encoding?: BufferEncoding | string | undefined;
        mode?: number | string | undefined;
        flag?: string | undefined;
      }
    | BufferEncoding
    | string
): Promise<[Error, undefined] | [null, void]>;

export function isDir(
  path: PathLike,
  errHandler?: (err: Error) => void
): Promise<boolean | undefined>;

// 拦截报错，可以通过设置fsConfig的errHandler进行全局拦截报错
export declare function fsTo<T>(
  promise: Promise<[Error, undefined] | [null, T]>,
  errHandler?: (err: Error) => void
): Promise<T | undefined>;

interface fsConfig {
  // 全局配置报错拦截
  errHandler: (err: Error) => void;
}
// 全局配置
export const fsConfig: fsConfig;