🙃📒 flipfile
file helpers for reading, writing, deleting, checking types & existence, extracting metadata, walking, globbing, and more.
📦 usage
yarn add flipfilenpm i flipfile --save
const flipfile =
🌐 api (everything is synchronous)
- getFileAndPath
(file: stringPath) => {file: string, dir: string}
- getDirectories
(src: string, blacklist: Array<string>) => array<string>
- isDir
(file: stringPath) => boolean
- isFile
(file: stringPath) => boolean
- isRel
(file: stringPath) => boolean
- isFile
(file: stringPath) => boolean
- read
(dir: stringPath) => string
- write
(file: stringPath, contents: string) => void
writes to folder, uses mkdir if it does not exist - exists
(file: stringPath) => boolean
- fileName
(file: stringPath) => string
- isFileOrDir
(file: stringPath) => bool
- walk
(dir: stringPath, {recursive: true}) => Array<string | Array<Array<string>>
- mkdirp
- node-path-extras exports
size
everything in #api is exported in the main entry point, so it can be used as
const exists isFile = const file = './index.js'if console
or as modular imports for fastest / smallest access
const isRel = const write = const file = './src'if
convenience
additionally there are 3 files not exported in the index
- they can be used by requiring them by name,
- or if you prefer destructuring, from
flipfile/all
- exports everything in #api alongside these additional ones
- exports a flattened
path
module
- glob
require('flipfile/glob')
- extra
require('flipfile/extra')
- @NOTE: everything in
extra
is exported flat as well
- promise
require('flipfile/glob')
- @NOTE:
- fs-promise is not a dependency, so it will check if it's installed and if not, export is an empty object
- glob-fs got 💩 depreciated in favor of node-glob
const extra // fs-extra module promise // fs-promise or empty object exists // flipfile.exists copySync // flat export from fs-extra glob // glob-fs fs // real 'fs' resolve // flat export from path join // flat export from path} = const out = const src = if
📝 TODO:
⛓ chain:
const flipfile = flipfile