# @naweak/n

> Simple WebAPI Framework

Latest version **1.0.0** (published 2019-05-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @naweak/n
pnpm add @naweak/n
yarn add @naweak/n
bun add @naweak/n
```

## 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 | 2019-05-20 |
| First published | 2019-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | naweak |
| Maintainers | naweak |
| Keywords | framework, api, webapi, express |

## Links

- npm: https://www.npmjs.com/package/@naweak/n
- Repository: https://github.com/naweak/n-framework
- Homepage: https://github.com/naweak/n-framework#readme
- Issues: https://github.com/naweak/n-framework/issues
- npm.io page: https://npm.io/package/@naweak/n

## Dependencies (2)

- [express](https://npm.io/package/express.md) ^4.16.4
- [body-parser](https://npm.io/package/body-parser.md) ^1.19.0

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads
- [@modern-js/plugin-swc](https://npm.io/package/@modern-js/plugin-swc.md) — 3.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2019-05-20
- 0.0.4 — 2019-04-30
- 0.0.3 — 2019-04-28
- 0.0.2 — 2019-04-28
- 0.0.1 — 2019-04-28

## README

# n-framework

## Install to your project

```bash
npm i @naweak/n -S
```

## Use in your project

```js
const Framework = require('@naweak/n')
const app = new Framework({
  methodsDir: __dirname + '/src/methods/', // Your API methods dir
  host: '127.0.0.1', // Your project hostname
  port: 3000 // Your project port
})
app.runServer()
```

## Create methods

### Successful response

```js
// src/methods/exampleSuccessMethod.js
// Demonstrates successful response
const Response = require('@naweak/n/lib/response')

module.exports = {
  /**
   * @param {object} params - HTTP request params
   * @param {string} ip - Client IP address
   */
  run(params, ip) {
    return new Response({
      message: 'Hello world!',
      params,
      ip
    })
  }
}
```

```bash
$ curl "http://127.0.0.1:3000/api/?method=exampleSuccessMethod&test=123"
```

```json
{
  "success": {
    "message": "Hello world!",
    "params": {
      "method": "exampleSuccessMethod",
      "test": "123"
    },
    "ip": "127.0.0.1"
  }
}
```

### Error response

```js
// src/methods/exampleErrorMethod.js
// Demonstrates error response
const ErrorResponse = require('@naweak/n/lib/error')

module.exports = {
  run() {
    return new ErrorResponse(
      'Failed', // Error data
      11 // Error code
    )
  }
}
```

```bash
$ curl "http://127.0.0.1:3000/api/?method=exampleErrorMethod"
```

```json
{
  "error": {
    "data": "Failed",
    "code": 11
  }
}
```

## Custom routes

```js
// You can use express middlewares
app.app.use('/', (req, res) => {
  res.send('Hello world!')
})
```

```bash
$ curl "http://127.0.0.1:3000/"
Hello world!
```

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