Skip to content
Official Node.js client library to interact with residue seamlessly.
JavaScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
samples
src
test
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
appveyor.yml
index.js
package.json

README.md

Residue Node.js Client

Build Status Build status Version GitHub license

Donate

Secure Node.js library to interact with residue server seamlessly.

This module provides interface for connecting and interacting with residue server seamlessly, means, once you are connected this module takes care of expired tokens and clients and keep itself updated with latest tokens and ping server when needed to stay alive.

API

connect(options)

Connects application to residue using params. If options is not specified, you should use loadConfiguration to load the options

Valid options are:

{
    url: "<host_where_residue_server_is_listening>:<residue_connection_port>",
    application_id: <app_name [optional]>,
    rsa_key_size: <key_size_for_initial_final_key_transmission [optional]>,
    utc_time: <whether_to_use_UTC_time [optional]>,
    time_offset: <time_offset_in_seconds [optional]>,
    client_id: <client_id_that_server_knows_you_as [optional]>,
    client_private_key: <full_path_of_private_key> [must be provided with client_id],
    client_public_key: <full_path_of_public_key> [must be provided with client_id],
    client_key_secret: <base16 encoded secret (passphrase) for encrypted private key if any>,
    server_public_key: <full_path_of_server_public_key>
}

Please refer to loadConfiguration in our C++ library's documentation for more details.

loadConfiguration(jsonFilename)

Loads configurations / options via json file. Returns true if successfully loaded, otherwise false.

This does not verify the options. Options are validated in connect() function

getLogger(logger_id)

Returns logger class for logging interface

Usage

const ResidueClient = require('residue');

const residue = new ResidueClient();

const logger = residue.getLogger('sample-app');

const confFile = 'client.conf.json';
if (residue.loadConfiguration(confFile)) {
    residue.connect();
}

// or
// residue.loadConfiguration({ url: ... })
// or
// residue.loadConfiguration('{ url: ... }')

// ALTERNATIVELY
residue.connect({
    url: ...
});

logger.info('simple log');

logger.info('array %s', [1, 2, 3]);

var person = { 'name': 'Adam', 'age': 960, }
logger.info('obj %s', person);

logger.info('null %s', null);

logger.info('undefined %s', undefined);

Log

logger.info(...);
logger.warn(...);
logger.error(...);
logger.debug(...);
logger.trace(...);
logger.fatal(...);
logger.verbose(verbose_level, ...);

Native Binding

Residue Node.js also comes with native binding that uses C++ client library to manage connections and asyncronous requests.

If you have installed residue-native package alongside residue, native binding will be used otherwise it will fallback to JS implementation.

Sample

You can check out sample client apps for practical use of this package.

License

Copyright 2017-present Zuhd Web Services
Copyright 2017-present @abumusamq

https://github.com/zuhd-org/
https://zuhd.org
https://muflihun.com/

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
You can’t perform that action at this time.