https://github.com/foresthoffman/bfs

A JS package for the asynchronous reading and requiring of JavaScript modules without touching the host file system.
https://github.com/foresthoffman/bfs

buffers javascript nodejs npm-package tar typescript

Last synced: 19 days ago
JSON representation

A JS package for the asynchronous reading and requiring of JavaScript modules without touching the host file system.

• Host: GitHub
• URL: https://github.com/foresthoffman/bfs
• Owner: foresthoffman
• License: mit
• Created: 2019-07-13T23:17:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T04:30:13.000Z (about 2 years ago)
• Last Synced: 2024-11-24T00:39:39.591Z (about 2 months ago)
• Topics: buffers, javascript, nodejs, npm-package, tar, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@foresthoffman/bfs
• Size: 684 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📜 Buffered File System (BFS) 📜

[![Node 10.x](https://github.com/foresthoffman/bfs/actions/workflows/node-10.x.js.yml/badge.svg)](https://github.com/foresthoffman/bfs/actions/workflows/node-10.x.js.yml) [![Node 12.x](https://github.com/foresthoffman/bfs/actions/workflows/node-12.x.js.yml/badge.svg)](https://github.com/foresthoffman/bfs/actions/workflows/node-12.x.js.yml) [![Node 14.x](https://github.com/foresthoffman/bfs/actions/workflows/node-14.x.js.yml/badge.svg)](https://github.com/foresthoffman/bfs/actions/workflows/node-14.x.js.yml)

This module uses buffers (or Tar streams) to load file systems (FS) into memory. From an FS, files can be read and modules can be required recursively, without touching the host file system.

## NPM

```bash

npm i @foresthoffman/bfs

```

## Yarn

```bash

yarn add @foresthoffman/bfs

```

## Testing

```

yarn test

```