# fssys

> npm module to read write folder/files, fs util functions, traverse files and folder using code, or cli, or use glob patterns

Latest version **1.0.2** (published 2022-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install fssys
pnpm add fssys
yarn add fssys
bun add fssys
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-11-19 |
| First published | 2022-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ganesh Bhat |
| Maintainers | ganeshkbhat |

## Links

- npm: https://www.npmjs.com/package/fssys
- Repository: https://github.com/traverse-fs/fssys
- Homepage: https://github.com/traverse-fs/fssys#readme
- Issues: https://github.com/traverse-fs/fssys/issues
- npm.io page: https://npm.io/package/fssys

## Dependencies (1)

- [traverse-fs](https://npm.io/package/traverse-fs.md) ^0.0.9

## Recent versions

- 1.0.2 (latest) — 2022-11-19
- 1.0.1 — 2022-11-01
- 0.0.9 — 2022-10-16
- 0.0.8 — 2022-10-16
- 0.0.7 — 2022-10-15
- 0.0.6 — 2022-09-23
- 0.0.5 — 2022-09-23
- 0.0.4 — 2022-09-21
- 0.0.3 — 2022-09-21
- 0.0.2 — 2022-09-21
- 0.0.1 — 2022-09-19

## README

# fssys
npm module to read write folder/files, fs util functions, traverse files and folder using code, or cli, or use glob patterns

# APIs fssys
APIs to read write folder/files, fs util functions, traverse files and folder using code, or cli, or use glob patterns


## traverse-fs functions
[traverse-fs](https://www.npmjs.com/package/traverse-fs) functions, traverse files and folder using code, or cli, or use glob patterns


#### .search
Usage: .search(d, r, cb = searchCallback, pe, pef, type = "flatarray", options = { search: "all", text: [] })


#### .filter
Usage: .filter(d, r, cb = searchCallback, pe, pef, type = "flatarray", options = { search: "all", text: [] })


#### .regex
Usage: .regex(d, r, cb = searchCallback, pe, pef, type = "flatarray", options = { regex: "all", pattern: null, text: [] })


#### .dir
Usage: .dir(directory, recursive, fetchModifierCallback, handleProcessExit, errorHandler, type, options = { before: () => { }, after: () => { } })


#### .returnNestedArray
Usage: .returnNestedArray(directory, recursive, fetchModifierCallback = defaultFetch, handleProcessExit, errorHandler, type = "nestedarray", options)


#### .returnFlatArray
Usage: .returnFlatArray(directory, recursive, fetchModifierCallback = defaultFetch, handleProcessExit, errorHandler, type = "flatarray", options)


#### .returnJSON
Usage: .returnJSON(directory, recursive, fetchModifierCallback = defaultJSONFetch, handleProcessExit, errorHandler, type = "json", options)


#### .cliargs
Usage: .cliArgs(argList)


#### .callbacks._________

`defaultFetch` Usage: .callbacks.defaultFetch(directory, fileDirent)


`jsonFetch` Usage: .callbacks.jsonFetch(directory, fileDirent)


`errorHandler` Usage: .callbacks.errorHandler(error)


`search` Usage: .callbacks.search(d, f, searchPattern, flag = undefined)


`searchFiles` Usage: .callbacks.searchFiles(d, f, searchPattern, flag = undefined)


`searchFolder` Usage: .callbacks.searchFolder(d, f, searchPattern, flag = undefined)


#### .fsutils._________
read write folder/files


`_isinbuilt` Usage: .fsutils._isinbuilt(mod)


`_createFolders` Usage: .fsutils._createFolders(localGitDir)


`_writeFile` Usage: .fsutils._writeFile(localPath, data, options)


`_registerNodeCache` Usage: .fsutils._registerNodeCache(localGitFileCacheUrl, options)

---
_Source: https://npm.io/package/fssys · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._