Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amaui-org/amaui-node

Nodejs utils
https://github.com/amaui-org/amaui-node

amaui back-end backend javascript js node nodejs typescript utils web

Last synced: about 2 months ago
JSON representation

Nodejs utils

Awesome Lists containing this project

README

        



amaui logo

amaui Node


Node



MIT license    
Production ready    
100% test cov    
Nodejs


Very simple code    
Modern code    
Junior friendly    
Typescript    
Made with :yellow_heart:


## Getting started

### Add

```sh
yarn add @amaui/node
```

### Use

```javascript
import path from 'path';

import AmauiNode from '@amaui/node';

// A file add
await AmauiNode.file.add(path.resolve('a.json'), 'a');

// A file read
await AmauiNode.file.get(path.resolve('a.json'));

// A file remove
await AmauiNode.file.remove(path.resolve('a.json'));
```

### Dev

Install

```sh
yarn
```

Test

```sh
yarn test
```

### Prod

Build

```sh
yarn build
```