# file-list-loader

> A file loader that after searched in a path (or paths) recursively, generate an ID for each file based in the name.

Latest version **0.0.1-beta.0** (published 2020-04-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install file-list-loader
pnpm add file-list-loader
yarn add file-list-loader
bun add file-list-loader
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-beta.0 |
| Published | 2020-04-30 |
| First published | 2020-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10.0.0 |
| Dependencies | 0 |
| Unpacked size | 21.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Carlos Juan Craviotto |
| Maintainers | curlirojo |
| Keywords | file, files, files loader, list files, search files, files list loader, typescript, javascript |

## Links

- npm: https://www.npmjs.com/package/file-list-loader
- Repository: https://github.com/CarlosCraviotto/file-list-loader
- Homepage: https://github.com/CarlosCraviotto/file-list-loader#readme
- Issues: https://github.com/CarlosCraviotto/file-list-loader/issues
- npm.io page: https://npm.io/package/file-list-loader

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.0.1-beta.0 (latest) — 2020-04-30
- 0.0.2-beta.0 (beta) — 2020-05-05
- 0.0.1-beta.1 — 2020-05-01

## README

# file-list-loader
A file loader that after searched in a path (or paths) recursively, generate an ID for each file based in the name.


[![Build Status](https://travis-ci.org/CarlosCraviotto/file-list-loader.svg?branch=master)](https://travis-ci.com/github/CarlosCraviotto/file-list-loader)
[![Coverage Status](https://coveralls.io/repos/github/CarlosCraviotto/file-list-loader/badge.svg?branch=master&cach=ff)](https://coveralls.io/github/CarlosCraviotto/file-list-loader?branch=master)


### Installation

Install by `npm`

```sh
npm install --save file-list-loader
```
#### Basic Usage

```
/
└── Users
    └── jsons
        ├── unicorn.json
        └── foo
            └── bar
                ├── baz
                └── one.json
```


```typescript
import {MikroOrmModuleDefiner} from "file-list-loader";

const loader = new FileListLoader({
  extensions: ['json'],
  useFilePathInId: false
});

await loader.addPaths({path: './jsons'});

const oneContent = await loader.getFileContent('one');
const unicornContent = await loader.getFileContent('unicorn');

```


### Commands

 - `npm run build`: Build the project (file list loader).
 - `npm run build:clean`: Delete first the dist folder and build it.
 - `npm run clean`: Delete the dist folder.
 - `npm run test`: Execute the tests.
 - `npm run test:coverage`:  Execute the tests and calculate the coverage.
 - `npm run lint`: Check the code using the rules in .eslintre.js
 - `npm run lint:fix`: Check the code and try to fix it.



### License

MIT

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