Eskiz SMS Nodejs (Typescript) package

🌐 Languages: English | O'zbekcha

Nodejs package for sending SMS using Eskiz SMS API.

Features

• Type friendly. Written in typescript.
• Saves token in env file
• Refresh token logic with queue
• Easy to use

Installation

pnpm add eskiz-sms

Usage

import { EskizSms } from "eskiz-sms";

const sms = new EskizSms({
  email: "[email protected]",
  password: "your-password",
});

// !IMPORTANT!
await sms.init();

sms
  .send({
    mobile_phone: "998901234567",
    message: "Hello from Eskiz SMS!",
  })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(error);
  });

Types

import { EskizSmsSendPayload } from "eskiz-sms";

const message: EskizSmsSendPayload = {
  message: "Hello, World!",
  mobile_phone: "905555555555",
};

For more documentation, please visit Eskiz API documentation.

Contributing

Guidelines for contributing to the project.

1. Fork the repository.
2. Create a new branch (git checkout -b feat/branch).
3. Make your changes.
4. Commit your changes (git commit -m 'feat: x method for doing y job').
5. Push to the branch (git push origin feat/branch).
6. Open a pull request.

Development setup

• Node version: 22.xx
• Package manager: pnpm
• Consider copying .env.test to .env.test.local

See the CONTRIBUTING.md for more information.

License

This project is licensed under the ISC License - see the LICENSE file for details.

Contact

Manuchehr - manuchehr.me

Project Link: https://github.com/mdotme/node-eskiz-sms

Feel free to customize it according to your project's specifics.