extra-filesystem

Install

npm install --save extra-filesystem
# or
yarn add extra-filesystem

API

createTempDir

function createTempDir(): Promise<string>

createTempDirSync

function createTempDirSync(): string

createTempFile

function createTempFile(): Promise<string>

createTempFileSync

function createTempFileSync(): string

createTempName

function createTempName(): Promise<stirng>

createTempNameSync

function createTempNameSync(): string

emptyDir

function emptyDir(dirname: string): Promise<void>

emptyDirSync

function emptyDirSync(dirname: string): void

ensureDir

function ensureDir(dirname: string): Promise<void>

ensureDirSync

function ensureDirSync(dirname: string): void

ensureFile

function ensureFile(filename: string): Promise<void>

ensureFileSync

function ensureFileSync(filename: string): void

pathExists

function pathExists(path: string): Promise<boolean>

pathExistsSync

function pathExistsSync(path: string): boolean

readNDJSONFile

function readNDJSONFile<T>(
  filename: string
, encoding: BufferEncoding = 'utf-8'
): AsyncIterableIterator<T>

readNDJSONFileSync

function readNDJSONFileSync<T>(
  filename: string
, encoding: BufferEncoding = 'utf-8'
): IterableIterator<T>

readYAMLFile

function readYAMLFile<T>(
  filename: string
, encoding: BufferEncoding = 'utf-8'
): Promise<T>

readYAMLFileSync

function readYAMLFileSync<T>(
  filename: string
, encoding: BufferEncoding = 'utf-8'
): T

readJSONFile

function readJSONFile<T>(
  filename: string
, encoding: BufferEncoding = 'utf-8'
): Promise<T>

readJSONFileSync

function readJSONFileSync<T>(
  filename: string
, encoding: BufferEncoding = 'utf-8'
): T

writeJSONFile

function writeJSONFile(
  filename: string
, data: unknown
, options?: { spaces?: number }
): Promise<void>

writeJSONFileSync

function writeJSONFileSync(
  filename: string
, data: unknown
, options?: { spaces?: number }
): void

writeYAMLFile

function writeYAMLFile(filename: string, data: unknown): Promise<void>

writeYAMLFileSync

function writeYAMLFileSync(filename: string, data: unknown): void

move

function move(source: string, destination: string): Promise<void>

Move the file or directory from source to destination.

Unlike the mv command in Bash, it does not support moving a file or directory to a directory.

If a file or directory already exists at the destination, it will throw an error.

If the destination's parent directory does not exist, it will create the parent directory.

moveSync

function moveSync(source: string, destination: string): void

See move().

copy

function copy(source: string, destination: string): Promise<void>

Copy the file or directory from source to destination.

Unlike the cp command in Bash, it does not support copying a file or directory to a directory.

If a file or directory already exists at the destination, it will throw an error.

If the destination's parent directory does not exist, it will create the parent directory.

copySync

function copySync(source: string, destination: string): void

See copy().

remove

function remove(path: string): Promise<void>

removeSync

function removeSync(path: string): void

isDirectory

function isDirectory(path: string): Promise<boolean>

isFile

function isFile(path: string): Promise<boolean>

isWritable

function isWritable(path: string): Promise<boolean>

isReadable

function isReadable(path: string): Promise<boolean>

findAllFilenames

function findAllFilenames(
  dirname: string
, predicate: (dirname: string) => Awaitable<boolean> = _ => true
): AsyncIterableIterator<string>

findAllDirnames

function findAllDirnames(
  dirname: string
, predicate: (dirname: string) => Awaitable<boolean> = _ => true
): AsyncIterableIterator<string>

getLongExtension

function getLongExtension(filename: string): string

Get the longest possible extension.

getLongExtension('file.tar.gz') // '.tar.gz'

getShortBasename

function getShortBasename(filename: string): string

Get the shortest possible basename.

getShortBasename('file.tar.gz') // 'file'

readFileLineByLine

function readFileLineByLine(
  filename: string
, encoding: BufferEncoding = 'utf-8'
): AsyncIterable<string>

readFileLineByLineSync

function* readFileLineByLineSync(
  filename: string
, encoding: BufferEncoding = 'utf-8'
): IterableIterator<string>

writeIterableToFile

function writeIterableToFile(
  filename: string
, iterable: Iterable<string> | AsyncIterable<string>
): Promise<void>

isSubPathOf

function isSubPathOf(subject: string, object: string): boolean

checksumFile

function checksumFile(algorithm: string, filename: string): Promise<string>

findUpPackageFilename

function findUpPackageFilename(pathname: string): Promise<string | undefined>

findUpPackageFilenameSync

function findUpPackageFilenameSync(pathname: string): string | undefined

pathEquals

function pathEquals(a: string, b: string): boolean