virtual-file-system
TypeScript icon, indicating that this package has built-in type declarations

1.2.10 • Public • Published

virtual-file-system

npm package for virtual file systems (directories, files)

npm i virtual-file-system

Exports classes File and Directory

export { File, Directory };
declare class File {
  name: string;
  data: string;
  metadata: any;
  location: string;
  constructor(
    name: string,
    data: string,
    options?: {
      location?: string;
    }
  );
  write(location?: string): void;
  static read(path: string): File | null;
  getExtension(): string;
  getNameWithoutExtension(): string;
  getPath(): string;
  toString(): string;
}
declare class Directory {
  name: string;
  location: string;
  files: File[];
  directories: Directory[];
  constructor(name: string, location?: string);
  /**
   * Overwrites existing folder.
   * @param {string} location
   */
  write(location?: string): void;
  writeContents(location?: string): void;
  static read(path: string, exclude?: (RegExp | string)[]): Directory | null;
  getDirectories(name: string): Directory[];
  getDirectory(name: string): Directory | null;
  getFiles(name: RegExp | string): File[];
  getFile(name: RegExp | string): File | null;
  removeFile(file: File): void;
  apply(func: (f: File) => void): void;
  filter(func: (f: File) => boolean): void;
  toString(): string;
}

Readme

Keywords

none

Package Sidebar

Install

npm i virtual-file-system

Weekly Downloads

2

Version

1.2.10

License

ISC

Unpacked Size

9.81 kB

Total Files

6

Last publish

Collaborators

  • magnetenstad