# nodable

> A compact, high-performance and full-featured web framework based on nodejs.

Latest version **0.0.3** (published 2023-05-26) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-05-26 |
| First published | 2023-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 24.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ai Chen |
| Maintainers | metadream |
| Keywords | micro-server, http-server, web-server, http-framework, web-framework, template-engine, path-router, restful-api |

## Links

- npm: https://www.npmjs.com/package/nodable
- Repository: https://github.com/metadream/nodable
- Homepage: https://github.com/metadream
- Issues: https://github.com/metadream/nodable/issues
- npm.io page: https://npm.io/package/nodable

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.0.3 (latest) — 2023-05-26
- 0.0.2 — 2023-05-26
- 0.0.1 — 2023-03-07

## README

# Nodable

A compact, high-performance and full-featured web framework based on nodejs. The
features include:

- [x] Application context
- [x] Middlewares like Koa.js
- [x] Built-in static service
- [x] Built-in routing service
- [x] Built-in template engine

## Installation

```
npm i nodable
```

## Get Started

```js
const app = require("nodable");

app
  .serve("/assets/*")
  .engine({
    root: "template",
    imports: { globalName: "" },
  })
  .on("error", (err, ctx) => {
    console.error(err);
    ctx.body = {
      status: ctx.status,
      message: ctx.body,
    };
  })
  .use(async (ctx, next) => {
    ctx.custom = "xxxx";
    await next();
  })
  .get("/", async (ctx) => {
    console.log(ctx.query);
    console.log(ctx.params);
  })
  .listen();
```

## API Reference

### Methods

- `app.serve(path)` Serve static resources with the given `path`. It's the
  syntactic sugar for `get` routing, so the `path` must starts with "/".
- `app.engine(options)` Enable template engine with options `{ root, imports }`.
- `app.on("error", function)` Custom unified error handling.
- `app.use(function)` Add a middleware like koa.js.
- `app.get(path, [tmpl,] function)` Add dynamic route including `post`, `put`,
  `delete` and other standard request methods, it will auto-render template if
  `tmpl` parameter exists.
- `app.listen([port])` Create and start an application server on the specified
  port.
- `app.callback()` Return a request handler for node's native http server.

### Context

#### Properties

- `ctx.params` Get params in route path, wildcard supports
- `ctx.query` Get params in query string
- `ctx.method` Get request method
- `ctx.path` Get request path
- `ctx.url` Get request full href
- `ctx.protocol` Get request protocol
- `ctx.host` Get request host
- `ctx.hostname` Get request hostname
- `ctx.origin` Get request origin
- `ctx.headers` Get headers object
- `ctx.cookies` Get cookies object
- `ctx.status` Get response status code
- `ctx.body` Get response body
- `ctx.request` Get native request
- `ctx.response` Get native response
- `ctx.status=` Set response status code
- `ctx.body=` Set response body

#### Methods

- `ctx.get(name)` Get request headers by name
- `ctx.set(name, value)` Set response headers
- `ctx.cookie(name, value[, options])` Set cookies
- `async ctx.json()` Get request body in json
- `async ctx.text()` Get request body in text
- `async ctx.buffer()` Get request body in buffer
- `ctx.redirect(url[, status])` Redirect url with status default 301
- `ctx.view(path, data)` Render template file, only if engine enabled.
- `ctx.render(path, data)` Render template text, only if engine enabled.
- `ctx.throw(message, status)` Throw an error with status code

### Route Syntax

- `/static` static route
- `/*` Wildcard route, it will return `wildcard` variable in `ctx.params`
- `/:user`
- `/:user?`
- `/:user(\\d+)`

### Template Syntax

- `{{ }}` Evaluate code snippet in javascript. Note that the variables do not
  need to be declared. ex. `{{ result = 60*60; }}`

- `{{= }}` Interpolation. ex. `{{= username }}`

- `{{? }} {{?? }} {{? }}` Conditional statement. ex.

```
{{? gender == 0 }}
  <div>Female</div>
{{?? gender == 1 }}
  <div>Male</div>
{{?? }}
  <div>Unknown</div>
{{? }}
```

- `{{~ }} {{~ }}` Iterative statement. ex.

```
<ul>
{{~ users:user:index }}
  <li>{{= index+1 }} - {{= user.name }}<li>
{{~ }}
</ul>
```

- `{{> }}` Block placeholder.
- `{{< }}` Block content definition.

```
{{> content }}

{{< content }}
  <h1>Hello.</h1>
{{< }}
```

- `{{@ }}` Partial including in layout mode. You must be rendered by
  `view(file, data)` method.

```
// index.html
{{@ header.html }}

// header.html
<h1>Hello.</h1>
```

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