Configuring the chosen stack
Create a .npmrc file with the next content
sippo_stack = "<stack>"
where stack is one of:
Janus
SIPoWS
Installing dependencies
Make sure the @quobis NPM scope is configured in the machine. This will be accomplished with the next command:
npm config set @quobis:registry http://npm.internal.quobis.com:4873/
After check it, install dependencies
npm install
Note that this will be needed every time the stack being used is changed.
Launching tests
npm test
And to continuously run the tests and watch for changes:
npm run tdd
Publishing the package
npm publish
Generating a distributable file
npm run dist
A standalone package with UMD wrapping will be generated. It can export the Sippo global variable
or be required as a CommonJS or an AMD module.
Generating the API documentation
npm run doc
The API documentation will be generated in the doc directory.
Cleaning the source code
npm run clean
All the compiled files will be removed.
Logging
SippoJS defines 6 log levels:
- DEBUG
- INFO
- TIME
- WARN
- ERROR
- OFF
By default, WARN level is used. This means only messages with ERROR and
WARN level are printed.
To enable the debug message you can use the sippodebug property for the local
storage of the domain where SippoJS is being used. For example, pasting the next
code to the browser console will enable every debug message:
localStorage.sippodebug = '*'
About SippoJS requirements
WebRTC adapter is currently required in almost every case to insulate the app from spec changes and prefix differences. You can obtain more information at:
An ES5 compatible JavaScript engine is expected. Additionaly, some post ES5 features are also needed. For that reason, the next polyfills are suggested when targeting old browsers and need to be included by applications using SippoJS in order to work as expected in them: