Neat Paraskavedekatriaphobia's Meaning

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

    1.0.0 • Public • Published

    Facets Microservice Client SDK for Node.js

    This is a Node.js client SDK for service-facets microservice. It provides an easy to use abstraction over communication protocols:

    • HTTP client
    • Seneca client (see http://www.senecajs.org)
    • Direct client for monolytic deployments
    • Null client to be used in testing

    Quick Links:

    Install

    Add dependency to the client SDK into package.json file of your project

    {
        ...
        "dependencies": {
            ....
            "client-facets-node": "^1.0.*",
            ...
        }
    }

    Then install the dependency using npm tool

    # Install new dependencies
    npm install
    
    # Update already installed dependencies
    npm update

    Use

    Inside your code get the reference to the client SDK

    var sdk = new require('client-facets-node');

    Define client configuration parameters that match configuration of the microservice external API

    // Client configuration
    var config = {
        connection: {
            protocol: 'http',
            host: 'localhost', 
            port: 8080
        }
    };

    Instantiate the client and open connection to the microservice

    // Create the client instance
    var client = sdk.FacetsHttpClientV1(config);
    
    // Connect to the microservice
    await client.open(null);
    
    // Work with the microservice
    ...

    Now the client is ready to perform operations

    // Record facets for a user
    let partyFacets = await client.addFacet(
        null,
        'statistics',
        '12234'
    );
    // Get the list of user facets
    let partyFacets = await client.getFacetsByGroup(
        null,
        'statistics'
    );

    Acknowledgements

    This client SDK was created and currently maintained by Sergey Seroukhov.

    Install

    npm i client-facets-node

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    70.4 kB

    Total Files

    48

    Last publish

    Collaborators

    • pipdeveloper