rar-stream 1.3.2 → 1.3.5

package/.travis.yml

@@ -1,14 +1,5 @@
 language: node_js
 node_js:
-  - "7"
-before_install:
-  # Repo for Yarn
-  - sudo apt-key adv --keyserver pgp.mit.edu --recv D101F7899D41F3C3
-  - echo "deb http://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
-  - sudo apt-get update -qq
-  - sudo apt-get install -y -qq yarn
-cache:
-  directories:
-  - $HOME/.yarn-cache
+  - "8"
 install:
-  - yarn
+  - npm install

package/README.md

@@ -5,7 +5,7 @@ Library for _"unpacking"_ and reading files inside rar archives as node Readable
 
 __Note: Requires node version >= 8.0.0__
 
-__Note: Uncompression is not implemented at the moment__
+__Note: Decompression is not implemented at the moment__
 
 ## Getting Started
 Below example shows howto unpack local rar files by piping the inner files to the file system.
@@ -50,56 +50,66 @@ npm i rar-stream
 
 ### RarFilesPackage Api
 
-```
-// example
-const rarFilesPackage = new RarFilesPackage(localRarFiles);
-rarFilesPackage.on('parsing-start', rarFiles => console.log(rarFiles))
-rarFilesPackage.on('file-parsed', innerFile => console.log(innerFile.name))
-rarFilesPackage.on('parsing-end', innerFiles => console.log(innerFiles))
-const innerFiles = await rarFilesPackage.parse();
-```
-
 #### Methods:
 Method | Description
 ------|------------
-_constructor_ | Takes an array of local file paths as strings or instances that satifies the [`FileMedia`](#filemedia-interface) api mentioned below.
-parse | Parses all rar files and returns a Promise with `InnerFile`s.
+_constructor_ | Takes an array of local file paths as strings or instances that satifies the [`FileMedia`](#filemedia-interface) interface mentioned below.
+parse | Parses all rar files and returns a Promise with [`InnerFile`](#innerfile-api)s.
 
 #### Events:
 Event | Description
 ------|------------
 parsing-start | Emitted when the parsing is started, happens when you call `parse`. Event args are a bundle represntation of all the rar files passed to the constructor.
-file-parsed | Emitted each time a new inner file is parsed success fully. The event argument is the [`InnerFile`](#innerfile-api) parsed.
+file-parsed | Emitted each time a rar file is parsed. The event argument is the RarFile just parsed, i.e `.rxx` in the chain.
 parsing-complete | Emitted when the parsing is completed. The event argument is an array of all the parsed [`InnerFile`](#innerfile-api)s.
 
-### InnerFile Api
-Implements the [`FileMedia`](#filemedia-interface) interface.
+#### Example
 ```
-// example
-const innerFiles = await rarStreamPackage.parse();
-const innerFileStream = innerFiles[0].createReadStream(0, 10);
+const rarFilesPackage = new RarFilesPackage(localRarFiles);
+rarFilesPackage.on('parsing-start', rarFiles => console.log(rarFiles))
+rarFilesPackage.on('file-parsed', rarFile => console.log(rarFile.name))
+rarFilesPackage.on('parsing-end', innerFiles => console.log(innerFiles))
+const innerFiles = await rarFilesPackage.parse();
 ```
+
+### InnerFile Api
+Implements the [`FileMedia`](#filemedia-interface) interface.
+
 #### Methods:
 Method | Description
 ------|------------
-createReadStream(start: number, end: number) | Returns a `Readable` stream. The start and end interval is inclusive.
+createReadStream({start: number, end: number}) | Returns a `Readable` stream. The start and end interval is inclusive.
 readToEnd | Returns a Promise with a Buffer containing all the content of the file.
 
 #### Properties:
 Property | Description
 ------|------------
 name | The name of the file
-length | Returns the number of bytes
+length | Returns the total number of bytes of the file
+
+#### Example
+```
+const innerFiles = await rarStreamPackage.parse();
+const innerFileStream = innerFiles[0].createReadStream({ start: 0, end: 30});
+```
 
 ### _FileMedia Interface_
 This is loosely enforced interface that makes this module interoptable with other node modules such as [`torrent-stream`](https://www.npmjs.com/package/torrent-stream) or [`webtorrent`](https://www.npmjs.com/package/webtorrent). 
 
 Should have the following shape:
 ```javascript
+ // FileMedia
+ {
+  createReadStream(interval: Interval): Readable,
+  name: string,
+  length: number // Length or size of the file in bytes
+ }
+ 
+ // Interval
+ // start and end should be inclusive.
  {
-  createReadStream(start: number, end: number): Readable, // start and end interval should be inclusive.
-  name: string, // Name of the file
-  length: number // Length of the file
+  start: number,
+  end: number
  }
 ```