node-request-progress 项目教程

node-request-progress 项目教程

node-request-progressTracks the download progress of a request made with mikeal/request项目地址:https://gitcode.com/gh_mirrors/no/node-request-progress

1. 项目的目录结构及介绍

node-request-progress/
├── LICENSE
├── README.md
├── index.js
├── package.json
└── test/
    └── index.js

• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• index.js: 项目的主入口文件。
• package.json: 项目的依赖和配置文件。
• test/: 项目的测试目录，包含测试文件 index.js。

2. 项目的启动文件介绍

index.js 是项目的启动文件，主要负责初始化和导出模块。以下是简要代码解析：

var util = require('util'),
    stream = require('stream'),
    Readable = stream.Readable;

function RequestProgress(req, options) {
    if (!(this instanceof RequestProgress)) {
        return new RequestProgress(req, options);
    }

    Readable.call(this, { objectMode: true });

    this._req = req;
    this._options = options || {};
    this._length = parseInt(req.headers['content-length'], 10);
    this._loaded = 0;

    this._start();
}
util.inherits(RequestProgress, Readable);

RequestProgress.prototype._start = function () {
    var self = this;

    this._req.on('data', function (chunk) {
        self._loaded += chunk.length;
        self.push({
            length: self._length,
            loaded: self._loaded
        });
    });

    this._req.on('end', function () {
        self.push(null);
    });
};

RequestProgress.prototype._read = function () {};

module.exports = RequestProgress;

3. 项目的配置文件介绍

package.json 是项目的配置文件，包含了项目的依赖、脚本和其他元数据。以下是简要内容解析：

{
  "name": "node-request-progress",
  "version": "3.0.0",
  "description": "Tracks the progress of a HTTP request",
  "main": "index.js",
  "scripts": {
    "test": "node test/index.js"
  },
  "repository": {
    "type": "git",
    "url": "git://github.com/IndigoUnited/node-request-progress.git"
  },
  "keywords": [
    "http",
    "https",
    "request",
    "progress",
    "stream"
  ],
  "author": "IndigoUnited",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/IndigoUnited/node-request-progress/issues"
  },
  "homepage": "https://github.com/IndigoUnited/node-request-progress#readme",
  "dependencies": {
    "readable-stream": "^3.0.6"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的主入口文件。
• scripts: 项目的脚本命令，例如测试命令 npm test。
• repository: 项目的仓库地址。
• keywords: 项目的关键词。
• author: 项目作者。
• license: 项目许可证。
• bugs: 项目问题追踪地址。
• homepage: 项目主页。
• dependencies: 项目的依赖包。

node-request-progressTracks the download progress of a request made with mikeal/request项目地址:https://gitcode.com/gh_mirrors/no/node-request-progress