# @bladedancer/api-builder-plugin-gm-mustache

> Node for templating using mustache

Latest version **1.0.0** (published 2018-10-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @bladedancer/api-builder-plugin-gm-mustache
pnpm add @bladedancer/api-builder-plugin-gm-mustache
yarn add @bladedancer/api-builder-plugin-gm-mustache
bun add @bladedancer/api-builder-plugin-gm-mustache
```

## 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-10-19 |
| First published | 2018-10-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 8.9 |
| Dependencies | 2 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | bladedancer |
| Keywords | amplify, api-builder, flow, sdk |

## Links

- npm: https://www.npmjs.com/package/@bladedancer/api-builder-plugin-gm-mustache
- npm.io page: https://npm.io/package/@bladedancer/api-builder-plugin-gm-mustache

## Dependencies (2)

- [mustache](https://npm.io/package/mustache.md) ^2.3.0
- [axway-flow-sdk](https://npm.io/package/axway-flow-sdk.md) ^2.0.0

## Recent versions

- 1.0.0 (latest) — 2018-10-19

## README

# api-builder-plugin-gm-mustache

## About

This module installs the [Mustache](http://mustache.github.io) flow-node to be used within [Axway API Builder's](https://www.axway.com/en/datasheet/axway-api-builder)
flow editor.

The Mustache flow-node allows the evaluation of [Mustache](http://mustache.github.io) templates using values from the flow.

### Format string
The _Format string_ method evaluates the template given with the data supplied. This allows complex values to be constructed from values that exist in the flow's context.

| Param | Type | Required | Description |
| --- | --- | --- | --- |
| data | object | y | The data to evaluate the template with. Use $ to access the entire context. |
| template | string | y | The template being evaluated. |

### Format object
The _Format object_ method is similar to the _Format string_ method. It evaluates the template given with the data supplied. However the resulting string value is then JSON parsed. This allows the creation of JavaScript values and objects from the evaluated template.

| Param | Type | Required | Description |
| --- | --- | --- | --- |
| data | object | y | The data to evaluate the template with. Use $ to access the entire context. |
| template | string | y | The doT template being evaluated. |

### Mustache Templates
The Javascript implementation of Mustache being used is https://github.com/janl/mustache.js.


#### Example
In the examples the Flow is going to be attached to an API that has three parameters, firstname, lastname and gender.

##### Basic interpolation {{ }}
The template can be used to quickly concatenate values.

| | |
| - | - |
| Request | <http://localhost:8080/api/example?firstname=Clark&lastname=Kent&gender=m> |
| _data_ | $.params |
| _template_ | {{firstname}} {{lastname}} |
| Output | Clark Kent |


##### Conditionals {{^value}}{{/value}}
The template evaluation supports boolean checkes to tailor the output based on the input.

| | |
| - | - |
| Request | <http://localhost:8080/api/example?firstname=Clark&lastname=Kent&male=true> |
| _data_ | $ |
| _template_ | Hello {{#male}}Mr{{/male}}{{^male}}Ms{{/male}} {{surname}} |
| Output | Hello Mr Kent |

| | |
| - | - |
| Request | <http://localhost:8080/api/example?firstname=Lois&lastname=Lane> |
| _data_ | $.params |
| _template_ | Hello {{#male}}Mr{{/male}}{{^male}}Ms{{/male}} {{surname}} |
| Output | Hello Ms Lane |


##### Array Iteration {{# }}
The template engine can also iterate over arrays, creating content for each element in the array.


| | |
| - | - |
| Request | <http://localhost:8080/api/example?names=Tom,Dick,Harry> |
| _data_ | $.params |
| _template_ | {{#names}}{{.}} {{/names}} |
| Output | Tom Dick Harry  |


## Getting started

1.  Go to [platform.axway.com](https://platform.axway.com) and create an account
1.  Install [API Builder](https://docs.axway.com/bundle/API_Builder_allOS_en/page/api_builder.html)
1.  Follow the [Getting Started Guide](https://docs.axway.com/bundle/API_Builder_allOS_en/page/api_builder_getting_started_guide.html)

## Install

After creating your API Builder project (`appc new -t arrow`), you can install this flow-node handler
using npm:

```
npm install --save api-builder-plugin-gm-mustache
```

The "Mustache" flow-node will then be available in the tools panel when creating or editing Flows.

---
_Source: https://npm.io/package/@bladedancer/api-builder-plugin-gm-mustache · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._