Add fs.statvfs function to get disk size/free/available space + other info

[miniak]

There is no build in way to get disk space information. There are a few npm modules available:

• https://www.npmjs.com/package/diskusage (has 8 dependencies, including FFI, which is quite ridiculous, proposed reimplementation in C++: Re-implement in C++ with just NaN dependency jduncanator/node-diskusage#14)
• https://www.npmjs.com/package/diskspace (depends on an EXE file on Windows)

This is such a basic API that should be built-in.

[mscdex]

libuv would need to add such support first, then node would add an API that uses that libuv API.

[cjihrig]

From what I can tell, the modules you linked to only provide a subset of what statvfs(). libuv would also require a Windows implementation. It looks like Python rejected a Windows implementation a while back (not sure if that has since changed).

cc: @saghul

[ronkorving]

@miniak I use https://www.npmjs.com/package/storage-device-info, which only depends on NAN. Regardless though, it would be nice to have this built-in.

[saghul]

I'm not opposed to it, proven that there is a reasonable implementation for all our supported platforms.

…

On Wed, Jan 11, 2017 at 10:11 PM, Colin Ihrig ***@***.***> wrote: From what I can tell, the modules you linked to only provide a subset of what statvfs(). libuv would also require a Windows implementation. It looks like Python rejected a Windows implementation a while back (not sure if that has since changed). cc: @saghul <https://github.com/saghul> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#10745 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AATYGKUndJ91Q_f6zCFglPz2ht1KbyI3ks5rRafbgaJpZM4Lg_h1> .

-- /Saúl bettercallsaghul.com

[Trott]

Given that this issue has been inactive for several months, is it sensible close this (or at least mark is at blocked) unless and until the necessary features are added to libuv?

[ronkorving]

I think this is still valid, regardless of people having have spent time on it.

[gengjiawen]

https://github.com/jduncanator/node-diskusage now implements in C++, it also have a Windows implementation.

[refack]

Put into https://github.com/nodejs/node/projects/13 backlog

[tomasdev]

So is this happening or not? I see it on the project dashboard but it's now closed?

[sagitsofan]

@refack
Does integration of this package https://github.com/jduncanator/node-diskusage as another deps and expose an api statvfs will be a good solution for this use case?

[sam-github]

@sagitsofan should be opened in libuv/libuv as a feature request, if it can be implemented portably in libuv, then node could expose it.

[sagitsofan]

@sam-github But if we can integrated directly inside node the node-diskusage package we wont be dependent on libuv

[sam-github]

@sagitsofan But we like to depend on uv! Its not a burden, its our compat layer.

[cjihrig]

If anyone really wants to see this in Node, I'd recommend opening an issue on the libuv issue tracker. The feature request should describe what the API would look like, taking a Windows implementation into consideration. This python issue is old, but might still be relevant.

[sagitsofan]

So after this feature has been added into libuv core, when will it be available inside node js project?
I would like to create the wrapper in node.

[cjihrig]

I'm planning a libuv release for this week. I'll also have to expose the API in Node. It should be available in the next one or two Node 12.x releases.

[sagitsofan]

I would be happy to expose the API in node after the libuv release.

[cjihrig]

@sagitsofan were you volunteering to write the fs code to expose uv_fs_statfs()? If you were volunteering, the libuv update has landed in Node.

[sagitsofan]

Sure, i am on it.

[nahuel]

please reopen this issue, is not resolved yet.

[EagleLizard]

Is there any ETA for this? Stats does not show the size on disk, which is an issue because it reports file sizes of <20B on disks, when the actual minimum block size for files on a given disk may be ~4096B, so disk calcs end up with significant mismatches

[koplenov]

https://nodejs.org/api/fs.html#fspromisesstatfspath-options

usefull

[koplenov]

For example, let's find out the free disk space as a percentage:

/*
	https://nodejs.org/api/fs.html#fspromisesstatfspath-options
*/

const fsp = require("node:fs/promises");

(async function (){
	const { bfree, blocks } = await fsp.statfs(__dirname)
	const persent = bfree/blocks*100
	console.log({persent})
})()

[RedYetiDev]

This issue can been closed for years. If you're experiencing an issue, please open a new issue in nodejs/help.