0.0.4 • Published 7 years ago

eos-client v0.0.4

Weekly downloads
4
License
MPL-2.0
Repository
github
Last release
7 years ago

node-eos-client

restify客户端,作为Save项目的一部分,向eos-core发送rest请求,并接受返回信息。该客户端将被其他模块调用,如eos-adminui。

使用说明

  1. 安装eos-client:

    npm安装:npm install eos-client --save

    yarn安装:yarn add eos-client

  2. 创建客户端:

    /**
     * @params {object} opts
     *  - opts.core_addr {string} core地址
     *  - opts.core_port {number} core端口
     */
    let client = require('eos-client').createClient(opts);
  3. 获取列表:

    /*
     * @params {object} opts 筛选条件,此处应包含uploaded_by
     *  - opts.uploaded_by {string} 上传者uuid 
     *  - opts.type {string} 文件类型
     */
    client.getList(opts, 
    /*
     * @params {object} err 错误对象,当有错误时,err不为空,否则为空,需要进行处理
     * @params {object} res 请求正确时,返回的对象
     */
    (err, res) => {});
  4. 上传

    /*
     * @params {object} opts 上传信息
     *  - opts.path {string} 缓存路径,必需
     *  - opts.originalname {string} 原始文件名
     *  - opts.type {string} 文件类型
     *  - opts.visibility {string} 默认public
     *  - opts.uploaded_by {string} 上传者的id
     *  - opts.crypto {string} 加密方式,默认rc4
     *  - opts.key {string} 加密密码
     */
    client.upload(opts, (err, res) => {});
  5. 下载

    /*
     * @params {object} opts 上传信息
     *  - opts.cache_area {string} 缓存路径,必需
     *  - opts.uuid {string} 文件的uuid
     */
    client.download(opts, (err, res) => {});
  6. 获取加密方式

    client.download((err, res) => {});

许可

MPL v. 2. See LICENSE.