Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/node-core-library > FileSystem > getPosixModeBits

FileSystem.getPosixModeBits() method

Retrieves the permissions (i.e. file mode bits) for a filesystem object. Behind the scenes it uses fs.chmodSync().

Signature:

static getPosixModeBits(path: string): PosixModeBits;

Parameters

ParameterTypeDescription
pathstringThe absolute or relative path to the object that should be updated.

Returns:

PosixModeBits

Remarks

This calls FileSystem.getStatistics() to get the POSIX mode bits. If statistics in addition to the mode bits are needed, it is more efficient to call FileSystem.getStatistics() directly instead.