Asterisk AMI Event Utils for NodeJS (ES2015)
Some service functions for parse\stringify raw data packages (events, actions, responses, extended responses) from Asterisk AMI's socket. This library is a part of Asterisk's AMI Client library.
Install
$ npm i asterisk-ami-event-utils
NodeJS versions
support >=4.0.0
Available methods
.toString(buffer)
- converts raw AMI's data package from buffer to utf-8 string and trim all CRLF in start or end of this string;.toObject(buffer)
- converts raw AMI's data package from buffer to object;.toJson(buffer)
- converts raw AMI's data package from buffer to json-string;.toArray(buffer)
- converts raw AMI's data package from buffer to paired-array,
like this: [['prop_name_1', 'prop_val_1'], ..., ['prop_name_n', 'prop_val_n']];.fromObject(obj)
- converts data package from object to string, which ready for send into
socket of Asterisk AMI socket;.fromArray(arr)
- converts data package from paired-array to string, which ready for send into
socket of Asterisk AMI socket;.fromString(str)
- prepares data package's string into correct form for send into socket of Asterisk AMI socket;
Usage
const amiUtils = ;let eventBuffer = '...'; // any buffer or string of event from AMI's socket or from other placelet eventObject = amiUtils;
Examples
For examples, please, see tests ./test/*
.
Tests
Tests require Mocha.
mocha ./tests
or with npm
npm test
Test coverage with Istanbul
npm run coverage
License
Licensed under the MIT License