Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including websequencediagrams with all npm packages installed. Try it out:

var websequencediagrams = require("websequencediagrams")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

websequencediagrams v1.0.0

Interface to

Call the API.

Command Line

wsd_get [options] [input file...]
Generate a diagram with

-h, --help    Show help
-f, --format  Format for output (one of [png, pdf, svg])  [default: "png"]
-o, --output  Output file (defaults to wsd.[png, pdf, svg])
-s, --style   Output style (one of: [default, earth, modern-blue, mscgen,
              omegapple, qsd, rose, roundgreen, napkin, magazine, vs2010,



var wsd = require('websequencediagrams');
var fs = require('fs');
wsd.diagram("Alice->Bob: message", "modern-blue", "png", function(er, buf, typ) {
    if (er) {
    } else {
        console.log("Received MIME type:", typ);
        fs.writeFile("my.png", buf);

.diagram(text, style, output_type, callback)

Takes the text to turn into a diagram, the style name, the output type, and a callback.

Valid output types include "png", "svg", and "pdf".

The callback takes an error, a Buffer, and a MIME type


.styles is an array of all of the currently-known style types.


.root is the URL for the service, which defaults to "". It can be modified to suit your needs.


This code is licensed under the Apache Software License, 2.0

Build Status Coverage Status

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free