![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
residue
Advanced tools
Readme
﷽
A very simple, secure Node.js library to interact with residue 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.
This library depends on following native modules, without them library will not work:
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
var residue = require('residue');
var logger = residue.getLogger('sample-app');
const confFile = 'client.conf.json';
if (residue.loadConfiguration(confFile)) {
residue.connect();
}
// 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);
// other levels
logger.warn(...);
logger.error(...);
logger.debug(...);
logger.trace(...);
logger.fatal(...);
logger.verbose(verbose-level, ...);
You can check out sample client apps for practical use of this package.
Copyright 2017-present Muflihun Labs
Copyright 2017-present @abumusamq
https://github.com/muflihun/
https://muflihun.github.io/
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.
FAQs
Library to interact with residue server seamlessly.
We found that residue demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.