a base class for sdk with default error handler
npm install sdk-base[![NPM version][npm-image]][npm-url]
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/sdk-base.svg?style=flat-square
[npm-url]: https://npmjs.org/package/sdk-base
[codecov-image]: https://codecov.io/github/node-modules/sdk-base/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/node-modules/sdk-base?branch=master
[snyk-image]: https://snyk.io/test/npm/sdk-base/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/sdk-base
[download-image]: https://img.shields.io/npm/dm/sdk-base.svg?style=flat-square
[download-url]: https://npmjs.org/package/sdk-base
A base class for sdk with some common & useful functions.
``bash`
npm install sdk-base
Constructor argument:
- {Object} options
- {String} [initMethod] - the async init method name, the method should be a function return promise. If set, will execute the function in the constructor.
- {AsyncLocalStorage} [localStorage] - async localStorage instance.
`js
const { Base } = require('sdk-base');
class Client extends Base {
constructor() {
super({
initMethod: 'init',
localStorage: app.ctxStorage,
});
}
async init() {
// put your async init logic here
}
// support async function too
// async init() {
// // put your async init logic here
// }
}
(async function main() {
const client = new Client();
// wait client ready, if init failed, client will throw an error.
await client.ready();
// support async event listener
client.on('data', async function (data) {
// put your async process logic here
//
// @example
// ----------
// await submit(data);
});
client.emit('data', { foo: 'bar' });
})().catch(err => { console.error(err); });
`
- .ready(flagOrFunction) flagOrFunction is optional, and the argument type can be Boolean, Error or Function.
`js
// init ready
client.ready(true);
// init failed
client.ready(new Error('init failed'));
// listen client ready
client.ready(err => {
if (err) {
console.log('client init failed');
console.error(err);
return;
}
console.log('client is ready');
});
// support promise style call
client.ready()
.then(() => { ... })
.catch(err => { ... });
// support async function style call
await client.ready();
`
- async readyOrTimeout(milliseconds) ready or timeout, after milliseconds not ready will throw TimeoutError
`js`
await client.readyOrTimeout(100);
- .isReady getter detect client start ready or not..on(event, listener)
- wrap the EventEmitter.prototype.on(event, listener), the only difference is to support adding async function listener on events, except 'error' event.once(event, listener)
- wrap the EventEmitter.prototype.once(event, listener), the only difference is to support adding async function listener on events, except 'error' event.prependListener(event, listener)
- wrap the EventEmitter.prototype.prependListener(event, listener), the only difference is to support adding async function listener on events, except 'error' event.prependOnceListener(event, listener)
- wrap the EventEmitter.prototype.prependOnceListener(event, listener), the only difference is to support adding generator listener on events, except 'error' event.addListener(event, listener)
- wrap the EventEmitter.prototype.addListener(event, listener), the only difference is to support adding async function listener on events, except 'error' event.
`js
client.on('data', async function(data) {
// your async process logic here
});
client.once('foo', async function(bar) {
// ...
});
// listen error event
client.on('error', err => {
console.error(err.stack);
});
`
- .await(event): await an event, return a promise, and it will resolve(reject if event is error) once this event emmited.
`js`
const data = await client.await('data');
- ._close(): The _close() method is called by close.
It can be overridden by child class, but should not be called directly. It must return promise or generator.
- .close(): The close() method is used to close the instance.
- Drop .awaitFirst(events)` support
- Drop generator function support
- Don't catch event listener inside error
Made with contributors-img.