react-socket-hook

快速启动的脚手架

使用

# install
yarn add react-socket-hook

基础用法

import useSocket from 'react-socket-hook'

const { send } = useSocket('wss://echo.websocket.org', {
  onReceived: (data: DataType) => {
    // hanlde data in here.
  },
})

// send some data
send('something')

声明

export declare type DataType = string | ArrayBufferLike | Blob | ArrayBufferView;

export interface UseSocketOptions {
  protocols?: WebSocket['protocol'];
  binaryType?: BinaryType;
  /**
   * 自动连接
   * @default true
   */
  autoConnect?: boolean;
  onConnected?: () => void;
  onClosed?: () => void;
  onReceived?: (data: DataType) => void;
  onError?: (errEvent: Event) => void;
}

export interface UseSocketReturn {
  /**
   * 主动调用来拉起连接。
   * 如果当前已是连接状态，则会保持状态。
   */
  connect: () => void;
  /**
   * 主动断开连接
   */
  close: () => void;
  /**
   * 发送数据
   * @param data
   */
  send: (data: DataType) => Promise<void>;
}

export declare type UseSocket = (url: string, options?: UseSocketOptions) => UseSocketReturn;

常用指令

# 开发
yarn dev
# 打包
yarn build
# 提交代码
yarn cz