# esi-server

> Edge Side Includes (ESI) fragments server

Latest version **3.0.0** (published 2018-03-21) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install esi-server
pnpm add esi-server
yarn add esi-server
bun add esi-server
```

## 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 | 3.0.0 |
| Published | 2018-03-21 |
| First published | 2017-12-17 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Patrick Poulain |
| Maintainers | petitchevalroux |

## Links

- npm: https://www.npmjs.com/package/esi-server
- Repository: https://github.com/petitchevalroux/node-esi-server
- Homepage: https://github.com/petitchevalroux/node-esi-server#readme
- Issues: https://github.com/petitchevalroux/node-esi-server/issues
- npm.io page: https://npm.io/package/esi-server

## Dependencies (2)

- [koa](https://npm.io/package/koa.md) ^2.4.1
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.1

## Recent versions

- 3.0.0 (latest) — 2018-03-21
- 2.0.0 — 2017-12-28
- 1.0.0 — 2017-12-17

## README

# node-esi-server
Edge Side Includes (ESI) html fragment http server

This node server aims at rendering templates with provided data using a template provider and a data provider.

Supported template providers:

 * [nunjucks](https://github.com/petitchevalroux/node-esi-server-template-nunjucks)

Supported data providers:

 * [koa-router](https://github.com/petitchevalroux/node-esi-server-data-koa-router)

## Install
```
npm install --save esi-server
```

## Usage

### Using the nunjucks template provider and koa-router data provider

```javascript
const TemplateProvider = require("esi-server-template-nunjucks"),
    {Server} = require("esi-server"),
    templateProvider = new TemplateProvider(),
    DataProvider = require("esi-server-data-koa-router")
    dataProvider = new DataProvider(),
    router = dataProvider.getRouter();
router.get("/articles/:id", ctx => {
    return new Promise(resolve => {
        resolve(Object.assign(
            {
                title: "My article",
                body: "My body"
            },
            {id: ctx.params.id}
        ));
    });
});
app = new Server({
    templateProvider: templateProvider,
    dataProvider: dataProvider
});
// Listen request from port 3000 TCP port
app.listen(3000);
```

## Sample queries
Each query must have a JSON string object with two properties :

 * **data** property is used as arguments of data provider get function
 * **tpl** property is used as arguments of template provider get function

```
GET /fragment?{"data":["/articles/1"],"tpl":["article.html",{"titleTag":"h1"}]}
```

```
GET /fragment?{"data":["/articles",{"order":"publishedAt","limit":10}],"tpl":["articles.html",{"title":"Last published articles"}]}
```

```
GET /fragment?{"tpl":["header.html",{"title":"Last published articles"}]}
```

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