Gathering detailed insights and metrics for fsevents
Gathering detailed insights and metrics for fsevents
Installations
npm install fseventsDeveloper
fsevents
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
^8.16.0 || ^10.6.0 || >=11.0.0
Typescript Support
Yes
Node Version
18.17.1
NPM Version
9.6.7
Statistics
568 Stars
277 Commits
119 Forks
33 Watching
3 Branches
35 Contributors
Updated on 26 Oct 2024
Languages
C (50.64%)
JavaScript (44.83%)
Python (2.81%)
Shell (1.72%)
Total Downloads
Cumulative downloads
Total Downloads
8,672,993,321
Last day
-1.4%
4,516,891
Compared to previous day
Last week
2.2%
23,662,594
Compared to previous week
Last month
5.9%
100,461,534
Compared to previous month
Last year
-15.8%
1,219,069,358
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
1
Versions
fsevents
Native access to MacOS FSEvents in Node.js
The FSEvents API in MacOS allows applications to register for notifications of changes to a given directory tree. It is a very fast and lightweight alternative to kqueue.
This is a low-level library. For a cross-platform file watching module that uses fsevents, check out Chokidar.
Usage
1npm install fsevents
Supports only Node.js v8.16 and higher.
1const fsevents = require('fsevents'); 2 3// To start observation 4const stop = fsevents.watch(__dirname, (path, flags, id) => { 5 const info = fsevents.getInfo(path, flags); 6}); 7 8// To end observation 9stop();
Important note: The API behaviour is slightly different from typical JS APIs. The
stopfunction must be retrieved and stored somewhere, even if you don't plan to stop the watcher. If you forget it, the garbage collector will eventually kick in, the watcher will be unregistered, and your callbacks won't be called anymore.
The callback passed as the second parameter to .watch get's called whenever the operating system detects a
a change in the file system. It takes three arguments:
fsevents.watch(dirname: string, (path: string, flags: number, id: string) => void): () => Promise<undefined>
path: string- the item in the filesystem that have been changedflags: number- a numeric value describing what the change wasid: string- an unique-id identifying this specific event
Returns closer callback which when called returns a Promise resolving when the watcher process has been shut down.
fsevents.getInfo(path: string, flags: number, id: string): FsEventInfo
The getInfo function takes the path, flags and id arguments and converts those parameters into a structure
that is easier to digest to determine what the change was.
The FsEventsInfo has the following shape:
1/** 2 * @typedef {'created'|'modified'|'deleted'|'moved'|'root-changed'|'cloned'|'unknown'} FsEventsEvent 3 * @typedef {'file'|'directory'|'symlink'} FsEventsType 4 */ 5{ 6 "event": "created", // {FsEventsEvent} 7 "path": "file.txt", 8 "type": "file", // {FsEventsType} 9 "changes": { 10 "inode": true, // Had iNode Meta-Information changed 11 "finder": false, // Had Finder Meta-Data changed 12 "access": false, // Had access permissions changed 13 "xattrs": false // Had xAttributes changed 14 }, 15 "flags": 0x100000000 16}
Changelog
- v2.3 supports Apple Silicon ARM CPUs
- v2 supports node 8.16+ and reduces package size massively
- v1.2.8 supports node 6+
- v1.2.7 supports node 4+
Troubleshooting
- I'm getting
EBADPLATFORMUnsupported platform for fseventserror. - It's fine, nothing is broken. fsevents is macos-only. Other platforms are skipped. If you want to hide this warning, report a bug to NPM bugtracker asking them to hide ebadplatform warnings by default.
License
The MIT License Copyright (C) 2010-2020 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller — see LICENSE file.
Visit our GitHub page and NPM Page
Stable Version
The latest stable version of the package.
Stable Version
2.3.3
CRITICAL
1
CRITICAL
9.8/10
Summary
Code injection in fsevents
Affected Versions
<= 1.2.10
Patched Versions
1.2.11
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 7/22 approved changesets -- score normalized to 3
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/nodejs.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/publish.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/nodejs.yml:25
- Warn: npmCommand not pinned by hash: .github/workflows/nodejs.yml:56
- Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:18
- Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 3 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
- Warn: branch protection not enabled for branch 'v1.x'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 17 are checked with a SAST tool
Score
3.7
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More