https://github.com/nodesource/ah-fs
Tracks async hook events related to file system operations.
https://github.com/nodesource/ah-fs
Last synced: 8 months ago
JSON representation
Tracks async hook events related to file system operations.
- Host: GitHub
- URL: https://github.com/nodesource/ah-fs
- Owner: nodesource
- License: mit
- Archived: true
- Created: 2017-01-23T17:50:25.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-26T15:57:54.000Z (about 8 years ago)
- Last Synced: 2025-04-29T14:09:41.621Z (9 months ago)
- Language: JavaScript
- Homepage: https://nodesource.github.io/ah-fs
- Size: 1.16 MB
- Stars: 6
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ah-fs [](http://travis-ci.org/nodesource/ah-fs)
Tracks async hook events related to file system operations.
## Installation
npm install ah-fs
## [API](https://nodesource.github.io/ah-fs)
### FileSystemActivityCollector
Instantiates a FileSystemActivityCollector.
Extends [ActivityCollector](https://github.com/nodesource/ah-collector) and thus
exposes the same [public
API](https://github.com/nodesource/ah-collector#api) with added
functionality.
**Parameters**
- `$0.start` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** the start time of the process, i.e. the result of `process.hrtime()`
- `$0.stackCapturer` **StackCapturer?** [see ah-stack-capturer](https://github.com/nodesource/ah-stack-capturer) which
configures how and when stacks traces are captured and processed.By default a StackCapturer is used that captures stacks for all events for
file system related types: `FSREQWRAP`, `FSREQUESTWRAP` (optional, default `StackCapturer`)
- `$0.bufferLength` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** determines how many elements of Buffers are
captured. By default not Buffer data is captured. (optional, default `0`)
- `$0.stringLength` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** determines how much of each string is
captured. By default no string data is captured. (optional, default `0`)
- `$0.captureArguments` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` arguments of callbacks
are captured when they are processed. (optional, default `false`)
- `$0.captureSource` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` the source code of callbacks
is captured when they are processed. (optional, default `false`)
### fileSystemActivityCollector.fileSystemActivities
Getter that returns all activities related to file system operations.
Returns **[Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** fileSystemActivities
### fileSystemActivityCollector.cleanAllResources
Cleans up all captured resources which means that they are processed,
meaningful data extracted and the reference to the actual resource removed
so it can be GCed.
Resources are cleaned during `after` and `destroy` events, therefore
calling this function only affects those resources for which none of these
events have fired yet.
Returns **[FileSystemActivityCollector](#filesystemactivitycollector)** fileSystemActivityCollector
### fileSystemActivityCollector.stringifyBuffers
Finds all buffers that are part of the resources, including arguments
passed to callbacks and stringifies their value for the supplied
encodings.
**Parameters**
- `encodings` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>?** specified for which encodings to create
strings. In order to creates strings for all encodings, pass
[stringify-buffer.encodings](https://github.com/nodesource/stringify-buffer#stringifybufferencodings) (optional, default `'utf8','hex'`)
Returns **[FileSystemActivityCollector](#filesystemactivitycollector)** fileSystemActivityCollector
## License
MIT