2.1.0 • Published 1 month ago

js-message v2.1.0

Weekly downloads
902,300
License
MIT
Repository
github
Last release
1 month ago

js-message

Normalized JS & JSON Message and event Protocol for node.js, vanilla.js (plain old javascript), react.js, websockets, rest api's, node-ipc, and any other protocol that might use a js object and or a JSON string.

js-message allows for seamless conversion of JSON messages and events to JS objects for a normalized implementation on the server and in the client without needing to concern yourself with JSON intermediaries and custom parsers.

Things are just easier when you normalize them.

npm js-message info : See npm trends and stats for js-message
js-message npm version supported node version for js-message total npm downloads for js-message monthly npm downloads for js-message npm licence for js-message

npm install --save js-message

RIAEvangelist

GitHub info :
js-message GitHub Release GitHub license js-message license open issues for js-message on GitHub

js-message site

method or keytypemutabledescription
typeStringtruethe type of message
dataObjecttruethe message data or payload
loadfuncfalseload a message from JSON, this will return a message with the type of error if not valid JSON
JSONStringnot by userJSON representation of the message

Creating a Message Object

For the browser you can do either an import with the path to make the first http request for your module, and have it cached for other scripts thereafter OR you can import it with the <script> tag upfront which automatically loads as defer so it doesn't interrupt the parser.

<script type="module" src='/path/to/module/js-message-vanilla.js' />

Both node and the browser now support import statements. If you use relative pathing you can use the same exact code from node in the browser without even transpiling much the less bundling.

    //works for browser natively AND node natively
    import { default as Message } from './node_modules/js-message/Message.js';
    //works for browser transpiled AND node natively
    import { default as Message } from 'js-message';

    var myMessage=new Message;
    myMessage.type='message or event type';
    myMessage.data.something='something';
    myMessage.data.stuff=[1,2,3,4,5]

    console.log(myMessage.JSON);

Creating a Message From JSON

    //works for browser natively AND node natively
    import { default as Message } from './node_modules/js-message/Message.js';
    //works for browser transpiled AND node natively
    import { default as Message } from 'js-message';

    //lets say we have the above example running on
    //a websocket server sending js-messages as JSON
    //
    //and lets say this is the client in the browser
    ws.on(
        'message',
        handleMessage
    );

    handleMessage(e){
        var message=new Message;
        message.load(e.data);

        console.log(message.type, message.data);
    }

Sending a Message Object via WebSocket

    //works for browser natively AND node natively
    import { default as Message } from './node_modules/js-message/Message.js';
    //works for browser transpiled AND node natively
    import { default as Message } from 'js-message';

    //client example, but works the same on server too!
    var ws=new WebSocket('ws://myawesomeWS:8000');

    var myMessage=new Message;
    myMessage.type='setUsername';
    myMessage.data.username='sideshow bob';

    ws.send(myMessage.JSON);

This work is licenced via the MIT Licence