Numerous Panicky Mimes

    sequencediagrams

    0.0.8 • Public • Published

    Warning

    This package uses ES6 generators, so make sure to either use io.js or nodes harmony flags!

    About

    This is a command line tool which uses the API of websequencediagrams in order to create sequence diagrams out of .wsd files.

    Syntax details can be found at https://www.websequencediagrams.com/examples.html Example content of a .wsd file

    title create user
    
    App -> Api: POST /user with email, fpw,
    Api -> Router: route POST /user
    Router -> UserController: create user
    UserController -> UserController: validate request
    
    alt isValid
        UserController -> UserController: new User
        UserController -> Router: next
    else isInvalid
        UserController -> Api: respond with 400 invalid request
        Api -> App: 400 invalid request
    

    Results in

    Run

    Usage: sequencediagrams [options] <file or folder>
        
        Options:
    
        -h, --help          output usage information
        -V, --version       output the version number
        -t, --theme <name>  Choose theme out of 'napkin', 'earth' (Defaults to napkin)
    

    Credits

    Thanks to hildjj's https://github.com/hildjj/node-websequencediagrams project, which already provides an abstraction around the websequencediagram API

    Install

    npm i sequencediagrams

    DownloadsWeekly Downloads

    1

    Version

    0.0.8

    License

    MIT

    Last publish

    Collaborators

    • florianschmidt1994