Code Monkey home page Code Monkey logo

bpmn-io-callbacks-to-promises's Introduction

Moving from Callbacks to Promises

Starting with diagram-js@7, bpmn-js@7, and dmn-js@11, using promises is the preferred way of using these libraries. Callbacks are deprecated and will likely be removed in future releases.

Switching from callbacks to promises is easy, as you'll see in this example. Even if your browser doesn't support promises, you can still polyfill them.

Following APIs return a Promise:

bpmn-js

importXML

Before

const modeler = new BpmnJS();

modeler.importXML(xml, (err, warnings) => {
  // ...
});

After

const modeler = new BpmnJS();

try {
  const result = await modeler.importXML(xml);
  const { warnings } = result;
  console.log(warnings);
} catch (err) {
  console.log(err.message, err.warnings);
}

importDefinitions

Before

const modeler = new BpmnJS();

modeler.importDefinitions(definitions, (err, warnings) => {
  // ...
});

After

const modeler = new BpmnJS();

try {
  const result = await modeler.importDefinitions(definitions);
  const { warnings } = result;
  console.log(warnings);
} catch (err) {
  console.log(err.message, err.warnings);
}

open

Before

const modeler = new BpmnJS();

modeler.open(bpmnDiagram, (err, warnings) => {
  // ...
});

After

const modeler = new BpmnJS();

try {
  const result = await modeler.open(bpmnDiagram);
  const { warnings } = result;
  console.log(warnings);
} catch (err) {
  console.log(err.message, err.warnings);
}

saveXML

Before

const modeler = new BpmnJS();

modeler.saveXML(options, (err, xml) => {
  // ...
});

After

const modeler = new BpmnJS();

try {
  const result = await modeler.saveXML(options);
  const { xml } = result;
  console.log(xml);
} catch (err) {
  console.log(err);
}

saveSVG

Before

const modeler = new BpmnJS();

modeler.saveSVG(options, (err, svgString) => {
  // ...
});

After

const modeler = new BpmnJS();

try {
  const result = await modeler.saveSVG(options);
  const { svg } = result;
  console.log(svg);
} catch (err) {
  console.log(err);
}

createDiagram

Before

const modeler = new BpmnJS();

modeler.createDiagram((err, warnings) => {
  // ...
});

After

const modeler = new BpmnJS();

try {
  const result = await modeler.createDiagram();
  const { warnings } = result;
  console.log(warnings);
} catch (err) {
  console.log(err.message, err.warnings);
}

dmn-js

importXML

Before

const modeler = new DmnJS();

modeler.importXML(xml, (err, warnings) => {
  // ...
});

After

const modeler = new DmnJS();

try {
  { warnings } = await modeler.importXML(xml);
  console.log(warnings);
} catch (err) {
  console.log(err.message, err.warnings);
}

open

Before

const modeler = new DmnJS();

modeler.importXML(xml, (importErr, importWarnings) => {

  modeler.open(modeler.getViews()[0], (err, warnings) => {
    // ...
  });

});

After

const modeler = new DmnJS();

try {
  await modeler.importXML(xml);
  const { warnings } = await modeler.open(modeler.getViews()[0]);
  console.log(warnings);
} catch (err) {
  console.log(err);
}

saveXML

Before

const modeler = new DmnJS();

modeler.importXML(dmnXml, (importErr, importWarnings) => {

  modeler.saveXML(options, (err, xml) => {
    // ...
  });

}

After

const modeler = new DmnJS();

try {
  await modeler.importXML(dmnXml);
  const { xml } = await modeler.saveXML(options);
  console.log(xml);
} catch (err) {
  console.log(err);
}

saveSVG

Before

const modeler = new DmnJS();

modeler.importXML(xml, (importErr, importWarnings) => {

  modeler.saveSVG(options, (err, svgString) => {
    // ...
  });

}

After

const modeler = new BpmnJS();

try {
  await modeler.importXML(xml);
  const { svg } = await modeler.saveSVG(options);
  console.log(svg);
} catch (err) {
  console.log(err);
}

License

MIT

bpmn-io-callbacks-to-promises's People

Contributors

maxtru avatar oguzeroglu avatar philippfromme avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

geogerytony

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.