Variable defaultConst

default: {
    load(importPaths: string[], ...filenames: string[]): void;
    marshal(message: string, value: any, filename?: string): ArrayBuffer;
    unmarshal(message: string, data: ArrayBuffer, filename?: string): any;
}

Type declaration

  • load:function
    • load(importPaths, ...filenames): void

    • 加载 pb 文件。

      import protobuf from 'pts/protobuf';

      // 加载协议文件根目录中的 demo.proto
      protobuf.load([], 'demo.proto');

      // 加载中协议文件 dirName 目录中的 demo.proto
      protobuf.load(['dirName'], 'demo.proto');

      Parameters

      • importPaths: string[]

        用于搜索在 proto 源文件的 import 语句中引用的依赖项的路径。如果没有提供导入路径，则当前目录被假定为唯一的导入路径。

      • Rest...filenames: string[]

        pb 文件名列表, 支持单个文件名调用

      Returns void

  • marshal:function
    • marshal(message, value, filename?): ArrayBuffer

    • pb 序列化。

      import protobuf from 'pts/protobuf';

      // 加载协议文件根目录中的 demo.proto
      protobuf.load([], 'demo.proto');

      // 加载中协议文件 dirName 目录中的 demo.proto
      // protobuf.load(['dirName'], 'demo.proto');

      export default function () {
          let data = protobuf.marshal('trpc.wtp.demo.stSayHelloReq', {"msg": "pts"});
          console.log(data); // [object ArrayBuffer]

          let value = protobuf.unmarshal('trpc.wtp.demo.stSayHelloReq', data);
          console.log(JSON.stringify(value)); // {"msg":"pts"}
      };

      Parameters

      • message: string

        结构体名

      • value: any

        json化的请求体

      • Optionalfilename: string

        文件名，可选

      Returns ArrayBuffer

      响应对象

  • unmarshal:function
    • unmarshal(message, data, filename?): any

    • pb 反序列化。

      import protobuf from 'pts/protobuf';

      // 加载协议文件根目录中的 demo.proto
      protobuf.load([], 'demo.proto');

      // 加载中协议文件 dirName 目录中的 demo.proto
      // protobuf.load(['dirName'], 'demo.proto');

      export default function () {
          let data = protobuf.marshal('trpc.wtp.demo.stSayHelloReq', {"msg": "pts"});
          console.log(data); // [object ArrayBuffer]

          let value = protobuf.unmarshal('trpc.wtp.demo.stSayHelloReq', data);
          console.log(JSON.stringify(value)); // {"msg":"pts"}
      };

      Parameters

      • message: string

        结构体名

      • data: ArrayBuffer

        二进制请求体

      • Optionalfilename: string

        文件名，可选

      Returns any

      响应对象

Settings

Member Visibility