# 安装

# 通过 npm 下载安装代码

$ npm i keyboard-link --save

# 通过 yarn 下载安装代码

$ yarn add keyboard-link

# 通过 pnpm 下载安装代码

$ pnpm i keyboard-link

# 使用

说明:

参数 类型 说明
host String ws 链接地址
port Number ws 链接端口
useTimer Boolean? 可选,默认值为 false,是否使用定时器
isRemoveHeaderNewlinesCharacter Boolean? 可选,默认值为 false,是否移除头部换行符
isRemoveTailNewlinesCharacter Boolean? 可选,默认值为 false,是否移除尾部换行符

# esm

import keyboardLink from "keyboard-link";
new keyboardLink({
  host: "ws:xxx.xxx.xxx.xxx",
  port: 0000,
  useTimer: true,
});

# cjs

requirejs(
  ["node_modules/keyboard-link/dist/index.js"],
  function (keyboardLink) {
    new keyboardLink({
      host: "ws:xxx.xxx.xxx.xxx",
      port: 0000,
      useTimer: false,
    });
  }
);

# 浏览器直接使用

<script src="node_modules/keyboard-link/dist/index.aio.min.js"></script>
<script>
  new window.keyboardLink({
    host: "ws:xxx.xxx.xxx.xxx",
    port: 0000,
    useTimer: false,
  });
</script>

# 兼容性

类型 是否支持 说明
input type='text' ✔️ 支持良好
textarea ✔️ 支持良好
input type='number' 由于数字键盘支持输入特殊符号,并且获取实际的值并不是实际可以操作的。而且底层也没有相关的 api 可以获取到。所以建议移除项目中的数字输入框,并使用文本输入框进行自定义校验