Captum Liquid

Extension of the LiquidJS project with additional functions specifically for use with Captum templates.

Usage

const CaptumLiquid = require('captum-liquid').Liquid;
// or
import Liquid from 'captum-liquid';

After that, everything is the same as the base LiquidJS project.

Additional Functions

json

This will output the field as pretty printed JSON, indented by 2 spaces.

Usage:

<pre>{{ data | json }}</pre>

jsonCompact

This will output the field as pretty printed JSON but also compact for some cases, see json-stringify-pretty-compact

Usage:

<pre>{{ data | jsonCompact }}</pre>

markdown

This will output the field parsed by Markdown.

Example Data:

{
  "content": "# Getting Started\n\nHere is a quick guide"
}

Usage:

{{ content | markdown }}

jsonPropertiesExample

This will take an object of JSON Schema properties and output them as a JSON formatted string example.

Example Data:

{
  id: {
    type:        'number',
    description: 'Identifier',
    example:     1234,
    minimum:     1
  },
  created_on: {
    type:        'string',
    description: 'Date of creation',
    readOnly:    true,
    example:     '2019-05-23T03:52:04.000Z'
  }
}

Usage:

{{ content | jsonPropertiesExample }}

exampleUri

This will take a URI string and format it with values from the schema given to it. See the test folder of this project for a full example.

Usage:

{{ href | exampleUri: object_schema, 'api.example.com' }}

bashExample

Given a endpoint Link object, and also supplying the entire Object schema as well, this will return a cURL example for the request. See the test folder of this project for a full example.

Usage:

{{ object_link | bashExample: object_schema }}

httpResponseCode

Pipe a numeric HTTP Response Code to this filter to get the code along with the reason, ie: 201 Created

Usage:

{{ http_code | httpResponseCode }}

restMethodResponse

Given a standard HTTP Method, this filter will return what should be the standard HTTP Response code and reason. Ie: POST would return 201 Created. This is subjective to everyone's interpretation of REST methods however and it may be preferable to use httpResponseCode if this doesn't suit you.

Usage:

{{ http_method | restMethodResponse }}

Compiling

yarn install
npm run build
npm run test