fswin

v3.24.829
nodejs fs extensions for windows
native fs filesystem watch windows wildcards ntfs

Introduction Build with node-gyp

fswin is a native node.js 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

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 2019 or later.

then you need to install Python

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

npm i fswin

Metadata

  • MIT
  • >= 8.0
  • Xiao Shen
  • released 8/29/2024

Downloads

Maintainers