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

@wcferry/ws

v0.0.1

Published

A Wcferry websocket server

Downloads

2

Readme

@wcferry/ws

A Wcferry websocket server

websocket

Usage

Standalone

Start a standalone websocket server at 8000:

await WcfWSServer.start({ port: 8000 });

Attach to existing Wcferry instance

const wcferry = new Wcferry();
new WcfWSServer(wcferry, { port: 8000 });
// impl your bot logic ...

Message definiton

General commands:

interface Command {
    id: number; // message unique id (server will response the command with the same id)
    method: string; // the allowed method name, to invoke wcferry.[method](...params)
    params?: any[]; // the parameters of the method call
}

methods and params are same as methods in @wcferry/core

All the supported commands:

[
    'acceptNewFriend',
    'addChatRoomMembers',
    'dbSqlQuery',
    'decryptImage',
    'delChatRoomMembers',
    'downloadAttach',
    'downloadImage',
    'forwardMsg',
    'getAliasInChatRoom',
    'getAudioMsg',
    'getChatRoomMembers',
    'getChatRooms',
    'getContact',
    'getContacts',
    'getDbNames',
    'getFriends',
    'getMsgTypes',
    'getOCRResult',
    'getSelfWxid',
    'getUserInfo',
    'inviteChatroomMembers',
    'isLogin',
    'receiveTransfer',
    'refreshPyq',
    'revokeMsg',
    'sendFile',
    'sendImage',
    'sendPat',
    'sendRichText',
    'sendTxt',
];

Special commands

Following commands can control whether receving messages including pyq messages:

// enable receiving message:
interface EnableMessage {
    id: number;
    method: 'message.enable';
}

// disable receiving message:
interface DisableMessage {
    id: number;
    method: 'message.disable';
}

// set if receiving pyq message:
interface SetRecvPyq {
    id: number;
    method: 'recvPyq';
    params: [boolean];
}

Server response

Command response

  1. ok:
interface OKResp {
    id: number;
    result: any;
}
  1. error:
interface ErrorResp {
    id: number;
    error: { message: string; code?: number };
}

Message response

Once we enable receiving message, the websocket server will start to push the chat messages back:

interface Message {
    type: 'message';
    data: WxMsg;
}

Building

Run nx build ws to build the library.

Running unit tests

Run nx test ws to execute the unit tests via Vitest.