# Gifted-Baileys

A WebSocket-based JavaScript library for interacting with the WhatsApp Web API.

[![npm version](https://img.shields.io/npm/v/gifted-baileys.svg)](https://www.npmjs.com/package/gifted-baileys)
[![npm downloads](https://img.shields.io/npm/dm/gifted-baileys.svg)](https://www.npmjs.com/package/gifted-baileys)
[![License](https://img.shields.io/npm/l/gifted-baileys.svg)](https://github.com/mauricegift/gifted-baileys/blob/main/LICENSE)

## Disclaimer

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or affiliates. Use at your own discretion. Do not spam people with this. We discourage any stalkerware, bulk or automated messaging usage.

## Installation

```bash
npm install gifted-baileys
```

Or using yarn:

```bash
yarn add gifted-baileys
```

## Quick Start

### CommonJS (Recommended)

```javascript
const { default: makeWASocket, useMultiFileAuthState, Browsers } = require('gifted-baileys')
```

### ES Modules / TypeScript

```javascript
import pkg from 'gifted-baileys'
const { default: makeWASocket, useMultiFileAuthState, Browsers } = pkg
```

## Features

- Full WhatsApp Web API support
- Multi-device support with QR code and pairing code authentication
- LID (Link ID) addressing support for both personal chats and groups
- Group status/story sending functionality
- Session management and restoration
- Message sending, receiving, and manipulation
- Group management
- Privacy settings
- Profile management
- And much more!

> **Note:** For sending buttons, please use the [gifted-btns](https://npmjs.com/package/gifted-btns) package.

## Documentation

Full documentation is available at [baileys.giftedtech.co.ke](https://baileys.giftedtech.co.ke)
