# @rimaulana/asustor-node

> node module to get information on ASUSTOR NAS storage

Latest version **1.0.0** (published 2018-04-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @rimaulana/asustor-node
pnpm add @rimaulana/asustor-node
yarn add @rimaulana/asustor-node
bun add @rimaulana/asustor-node
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-04-27 |
| First published | 2017-11-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.10.0 |
| Dependencies | 0 |
| Unpacked size | 30.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Rio Maulana |
| Maintainers | rimaulana |
| Keywords | asustor, nas |

## Links

- npm: https://www.npmjs.com/package/@rimaulana/asustor-node
- Repository: https://github.com/rimaulana/asustor-node
- Homepage: https://github.com/rimaulana/asustor-node#readme
- Issues: https://github.com/rimaulana/asustor-node/issues
- npm.io page: https://npm.io/package/@rimaulana/asustor-node

## Recent versions

- 1.0.0 (latest) — 2018-04-27
- 0.1.5 — 2017-12-17
- 0.1.4 — 2017-11-09
- 0.1.3 — 2017-11-08
- 0.1.2 — 2017-11-07
- 0.1.0 — 2017-11-07

## README

# ASUSTOR Node

![DefinitelyTyped](https://img.shields.io/badge/DefinitelyTyped-.d.ts-blue.svg) [![CircleCI](https://img.shields.io/circleci/project/github/rimaulana/asustor-node.svg)](https://circleci.com/gh/rimaulana/asustor-node/tree/master) [![codecov](https://codecov.io/gh/rimaulana/asustor-node/branch/master/graph/badge.svg)](https://codecov.io/gh/rimaulana/asustor-node) [![codebeat badge](https://codebeat.co/badges/3f55e8bc-c264-434c-abd2-02473421cb65)](https://codebeat.co/projects/github-com-rimaulana-asustor-node-master) [![Maintainability](https://api.codeclimate.com/v1/badges/33cf960c68a9a198b820/maintainability)](https://codeclimate.com/github/rimaulana/asustor-node/maintainability) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

A node module to get files and removable storage information from ASUSTOR NAS running on Ubuntu OS

## Installation

```bash
npm install @rimaulana/asustor-node
```

## Example

Getting attached USB drives information :

```javascript
var asustor = require("@rimaulana/asustor-node");

// Asynchronous
asustor.usbInfo(function(error, data) {
    if (error) {
        console.log(error);
    } else {
        console.log(data);
    }
});

// Synchronous
console.log(asustor.usbInfoSync());
```

Getting File information :

```javascript
var asustor = require("@rimaulana/asustor-node");
var file_path = "/home/user/file.mkv";

// Asynchronous
asustor.fileInfo(file_path, function(error, data) {
    if (error) {
        console.log(error);
    } else {
        console.log(data);
    }
});

// Synchronous
console.log(asustor.fileInfoSync(file_path));
```

Getting Folder information :

```javascript
var asustor = require("@rimaulana/asustor-node");
var folder_path = "/home/user";

// Asynchronous
asustor.folderInfo(folder_path, function(error, data) {
    if (error) {
        console.log(error);
    } else {
        console.log(data);
    }
});

// Synchronous
console.log(asustor.folderInfoSync(folder_path));
```

## Tests

```bash
npm test
```

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