Skip to Content
APIchmod

chmod

Change the permissions of a file or directory (mode bits).

Basic usage

import { chmod } from '@rush-fs/core' await chmod('./script.sh', 0o755) await chmod('./file.txt', 0o644)

Methods

chmod(path, mode)

Async. Returns Promise<void>.

ArgumentTypeDescription
pathstringFile or directory path.
modenumberMode (e.g. 0o755, 0o644).

chmodSync(path, mode)

Sync. Same arguments; throws on error.

Performance

Single syscall; on par with Node.js. See Benchmarks.

Notes

  • Windows: Mode has limited meaning on Windows (mainly read-only); same as Node.js.
Last updated on