Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parkertomatoes/fatfs-wasm
FAT16/32 driver for Typescript/Javascript built on FatFs by CHaN
https://github.com/parkertomatoes/fatfs-wasm
Last synced: 19 days ago
JSON representation
FAT16/32 driver for Typescript/Javascript built on FatFs by CHaN
- Host: GitHub
- URL: https://github.com/parkertomatoes/fatfs-wasm
- Owner: parkertomatoes
- License: other
- Created: 2023-12-03T13:13:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-14T18:39:37.000Z (28 days ago)
- Last Synced: 2024-12-14T19:32:46.065Z (28 days ago)
- Language: C
- Homepage:
- Size: 1010 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# FatFs-Wasm
FatFs is a generic FAT/exFAT filesystem module for small embedded systems, authored by CHaN. FatFs-Wasm is a library which uses a WebAssembly build of FatFs to manipulate FAT image files from node or the browser.
Features:
* Read, write, rename, stat, chmod, and delete files
* Create, iterate, rename, and delete directories
* Supports FAT12, FAT16, and FAT32
Limitations:
* ExFat is not enabled in this build
* LFN is not enabled in this build
* Async drivers not supported
## Getting Started
FatFs-Wasm can be used from Node.js or the browser
,
In the browser, include `fatfs-wasm.js`, which makes `fatfs-wasm` available in the window namespace:
```html
const { FatFsDisk } = window['fatfs-wasm']
// ...
```
Using npm
```
npm install --save fatfs-wasm
```
Then in Javascript
```typescript
const { FatFsDisk } = require('fatfs-wasm')
```
## Using
FatFs can be used with typed arrays to create disk images:
```typescript
const data = new Uint8Array(1 << 23);
const disk = FatFsDisk.create(data);
disk.mkfs(); // Format filesystem
disk.mount(); // Mount workspace
```
Or open existing ones:
```typescript
const response = await fetch('disk.img');
const data = new Uint8Array(response.arrayBuffer());
const disk = FatFsDisk.create(data);
disk.mount(); // Mount workspace
```
Once a workspace is mounted, the library provides APIs for manipulating files:
```typescript
const file = disk.open('file.txt', FatFsMode.READ);
const buffer = new Uint8Array(1024);
file.read(buffer);
file.close();
// Or, for convenience:
const file = disk.readFile('file.txt');
```
As well as iterating directories
```typescript
const dir = disk.open('folder');
for (const file of dir) {
// ...
}
dir.close();
```
See the API documentation for details
## API Documentation
[API Documentation](./docs/modules.md)
## Modifying FatFs C Code
FatFs has many feature gates defined using the preprocessor. See `native/ff15/source/ffconf.h` to make adjustments. Please note that any changes to the C code must be reflected in the `src/fatfs.ts`` wrapper, which is not automatically generated. Make changes at your own risk!
To build, open a terminal in MacOS, Linux, or WSL with clang installed and run the build script:
```
cd native
./build.sh
```
This will build `ff_single.wasm` and `ff_multi.wasm` (multi-partition support) and copy it to the `src` directory.
## Running Tests
```
npx vitest
```