# fsattr

> manipulate SunOS extended file attributes

Latest version **0.0.2** (published 2012-04-03) · 0 weekly downloads

## Install

```sh
npm install fsattr
pnpm add fsattr
yarn add fsattr
bun add fsattr
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2012-04-03 |
| First published | 2012-04-02 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.6 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Bill Pijewski |
| Maintainers | pijewski |

## Links

- npm: https://www.npmjs.com/package/fsattr
- Repository: https://github.com/pijewski/node-fsattr
- npm.io page: https://npm.io/package/fsattr

## Recent versions

- 0.0.2 (latest) — 2012-04-03
- 0.0.1 — 2012-04-02

## README

node-fsattr - manipulate SunOS extended file attributes
=======================================================

This module allows its callers to create, modify, and delete extended file
attributes on Solaris and Solaris-derived (i.e. illumos) platforms.

Extended attributes are a namespace of arbitrary files stored with each file,
assuming the underlying filesystem supports extended attributes.  ZFS is the
main filesystem used on these platforms and supports extended attributes.


API
===

    fsattr.put(file, attrFile, props, function (err) {
         ....
    });
    
    fsattr.get(file, attrFile, function (err, props) {
        // props is a JSON object
    });
    
    fsattr.del(file, attrfile, function (err) {
         ....
    });

To keep things simple and cut down on complexity, the API accepts a JSON object
per attribute file, stringify()s that JSON object, and writes it into the
attribute file.  Likewise, when getting properties from an attribute file, this
module will JSON.parse() the attribute the file and return that object.  Yes,
other formats will work, but it isn't worth exposing that complexity in this
API.


See also
========

fsattr(5)


Status
======

As of April 2012, this module has been tested and verified to work on SmartOS, a
distribution of illumos.

This module uses the runat(1) command to manipulate extended attributes; future
work could involve a native add-on which uses the openat(2) and related
interfaces.

---
_Source: https://npm.io/package/fsattr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._