# ts-kavenegar

> typescript package repository [GitHub Page](https://github.com/keshvarideveloper/ts-kavenegar)

Latest version **0.0.8** (published 2021-11-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install ts-kavenegar
pnpm add ts-kavenegar
yarn add ts-kavenegar
bun add ts-kavenegar
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2021-11-29 |
| First published | 2021-11-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 38.5 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Masood Keshvari |
| Maintainers | masoodkeshvari |

## Links

- npm: https://www.npmjs.com/package/ts-kavenegar
- Repository: https://github.com/keshvarideveloper/ts-kavenegar
- Homepage: https://github.com/keshvarideveloper/ts-kavenegar#readme
- Issues: https://github.com/keshvarideveloper/ts-kavenegar/issues
- npm.io page: https://npm.io/package/ts-kavenegar

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.24.0
- [@types/query-string](https://npm.io/package/@types/query-string.md) ^6.3.0

## Recent versions

- 0.0.8 (latest) — 2021-11-29
- 0.0.7 — 2021-11-29
- 0.0.6 — 2021-11-29
- 0.0.5 — 2021-11-29
- 0.0.4 — 2021-11-29
- 0.0.3 — 2021-11-28
- 0.0.2 — 2021-11-28

## README

typescript package repository [GitHub Page](https://github.com/keshvarideveloper/ts-kavenegar)

javascript package repository [GitHub page](https://github.com/KaveNegar/kavenegar-node)

# Description

typescript package for kavenegar

# Installation

```
$ npm i --save ts-kavenegar
```

# Usage

## Create instance

```typescript
import { Kavenegar } from 'ts-kavenegar";
```

```typescript
const kavenegar: Kavenegar = new Kavenegar('Your Kavenegar API key');
```

## Use it

```typescript
import { SendDTO } from 'ts-kavenegar";
```

```typescript
const sendData: SendDTO = { message: 'hi..', receptor: '09120000000' };
const result = await kavenegar.send(sendData);
```

## Error handling

```typescript
import { KavenegarError } from 'ts-kavenegar";
```

- With Async/await

```typescript
try {
  const result = await kavenegar.selectoutbox(sendData);
} catch (err: any) {
  if (err instanceof KavenegarError) {
    // handling kavenegar error
    console.log('error name', err.name); // 417
    console.log('error message', err.message); // دسترسی به اطلاعات مورد نظر برای شما امکان پذیر نیست
  }
  //handling other error
}
```

- With Promise => .then

```typescript
kavenegar
  .selectoutbox(sendData)
  .then((res) => {
    // result
  })
  .catch((err) => {
    if (err instanceof KavenegarError) {
      // handling kavenegar error
      console.log('error name', err.name); // 417
      console.log('error message', err.message); // دسترسی به اطلاعات مورد نظر برای شما امکان پذیر نیست
    }
    //handling other error
  });
```

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