@intuiface/binding-converter

Binding Converter Schematics

This article describes how to design a binding converter, build it, and generate an IFD for use in Intuiface Composer.

Table of contents

• Prerequisites
• Install
• Usage
• Help

Prerequisites

• NodeJS so you can use NPM to manage your project's dependencies
• Visual Studio Code to code, build, and test your project
• Angular Schematics CLI. Install it using NPM:
  npm install -g @angular-devkit/schematics-cli

Usage

First, inside a new folder, install the binding-converter schematics:

npm install @intuiface/binding-converter

Then initialize your binding converter workspace by using the schematics:

schematics @intuiface/binding-converter:create

It will prompt you for the binding converter name and category, then create all files.

Please use only alphanumeric characters in the name of your binding converter (no "-", no special characters, etc). The schematics will accept it but may fail when you try to build your project.

After installation is complete, restart VSCode if you want the code analyzer running. You can use the command npm run lint if you want to run the code analyzer manually.

You can modify the default name of the converter function computeOutput.

Develop your binding converter using the generated skeleton or read the documentation for Intuiface Core, especially the @Converter and @Parameter decorators.

Then run npm run build to build for production or npm run build:debug to debug your binding converter. You can use the Command Line.

Migrate project (<2.x) to use intuiface-cli

Intuiface CDK v2.0.0 introduce a new command line tool intuiface-cli to better handle building interface assets and binding converters and generating descriptor files. You can migrate your old project to use the new CLI by following the migration guide

Help

Found a problem, a bug? Or need some help? Please do not create an issue in Github! Ask us via our Support page : https://support.intuiface.com/