Skip to content
This repository has been archived by the owner on Aug 1, 2022. It is now read-only.

Latest commit

 

History

History
82 lines (45 loc) · 1.29 KB

README.md

File metadata and controls

82 lines (45 loc) · 1.29 KB

bfast-ui-angular

Web IDE for angular based bfast-ui project

Development

Clone repository from github then run npm run start from project directory after you install all dependencies npm install.

Make sure you have bfast-tools for development.

Get Started

Install project from npm npm install bfast-ui-ng

Start IDE

Create .js file anywhere and add the following codes

const BFastUiAngular = require("bfast-ui-ng");

new BFastUiAngular().init().then(value => {
    return value.ide.start();
}).then(reason => {
    console.log('start successful');
}).catch(reason => {
    console.log(reason);
})

API Reference

Classes

BFastUiAngular

Main class for initiate IDE instance

Methods

Following are the public methods

init

Initiate a bfast ui angular ide

  • Parameters - null

  • Return

      Promise<{ide: BfastFunctions, port: number}>
    

BfastFunctions

From bfast-functions package to start a bfast functions engine.

Methods

start

Start bfast engine

  • Parameters - null

  • Return

      Promise<Server>
    
      NOTE : Server is node-js Server object
    

stop

Stop bfast engine

  • Parameters - null

  • Return

      Promise<void>