# sdk-base

> a base class for sdk with default error handler

Latest version **5.0.1** (published 2024-12-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install sdk-base
pnpm add sdk-base
yarn add sdk-base
bun add sdk-base
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 5.0.1 |
| Published | 2024-12-22 |
| First published | 2014-09-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 18.19.0 |
| Dependencies | 4 |
| Unpacked size | 28.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 62 |
| Author | dead_horse |
| Maintainers | gxcsoccer, dead_horse, fengmk2, popomore |
| Keywords | sdk, error |

## Links

- npm: https://www.npmjs.com/package/sdk-base
- Repository: https://github.com/node-modules/sdk-base
- Homepage: https://github.com/node-modules/sdk-base#readme
- Issues: https://github.com/node-modules/sdk-base/issues
- npm.io page: https://npm.io/package/sdk-base

## Dependencies (4)

- [gals](https://npm.io/package/gals.md) ^1.0.2
- [utility](https://npm.io/package/utility.md) ^2.3.0
- [get-ready](https://npm.io/package/get-ready.md) ^3.4.0
- [is-type-of](https://npm.io/package/is-type-of.md) ^2.2.0

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 5.0.1 (latest) — 2024-12-22
- 5.0.0 — 2024-12-18
- 4.2.1 — 2022-12-17
- 4.2.0 — 2022-12-08
- 4.1.0 — 2022-12-03
- 4.0.0 — 2022-12-03
- 3.6.0 — 2019-04-24
- 3.5.1 — 2018-09-27
- 3.5.0 — 2018-07-26
- 3.4.0 — 2017-11-24
- 3.3.0 — 2017-09-17
- 3.2.0 — 2017-06-26
- 3.1.1 — 2017-03-14
- 3.1.0 — 2017-02-17
- 3.0.1 — 2017-01-12
- … 6 more at https://npm.io/package/sdk-base/versions

## README

# sdk-base

[![NPM version][npm-image]][npm-url]
[![Node.js CI](https://github.com/node-modules/sdk-base/actions/workflows/nodejs.yml/badge.svg)](https://github.com/node-modules/sdk-base/actions/workflows/nodejs.yml)
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[![Node.js Version](https://img.shields.io/node/v/sdk-base.svg?style=flat)](https://nodejs.org/en/download/)

[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.

## Installation

```bash
npm install sdk-base
```

## Usage

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); });
  ```

### API

- `.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)](https://nodejs.org/api/events.html#events_emitter_on_eventname_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)](https://nodejs.org/api/events.html#events_emitter_once_eventname_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)](https://nodejs.org/api/events.html#events_emitter_prependlistener_eventname_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)](https://nodejs.org/api/events.html#events_emitter_prependoncelistener_eventname_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)](https://nodejs.org/api/events.html#events_emitter_addlistener_eventname_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](https://github.com/cojs/await-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.

## Breaking changes between v4 and v5

- Drop `.awaitFirst(events)` support
- Drop generator function support
- Don't catch event listener inside error

### License

[MIT](LICENSE)

## Contributors

[![Contributors](https://contrib.rocks/image?repo=node-modules/sdk-base)](https://github.com/node-modules/sdk-base/graphs/contributors)

Made with [contributors-img](https://contrib.rocks).

---
_Source: https://npm.io/package/sdk-base · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._