ma

macos-alias

Mac OS aliases creation and reading from node.js

Showing:

Popularity

Downloads/wk

16.3K

GitHub Stars

11

Maintenance

Last Commit

5yrs ago

Contributors

3

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

node-alias

Mac OS aliases creation and reading from node.js

Attention

This library does currently not handle the book\0\0\0\0mark\0\0\0\0-header. It only does manipulation on the raw alias data.

I intend to add something like alias.write(buf, path) and alias.read(path).

Installation

npm install macos-alias

Usage

var alias = require('macos-alias');

API

alias.create(target)

Create a new alias pointing to target, returns a buffer.

(This function performs blocking fs interaction)

alias.decode(buf)

Decodes buffer buf and returns an object with info about the alias.

alias.encode(info)

Encodes the info-object into an alias, returns a buffer.

alias.isAlias(path)

Check if the file at path is an alias, returns a boolean.

(This function performs blocking fs interaction)

Hacking

Clone the repo and start making changes, run node-gyp to build the project.

node-gyp rebuild

Tests

mocha

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100