npm install --save extra-filesystem
# or
yarn add extra-filesystem
function createTempDir(): Promise<string>
function createTempDirSync(): string
function createTempFile(): Promise<string>
function createTempFileSync(): string
function createTempName(): Promise<stirng>
function createTempNameSync(): string
function emptyDir(dirname: string): Promise<void>
function emptyDirSync(dirname: string): void
function ensureDir(dirname: string): Promise<void>
function ensureDirSync(dirname: string): void
function ensureFile(filename: string): Promise<void>
function ensureFileSync(filename: string): void
function pathExists(path: string): Promise<boolean>
function pathExistsSync(path: string): boolean
function readNDJSONFile<T>(
filename: string
, encoding: BufferEncoding = 'utf-8'
): AsyncIterableIterator<T>
function readNDJSONFileSync<T>(
filename: string
, encoding: BufferEncoding = 'utf-8'
): IterableIterator<T>
function readYAMLFile<T>(
filename: string
, encoding: BufferEncoding = 'utf-8'
): Promise<T>
function readYAMLFileSync<T>(
filename: string
, encoding: BufferEncoding = 'utf-8'
): T
function readJSONFile<T>(
filename: string
, encoding: BufferEncoding = 'utf-8'
): Promise<T>
function readJSONFileSync<T>(
filename: string
, encoding: BufferEncoding = 'utf-8'
): T
function writeJSONFile(
filename: string
, data: unknown
, options?: { spaces?: number }
): Promise<void>
function writeJSONFileSync(
filename: string
, data: unknown
, options?: { spaces?: number }
): void
function writeYAMLFile(filename: string, data: unknown): Promise<void>
function writeYAMLFileSync(filename: string, data: unknown): void
function move(oldPath: string, newPath: string): Promise<void>
function moveSync(oldPath: string, newPath: string): void
function copy(sourcePath: string, destinationPath: string): Promise<void>
function copySync(sourcePath: string, destinationPath: string): void
function remove(path: string): Promise<void>
function removeSync(path: string): void
function isDirectory(path: string): Promise<boolean>
function isFile(path: string): Promise<boolean>
function isWritable(path: string): Promise<boolean>
function isReadable(path: string): Promise<boolean>
function findAllFilenames(
dirname: string
, predicate: (dirname: string) => boolean = _ => true
): AsyncIterableIterator<string>
function findAllDirnames(
dirname: string
, predicate: (dirname: string) => boolean = _ => true
): AsyncIterableIterator<string>
function getLongExtension(filename: string): string
Get the longest possible extension.
getLongExtension('file.tar.gz') // '.tar.gz'
function getShortBasename(filename: string): string
Get the shortest possible basename.
getShortBasename('file.tar.gz') // 'file'
function readFileLineByLine(
filename: string
, encoding: BufferEncoding = 'utf-8'
): AsyncIterable<string>
function* readFileLineByLineSync(
filename: string
, encoding: BufferEncoding = 'utf-8'
): IterableIterator<string>
function writeIterableToFile(
filename: string
, iterable: Iterable<string> | AsyncIterable<string>
): Promise<void>
function isSubPathOf(subject: string, object: string): boolean
function checksumFile(algorithm: string, filename: string): Promise<string>
function findUpPackageFilename(pathname: string): Promise<string | undefined>
function findUpPackageFilenameSync(pathname: string): string | undefined