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

signalr-for-wx

v1.1.6

Published

.NET Core SignalR client for wechat miniprogram

Downloads

396

Readme

@aspnet/signalr for wechat miniprogram

copy from @aspnet/signalr

使用

  1. install yarn add signalr-for-wx
  2. 执行小程序 npm 包 编译
  3. use | 参考官方文档
  4. 小程序使用 需要直接从 miniprogram_npm/signalr-for-wx/index 中引用,不然在真机运行时,报 signalr-for-wx is not defined.

Example (use for wechat miniprogram)

官方 API

  1. (yarn libiary)[https://yarnpkg.com/en/package/@aspnet/signalr]
  2. (github)[https://github.com/SignalR/SignalR]

修改后差异使用示例

// import - 这里需要从 miniprogram_npm 引入,小程序包引入问题还没解决
import * as signalr from "miniprogram_npm/signalr-for-wx/index";

// 默认连接示例
const socket = new signalr.HubConnectionBuilder()
      .configureLogging(1)
      .withUrl(`${config.baseUrl}/socket`)
      .build();

// 替换参数示例
this.socket = new signalr.HubConnectionBuilder()
      .configureLogging(1)
      .withUrl(`${config.baseUrl}/socket`, {
        logger, // 自定义Ilogger [遵循官方即可]
        request, // 可选, 替换默认请求库
        socketUrlFactory: async url => {
          // 注意: 差异部分, 用于替换原有 accessTokenFactory() 在 后端修改 access_token 参数情况下,替换socket链接url使用.
          return url;
        }
      })
      .build();

// invoke 具体看官方示例
this.socket.invoke('mothod name',(...args)=>{});

// 事件绑定/解绑 on|off
this.socket.on('message event name',(...args) => {});

this.socket.off('message event name');

// 新增绑定唯一事件
this.socket.on(`message event name`,(...args)=> {/* callback */} , true);


// onclose

this.socket.onclose((err)=>{
  // TODO ...
});

// 其他的看官方示例吧.基本没改动

自定义 request

  1. 参数请参考 axios 官方示例 (github)[https://github.com/axios/axios]
// 改写 axios 实现
export const request = new signalr.Request(
  {
    baseUrl: ``,
    timeout: 60 * 1000,
    headers: { tenantId: config.abpTenantId, "content-type": "application/json" },
    transformRequest: [ // 支持 async/await
      async (options:RequestOptions) =>{
        options.url = `new url`;
        // TODO ...
      }
    ],
    transformResponse: [ // 支持 async/await
      async (response:ResponseOptions)=>{
        // TODO 处理 response

        // 如果 return Promise.reject() 或 抛出异常,则停止后续 响应处理
      }
    ],
    responseType: signalr.ResponseType.JSON,
    method: signalr.RequestMethod.GET
  },
  new Ilogger() // logger 接口实现,可不传
);

library

原始项目地址 @aspnet/signalr

notes

基于@aspnet/signalr ts client 源码实现,操作方式参考@aspnet/signalr

代码改动还不完善 有 bug 的话,github 上帮忙提下 issue issues link

自己编译的话,执行 yarn build:wx 即可.

变更内容

  1. 引入 微信 ts library ./typings/**,修改了编译指向为 ./src/**/*.ts
  2. 将 引用 parent project 的 配置项,引入项目内,直接使用。
  3. 关闭了一些 tslint 检测,同时删除了原有的编译 esm,cjs ... 编译命令,引入新的 build:wx 命令
  4. 引入了封装了的 wx-request 请求库, 参考 axios 官方示例 (github)[https://github.com/axios/axios]
  5. (core) 注意,重写的主要内容包含两块, 1. 删除原有的 HttpClient 实现,引入 wx-request, 2. 删除原有 WebSocket 及 socket 事件绑定,修改为微信支持的 wx.connectSocket() 方法
  6. (remove) 删除了 项目中兼容 node,browser 的文件,方法. 如:browser-index.tsBuffer 对象兼容
  7. 加上了山寨版的中文注释
  8. 重写后的 about() 方法支持的不太完善.因为不清楚 wx.requestTask 运行机制,仅能在请求前,获得响应后,headers变化时,判断是否需要中断请求
  9. (2019 年 12 月 13 日 23:09:18 新增) 增加 socketUrlFactory() 参数, 用来解决后端修改 access_token 字段的情况.

path manifest

┌\n ├ ./wx 修改后的源码路径\n ├ ─ ./wx/wx-request 封装微信请求库\n ├ \n ├ ./library 微信小程序 lib.d.ts\n ├ ./src 原始源码路径, 但是现在没法编译了,因为改写了 tsrootpath.\n ├ ./dist 编译后的 js 包, es 版本, 没其他的\n ├ ./typings 导出的 ts .d.ts\n

version

  • 2020年1月15日 14:19:31

    1. request请求修改了下入参类型,增加了 第三个参数 any类型.
  • 2020 年 1 月 1 日 22:37:11

    1. 新增 on() 绑定唯一事件, use: socket.on('event',()=>{/* callback*/},true);
  • 2019 年 12 月 14 日 12:37:39

  1. 补充更新 wx-request 对 transform 方法增加 async/await 支持.
  • 2019 年 12 月 13 日 23:03:01
  1. 公司用的 signalr-for-wx 的小程序交互的小程序已经进入测试了, 开发阶段使用没出过什么问题,文档参考原版就行.
  2. IHttpConnectionOptions.ts 增加可选参数 socketUrlFactory 用来解决后端修改 access_token 字段的情况.
  • 2019 年 12 月 9 日 16:39:33 (有改动)
  1. 因为这个库超过了 100kb,导致直接在小程序项目中 require("signalr-for-wx") 在真机运行时,报 signalr-for-wx is not defined. 错误。 原因是因为
  • 2019 年 12 月 6 日 13:26:01 今天改了下 bug,然后修改了原生实现自定义 Transport 方法, 目前,实现自定义 Transport 需要继承对应的 Transport class,或者 实现对应的 [WxSocket|LongPolling]TransportOptions] 还有就是,修改了 Transport 构造函数,将原有的传入多参数封装成为 options,可以引用自定义实现的 options 来创建传输实例了.