ammo - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

lib/index.js

@@ -29,2 +29,5 @@ 'use strict';
     const ranges = parts[1].match(/\d*\-\d*/g);
+
+    // Handle headers with multiple ranges
+
     for (let i = 0; i < ranges.length; ++i) {
@@ -107,2 +110,4 @@ let range = ranges[i];
 
+    // Read desired range from a stream
+
     const pos = this._next;
@@ -117,2 +122,4 @@ this._next = this._next + chunk.length;
 
+    // Calc bounds of chunk to read
+
     const from = Math.max(0, this._range.from - pos);
@@ -119,0 +126,0 @@ const to = Math.min(chunk.length, this._range.to - pos + 1);

package.json

 {
   "name": "ammo",
   "description": "HTTP Range processing utilities",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "repository": "git://github.com/hapijs/ammo",
@@ -16,9 +16,9 @@ "main": "lib/index.js",
   "dependencies": {
-    "boom": "3.x.x",
+    "boom": "4.x.x",
     "hoek": "4.x.x"
   },
   "devDependencies": {
-    "code": "3.x.x",
-    "lab": "10.x.x",
-    "wreck": "8.x.x"
+    "code": "4.x.x",
+    "lab": "11.x.x",
+    "wreck": "10.x.x"
   },
@@ -25,0 +25,0 @@ "scripts": {

README.md

@@ -1,7 +0,53 @@
-#ammo
+# ammo
 
 HTTP Range processing utilities.
 
+[![Npm Version](https://img.shields.io/npm/v/ammo.svg)](https://npmjs.com/package/ammo)
 [![Build Status](https://secure.travis-ci.org/hapijs/ammo.png)](http://travis-ci.org/hapijs/ammo)
 
 Lead Maintainer - [Eran Hammer](https://github.com/hueniverse)
+
+## Usage
+
+```js
+// basic usage
+const range = Ammo.header('bytes=1-5', 10);
+// range --> [{ from: 1, to: 5 }]
+
+// multiple ranges
+const range = Ammo.header('bytes=1-5,7-10', 10);
+// range --> [{ from: 1, to: 5 }, { from: 7, to: 9 }]
+
+// streams (get range within a `source`)
+const range = Ammo.header('bytes=1000-4000', 5000);
+const stream = new Ammo.Stream(range[0]);
+Wreck.read(source.pipe(stream), {}, (err, buffer) => {
+    // buffer is the portion of source within range
+
+});
+```
+
+## API
+
+### `header(header, length)`
+
+Parses the range from a HTTP header.
+
+* `header` - A string in the form of `bytes=from-to`, where `from` and `to` are
+integers specifying the range. Both are optional. Multiple ranges can be passed
+as a comma delimited list.
+* `length` - A positive integer specifying the maximum length the range can
+cover. If a `to` value passed in the `header` string is greater than `length`,
+the `to` value is set as `length - 1`.
+
+Returns an array of objects with the properties `from` and `to`, which specify
+the beginning and ending of the range. Overlapping ranges are combined into one
+object. Returns `null` for invalid input.
+
+### `new Ammo.Stream(range)`
+
+Creates a [`Transform Stream`](https://nodejs.org/api/stream.html) that extracts
+the portion of a piped in stream within `range`.
+* `range` - an object with the properties `from` and `to` that specify the range
+of the piped in stream to read. Objects returned by `Ammo.header` can be passed
+into `range`.

No alert changes

Improved metrics

Total package byte prevSize

6713

increased by32.98%

Lines of code

89

increased by3.49%

Number of lines in readme file

54

increased by575%

Dependency changes

• + Addedboom@4.3.1(transitive)

• - Removedboom@3.2.2(transitive)

• Updatedboom@4.x.x