0.5.1 • Published 10 months ago
extra-filesystem v0.5.1
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(oldPath: string, newPath: string): Promise<void>
moveSync
function moveSync(oldPath: string, newPath: string): void
copy
function copy(sourcePath: string, destinationPath: string): Promise<void>
copySync
function copySync(sourcePath: string, destinationPath: string): void
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) => boolean = _ => true
): AsyncIterableIterator<string>
findAllDirnames
function findAllDirnames(
dirname: string
, predicate: (dirname: string) => 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
0.5.1
10 months ago
0.5.0
1 year ago
0.4.9
1 year ago
0.4.10
1 year ago
0.4.8
1 year ago
0.4.7
1 year ago
0.4.6
1 year ago
0.4.5
2 years ago
0.4.4
2 years ago
0.4.3
2 years ago
0.4.2
2 years ago
0.3.14
2 years ago
0.4.1
2 years ago
0.4.0
2 years ago
0.3.13
2 years ago
0.3.12
2 years ago
0.3.11
3 years ago
0.3.10
3 years ago
0.3.9
3 years ago
0.3.8
3 years ago
0.3.6
3 years ago
0.3.7
3 years ago
0.3.5
3 years ago
0.3.4
3 years ago
0.3.3
3 years ago
0.2.20
3 years ago
0.2.19
3 years ago
0.2.18
3 years ago
0.2.17
3 years ago
0.2.16
3 years ago
0.2.14
3 years ago
0.2.12
3 years ago
0.2.11
3 years ago
0.2.10
3 years ago
0.3.0
3 years ago
0.2.9
3 years ago
0.2.8
3 years ago
0.3.2
3 years ago
0.3.1
3 years ago
0.2.7
3 years ago
0.2.6
3 years ago
0.2.5
3 years ago
0.2.4
3 years ago
0.2.3
3 years ago
0.2.2
3 years ago
0.2.1
3 years ago
0.2.0
3 years ago
0.1.0
3 years ago