websocket-struct v1.0.4

websocket-struct

描述

websocket-struct是一个用于前端和服务器进行WebScoket纯数据的传输时，用于字节数据与前端数据结构的互相转换的工具库。

安装

# npm
npm install websocket-struct
# cnpm
cnpm install websocket-struct

示例

直接在你需要定义WS数据结构时引入websocket-struct中的函数即可，然后使用对应的装饰器：

import { WebSocketStruct, tdWebSocketStruct, ReadWrite, tdWebSocketField, FieldType, BitType } from 'websocket-struct';

@tdWebSocketStruct(ReadWrite.All)
export class LED extends WebSocketStruct {
    @tdWebSocketField({ fieldType: FieldType.UInt8 })
    mode = 0;
    @tdWebSocketField({ fieldType: FieldType.Bit, bitType: BitType.Boolean, length: 1, bitDataFromField: 'mode'  })
    supportA = false;
    @tdWebSocketField({ fieldType: FieldType.Bit, bitType: BitType.Boolean, length: 1, bitDataFromField: 'mode'  })
    supportB = false;
    @tdWebSocketField({ fieldType: FieldType.Bit, bitType: BitType.Boolean, length: 1, bitDataFromField: 'mode'  })
    supportC = false;
    @tdWebSocketField({ fieldType: FieldType.Boolean })
    enable = false;
    @tdWebSocketField({ fieldType: FieldType.UInt8 })
    aTime = 0;
    @tdWebSocketField({ fieldType: FieldType.UInt8 })
    bTime = 0;
    @tdWebSocketField({ fieldType: FieldType.UInt8 })
    cTime = 0;
    @tdWebSocketField({ fieldType: FieldType.UInt8_Array, arrLength: 3 })
    reserved = 0; // 3
}

@tdWebSocketStruct(ReadWrite.All)
export class Light extends WebSocketStruct {
    @tdWebSocketField({ fieldType: FieldType.Boolean })
    enable = false;
    @tdWebSocketField({ fieldType: FieldType.Struct, construct: LED })
    micOn = new LED();
    @tdWebSocketField({ fieldType: FieldType.UInt8_Array, arrLength: 32 })
    reserved = 0;
}

...

// 读数据
const buffer = [...];
const light = new Light();
light.fromBuffer(buffer);
// 写数据
const buffer2 = light.toBuffer();

主要API

装饰器、类：

可读写属性：

WS类字段的装饰器函数参数的类型TdWebSocketFieldParameter：

支持性

FieldType类型：

BitType类型：

特点

• 良好的TS类型提示
• 使用简单，而且支持的数据类型很多
• 减少大量的冗余代码，开发者只需要关心业务
• 减少服务器修改属性后带来的维护成本，前端只需要维护一份model，集中管理