| Version | Vulnerabilities | License Risk | |||
|---|---|---|---|---|---|
| 0.0.4 | | | 05/2016 |
|
| |
| 0.0.3 | | | 12/2014 | Popular
|
|
|
We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.
Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.
Get started freeThe npm package fobject receives a total of 15,299 downloads a week. As such, we scored fobject popularity level to be Recognized.
Based on project statistics from the GitHub repository for the npm package fobject, we found that it has been starred 2 times.
Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.
This project has seen only 10 or less contributors.
We found a way for you to contribute to the project! Looks like fobject is missing a Code of Conduct.
Further analysis of the maintenance status of fobject based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.
An important project maintenance signal to consider for fobject is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.
In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.
fobject has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.
A simple promise-based wrapper for file operations that treats files as objects.
File = require 'fobject'
configFile = new File('config.json')
configFile.read().done((data) ->
console.log "contents of #{configFile.path}: #{data}"
)
The default fs module has a really ugly interface (including sync and async copies of almost every function) and doesn't make it easy to work with files that may or may not actually be written to the file-system. fobject abstracts out interaction with the file system so if you want to implement caching, or work with files without writing them to the disk, or whatever else you want: you can do so easily.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
path |
String | The path to the file. This will be resolved to an absolute path, so even if you change your cwd you can still access the same file. |
||
options.base |
String |
<optional> |
./ | Used for relative pathing. This will not be resolved to an absolute path. Typically where a glob starts. |
Append data to the file
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
data |
String | Buffer | |||
options.encoding |
String | null |
<optional> |
'utf8' | ignored if data is a buffer |
options.mode |
Number |
<optional> |
438 | default is 0666 in Octal |
options.flag |
String |
<optional> |
'w' |
Get the dirname of the file
Get the extension of a file
Read from the file
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
options.encoding |
String | null |
<optional> |
null | |
options.flag |
String |
<optional> |
'r' |
Rename the file
| Name | Type | Description |
|---|---|---|
newPath |
String | The new path for the file. Will be resolved relative to File.base. |
Return a Stat object for the file
Delete the file
Write data to the file
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
data |
String | Buffer | |||
options.encoding |
String | null |
<optional> |
'utf8' | ignored if data is a buffer |
options.mode |
Number |
<optional> |
438 | default is 0666 in Octal |
options.flag |
String |
<optional> |
'w' |
generated with docme
A simple promise-based wrapper for file operations that treats files as objects. Visit Snyk Advisor to see a full health score report for fobject, including popularity, security, maintenance & community analysis.
The npm package fobject receives a total of 15,299 weekly downloads. As such, fobject popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.
We found indications that fobject is an Inactive project. See the full package health analysis to learn more about the package maintenance status.
The npm package fobject was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.
Minimize your risk by selecting secure & well maintained open source packages
Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files
Easily fix your code by leveraging automatically generated PRs
New vulnerabilities are discovered every day. Get notified if your application is affected