# @webafra/kavenegar-nestjs

> kavenegar api in nestjs code style.

Latest version **1.0.3** (published 2022-08-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install @webafra/kavenegar-nestjs
pnpm add @webafra/kavenegar-nestjs
yarn add @webafra/kavenegar-nestjs
bun add @webafra/kavenegar-nestjs
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-08-13 |
| First published | 2022-08-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 114.9 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Author | webafra |
| Maintainers | webafra |

## Links

- npm: https://www.npmjs.com/package/@webafra/kavenegar-nestjs
- Homepage: https://github.com/webafra/kavenegar-nestjs#readme
- Issues: https://github.com/webafra/kavenegar-nestjs/issues
- npm.io page: https://npm.io/package/@webafra/kavenegar-nestjs

## Dependencies (3)

- [rxjs](https://npm.io/package/rxjs.md) ^7.3.1
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^8.0.9
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^8.0.9

## Recent versions

- 1.0.3 (latest) — 2022-08-13
- 1.0.2 — 2022-08-13
- 1.0.1 — 2022-08-09

## README

# Kavenegar nest module

kavenegar api for nestjs.

## Installation:


``` npm i @webafra/kavenegar-nestjs```

## Usage:

Import **kavenegarModule** inside your module:

```
// inside SmsModule*.module.ts

import { KavenegarModule } from "@webafra/kavenegar-nestjs"

@Module({
  imports:[
    KavenegarModule.forRoot({
      apikey:"your kavenegar apiKey"
    })
  ],
  controllers: [SmsController],
  providers: [SmsService]
})
export class SmsModule {}
```

Inject **KavenegarService** into your service: 


```
// inside SmsService*.service.ts

import { KavenegarService } from "@webafra/kavenegar-nestjs";

// example message types based on http://kavenegar.com/rest.html
export interface sendMessage {
    message: string;
    sender: string;
    receptor: string;
}
export interface verifyLookUpMessage {
    template: string;
    token: string;
    receptor: string;
}

@Injectable()
export class SmsService {
    constructor(private readonly sender: KavenegarService) {}
    sendMessage(data: sendMessage ){
        return this.sender.Send(data)
    }
    verifyLookUp(data: verifyLookUpMessage ){
        return this.sender.verifyLookUp(data)
    }
}
```


all of the methods are promised.

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