Skip to content

Commit bbedfd3

Browse files
committed
Close #4, fixing package name to stream-to-async-iterator
1 parent 0f06be4 commit bbedfd3

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# Stream Async Iterator
1+
# Stream To Async Iterator
22

33

44
## Overview
55

6-
`stream-async-iterator` provides a wrapper that implements `Symbol.asyncIterator`. This will allow streams to be usable
6+
`stream-to-async-iterator` provides a wrapper that implements `Symbol.asyncIterator`. This will allow streams to be usable
77
as async iterables that can be used in for-await-of loops.
88

99
Supports node.js 4 and up.
1010

1111
## Installation
1212

1313
```
14-
$ npm install stream-async-to-iterator
14+
$ npm install stream-to-async-iterator
1515
```
1616

1717
The examples provides use async/await syntax for for-of loops. This assumes you are in an environment that natively
File renamed without changes.
File renamed without changes.

lib/test/stream-async-iterator-tests.js renamed to lib/test/stream-to-async-iterator-tests.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ import {describe, it} from 'mocha';
33
import fs from 'fs';
44
import path from 'path';
55
import {expect} from 'chai';
6-
import StreamAsyncToIterator from '../stream-async-to-iterator';
6+
import S2A from '../stream-to-async-iterator';
77

88

9-
describe('StreamAsyncToIterator', function() {
9+
describe('StreamAsyncToIterator', () => {
1010
const filePath = path.join(__dirname, 'lorem-ipsum.txt');
1111

1212
it('should iterate on a node stream', async () => {
1313
const fileStream = fs.createReadStream(filePath, {encoding: 'utf8'});
1414
const buff: Array<string> = [];
1515

16-
for await (const value of (new StreamAsyncToIterator(fileStream): StreamAsyncToIterator<string>)) {
16+
for await (const value of (new S2A(fileStream): S2A<string>)) {
1717
buff.push(value);
1818
}
1919

@@ -25,7 +25,7 @@ describe('StreamAsyncToIterator', function() {
2525
const fileStream = fs.createReadStream(filePath, {encoding: 'utf8'});
2626
const buff: Array<string> = [];
2727

28-
for await (const value of (new StreamAsyncToIterator(fileStream, {size: 16}): StreamAsyncToIterator<string>)) {
28+
for await (const value of (new S2A(fileStream, {size: 16}): S2A<string>)) {
2929
buff.push(value);
3030
}
3131

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
2-
"name": "stream-async-to-iterator",
2+
"name": "stream-to-async-iterator",
33
"version": "0.1.0",
44
"description": "ES async interator wrapper for node streams",
5-
"main": "stream-async-iterator.js",
5+
"main": "stream-to-async-iterator.js",
66
"scripts": {
77
"build": "make -j4 build",
88
"test": "make full-test"
99
},
1010
"repository": {
1111
"type": "git",
12-
"url": "git+https://github.com/basicdays/node-stream-async-iterator.git"
12+
"url": "git+https://github.com/basicdays/node-stream-to-async-iterator.git"
1313
},
1414
"keywords": [
1515
"node",
@@ -21,7 +21,7 @@
2121
"author": "BasicDays <info@basicdays.com> (https://www.basicdays.com)",
2222
"license": "MIT",
2323
"bugs": {
24-
"url": "https://github.com/basicdays/node-stream-async-iterator/issues"
24+
"url": "https://github.com/basicdays/node-stream-to-async-iterator/issues"
2525
},
2626
"devDependencies": {
2727
"babel-cli": "^6.18.0",

0 commit comments

Comments
 (0)