@ayracordjs/ws
v1.4.2
Published
WebSocket for ayracordjs
Downloads
1
Readme
Вот пример файла README.md
для библиотеки @ayracordjs/ws
, который объясняет, как использовать библиотеку для работы с WebSocket, Discord API и HTTPS-клиентом:
@ayracordjs/ws
A lightweight WebSocket library designed for Discord API integration, with built-in HTTPS client support for making API requests. This library is ideal for building Discord bots or other real-time applications using WebSocket.
Features
- WebSocket Client: Simple interface for connecting to WebSocket servers (such as Discord Gateway).
- HTTP Client: Lightweight HTTP client for making API requests to Discord and other HTTP-based services.
- Discord API Integration: Preconfigured methods for interacting with Discord's API (send messages, manage channels, etc.).
Installation
To install the package, run the following command:
npm install @ayracordjs/ws
Usage
1. WebSocket Client
You can use the WebSocketClient
class to establish a WebSocket connection and listen for events.
import { WebSocketClient } from '@ayracordjs/ws';
const ws = new WebSocketClient('wss://gateway.discord.gg');
// Connect to the WebSocket
ws.connect();
// Listen for messages
ws.onMessage((message) => {
console.log('Received message:', message);
});
// Send a message
ws.send(JSON.stringify({ op: 1, d: null }));
2. HTTP Client
The HttpClient
class can be used to make HTTP requests to Discord's REST API or any other API.
import { HttpClient } from '@ayracordjs/ws';
const http = new HttpClient('https://discord.com/api/v10');
// Make a GET request
http.get('/users/@me', { Authorization: `Bot YOUR_BOT_TOKEN` })
.then(response => {
console.log('User data:', response);
})
.catch(error => {
console.error('Error:', error);
});
3. Discord API
The DiscordAPI
class provides an easy way to interact with Discord's API for common operations such as sending messages or managing channels.
import { DiscordAPI } from '@ayracordjs/ws';
const discordApi = new DiscordAPI('https://discord.com/api/v10', 5000, 'YOUR_BOT_TOKEN');
// Send a message to a specific channel
discordApi.sendMessage('CHANNEL_ID', 'Hello, Discord!')
.then(() => {
console.log('Message sent!');
})
.catch(error => {
console.error('Failed to send message:', error);
});
API Reference
WebSocketClient
- constructor(url: string): Creates a new WebSocket client instance.
- connect(): Promise: Connects to the WebSocket server.
- onMessage(callback: (message: string) => void): void: Listens for incoming WebSocket messages.
- send(data: string): void: Sends data to the WebSocket server.
HttpClient
- constructor(baseURL: string, timeout: number = 5000): Creates a new HTTP client instance.
- get(endpoint: string, headers: object): Promise: Sends a GET request.
- post(endpoint: string, body: object, headers: object): Promise: Sends a POST request.
DiscordAPI
- constructor(baseURL: string, timeout: number, token: string): Initializes the Discord API client.
- sendMessage(channelId: string, message: string): Promise: Sends a message to a Discord channel.
Contributing
Feel free to submit issues, fork the repository, and send pull requests.
License
This project is licensed under the MIT License. See the LICENSE
file for more information.
Note:
Be sure to update information such as YOUR_BOT_TOKEN
, CHANNEL_ID
, and any other parameters with real data.`