npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ayracordjs/ws

v1.4.2

Published

WebSocket for ayracordjs

Downloads

128

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.`