Node's Pocket Monsters

    wirebird-client
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.4 • Public • Published

    Wirebird Client

    Client library for Wirebird http inspection tool.

    Installation

    npm install -D wirebird-client

    or:

    yarn add -D wirebird-client

    Usage

    With Wirebird

    First, install and run Wirebird on your machine.

    Default:

    NODE_OPTIONS="-r wirebird-client/inject" \
        WIREBIRD=ui \
        node my-script.js

    Using wbenv command:

    wbenv ui node my-script.js

    Specify Wirebird host and port manually:

    NODE_OPTIONS="-r wirebird-client/inject" \
        WIREBIRD=ui:http://<wirebird-host>:<wirebird-port> \
        node my-script.js

    Using wbenv command:

    wbenv -h http://<wirebird-host>:<wirebird-port> ui node my-script.js

    Without Wirebird

    Log HTTP requests to the terminal:

    NODE_OPTIONS="-r wirebird-client/inject" \
        WIREBIRD=pretty \
        node my-script.js

    Using wbenv command:

    wbenv pretty node my-script.js

    Log HTTP requests to the terminal as curl commands:

    NODE_OPTIONS="-r wirebird-client/inject" \
        WIREBIRD=curl \
        node my-script.js

    Using wbenv command:

    wbenv curl node my-script.js

    Wbenv command reference

    wbenv (Wirebird environment) command is a shell wrapper that is included with wirebird-client package, allowing to run a Node.js script with WIREBIRD and NODE_OPTIONS variables set.

    Syntax:

    wbenv [-h wirebird_host] {ui|curl|pretty} <command>

    Examples:

    wbenv ui npm start                  #runs `npm start` logging HTTP requests with Wirebird
    wbenv ui yarn add -D @types/react   #runs `yarn add -D @types/react` logging HTTP requests with Wirebird (cool, eh?)
    wbenv -h http://192.168.88.1:4380 ui node app.js
                                        #runs `node app.js` logging HTTP requests with Wirebird running on http://192.168.88.1:4380
    wbenv curl zapier push              #runs `zapier push` logging HTTP requests to terminal as Curl commands

    Install

    npm i wirebird-client

    DownloadsWeekly Downloads

    150

    Version

    0.2.4

    License

    WTFPL

    Unpacked Size

    99.1 kB

    Total Files

    61

    Last publish

    Collaborators

    • corporateanon