# fswin

> nodejs fs extensions for windows

Latest version **3.25.1108** (published 2025-11-09) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 3.25.1108 |
| Published | 2025-11-09 |
| First published | 2012-12-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 8.0 |
| Dependencies | 0 |
| Unpacked size | 519 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 72 |
| Author | Xiao Shen |
| Maintainers | xxoo |
| Keywords | native, fs, filesystem, watch, windows, wildcards, ntfs |

## Links

- npm: https://www.npmjs.com/package/fswin
- Repository: https://github.com/xxoo/node-fswin
- Homepage: https://github.com/xxoo/node-fswin#readme
- Issues: https://github.com/xxoo/node-fswin/issues
- npm.io page: https://npm.io/package/fswin

## 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

- 3.25.1108 (latest) — 2025-11-09
- 3.24.829 — 2024-08-29
- 3.24.524 — 2024-05-24
- 3.23.311 — 2023-03-10
- 3.23.119 — 2023-02-02
- 3.22.106 — 2022-02-06
- 3.21.1015 — 2021-10-14
- 3.21.1014 — 2021-10-12
- 3.21.1013 — 2021-10-12
- 3.21.1012 — 2021-10-12
- 3.21.1008 — 2021-10-07
- 3.21.1007 — 2021-10-07
- 3.21.929 — 2021-09-29
- 3.21.914 — 2021-09-13
- 3.21.913 — 2021-09-12
- … 29 more at https://npm.io/package/fswin/versions

## README

# Introduction [![Build with node-gyp](https://github.com/xxoo/node-fswin/actions/workflows/main.yml/badge.svg)](https://github.com/xxoo/node-fswin/actions/workflows/main.yml)

[`fswin`](https://www.github.com/xxoo/node-fswin) is a native [`node.js`](http://nodejs.org) add-on that works on windows.
It has ported some platform specified filesystem APIs. And made them easy to use in javascript.

For api documents and examples please see [wiki](https://github.com/xxoo/node-fswin/wiki)

NOTE: fswin depends on n-api since v3. which requires node.js v8 or later.

## How to Install

You may install fswin by using the following command line:

```
npm install fswin
```

The package contains prebuilt binaries for `node.js`, `electron` and `nw.js` on all architectures.

## How to Build

first you need to install [Visual Studio](http://www.visualstudio.com) 2019 or later.

then you need to install [Python](https://www.python.org/downloads/windows)

then you need to install node-gyp

```
npm -g install node-gyp
```

then you need to clone the repo

```
git clone https://github.com/xxoo/node-fswin.git
cd node-fswin
```

finally you can build the source

for `node.js`:

```
node-gyp rebuild
```

for `electron`:

```
node-gyp rebuild --target=x.x.x --dist-url=https://atom.io/download/electron
```

for `nw.js` please follow the [official document](https://nwjs.readthedocs.io/en/latest/For%20Users/Advanced/Use%20Native%20Node%20Modules/)

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