extra-filesystem

Install

1npm install --save extra-filesystem
2# or
3yarn add extra-filesystem

API

createTempDir

1function createTempDir(): Promise<string>

createTempDirSync

1function createTempDirSync(): string

createTempFile

1function createTempFile(): Promise<string>

createTempFileSync

1function createTempFileSync(): string

createTempName

1function createTempName(): Promise<stirng>

createTempNameSync

1function createTempNameSync(): string

emptyDir

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

emptyDirSync

1function emptyDirSync(dirname: string): void

ensureDir

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

ensureDirSync

1function ensureDirSync(dirname: string): void

ensureFile

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

ensureFileSync

1function ensureFileSync(filename: string): void

pathExists

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

pathExistsSync

1function pathExistsSync(path: string): boolean

readNDJSONFile

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

readNDJSONFileSync

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

readYAMLFile

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

readYAMLFileSync

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

readJSONFile

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

readJSONFileSync

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

writeJSONFile

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

writeJSONFileSync

1function writeJSONFileSync(
2  filename: string
3, data: unknown
4, options?: { spaces?: number }
5): void

writeYAMLFile

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

writeYAMLFileSync

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

move

1function move(oldPath: string, newPath: string): Promise<void>

moveSync

1function moveSync(oldPath: string, newPath: string): void

copy

1function copy(sourcePath: string, destinationPath: string): Promise<void>

copySync

1function copySync(sourcePath: string, destinationPath: string): void

remove

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

removeSync

1function removeSync(path: string): void

isDirectory

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

isFile

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

isWritable

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

isReadable

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

findAllFilenames

1function findAllFilenames(
2  dirname: string
3, predicate: (dirname: string) => boolean = _ => true
4): AsyncIterableIterator<string>

findAllDirnames

1function findAllDirnames(
2  dirname: string
3, predicate: (dirname: string) => boolean = _ => true
4): AsyncIterableIterator<string>

getLongExtension

1function getLongExtension(filename: string): string

Get the longest possible extension.

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

getShortBasename

1function getShortBasename(filename: string): string

Get the shortest possible basename.

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

readFileLineByLine

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

readFileLineByLineSync

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

writeIterableToFile

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

isSubPathOf

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

checksumFile

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

findUpPackageFilename

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

findUpPackageFilenameSync

1function findUpPackageFilenameSync(pathname: string): string | undefined