base-sdk~ BaseSdk

The base class provides common functionality for both KrokiSdk and PlantUmlSdk subclasses

Constructor

new BaseSdk(baseURL)

Parameters:
NameTypeDescription
baseURLstring

The baseurl of the service

Members

supportedTypes :Array.<string>

Supported graph types

Type:
  • Array.<string>

Methods

fileCheck(file)

Check if file exists

Parameters:
NameTypeDescription
filestring

The path to a file

(abstract) request(file, type)

Creates the http request that renders a graph to image Should be implemented by subclasses

Parameters:
NameTypeDescription
filestring

The path to a file

typestring

Graph type

(async) toPng(param0) → {Promise.<string>}

Renders a graph to png image

Parameters:
NameTypeDescription
param0Graph

The graph to render as png

Returns:

The path to the image created

Type: 
Promise.<string>