0.0.2 • Published 6 years ago

@eyedea-sockets/document-generator v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
6 years ago

Syncano Socket for generating documents from mustache templates

Syncano Socket CircleCI branch Codecov branch JavaScript Style Guide npm license

Main Socket features:

  • document-generator/generate — generate document

Getting Started

Install package in your project:

cd my_project
npm install @syncano/cli --save-dev
npm install @eyedea-sockets/document-generator --save
npx s deploy

Use it:

import Syncano from '@syncano/client'

const s = new Syncano(<instaneName>)

const params = {
  template: '<p>Hello, my name is {{firstName}}</p>',
  data: {
    firstName: 'John'
  }
}
const generatedDoc = await s.post('document-generator/generate', params)

Endpoints

document-generator/generate

Input:

ParameterTypeDescriptionExample
templatestringTemplate<p>Hello, my name is {{firstName}}</p>
dataobjectData{firstName: 'John'}

Outputs:

success - Operation Successful

  • Code: 200
  • Mimetype: text/html

fail - Operation failed

  • Code: 400
  • Mimetype: application/json
ParameterTypeDescriptionExample
messagestringInvitation failedInternal error.