Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

master #3

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"parser": "@typescript-eslint/parser",
"plugins": ["prettier"],
"extends": [
"plugin:@typescript-eslint/recommended",
"prettier"
],
"parserOptions": { "ecmaVersion": 2021, "sourceType": "module" },
"rules": {
"@typescript-eslint/no-var-requires": 0,
"prettier/prettier": "error"
}
}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ java/rest/rest.iml
**/.idea/
**/target/
**/*.iml

text?.txt
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"semi": true,
"trailingComma": "all",
"singleQuote": true,
"printWidth": 120,
"tabWidth": 2
}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we use "useTabs": true instead of spaces, please

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm push new commit, please - see :)

28 changes: 28 additions & 0 deletions cloneReadableStream.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { Readable, ReadableOptions } from 'stream';

class ReadableStreamClone extends Readable {
constructor(readableStream: Readable, options?: ReadableOptions) {
super(options);

readableStream.on('data', (chunk) => {
this.push(chunk);
});

readableStream.on('end', () => {
this.push(null);
});

readableStream.on('error', (err) => {
this.emit('error', err);
});

readableStream.on('error', (err) => {
this.emit('error', err);
});
}

// eslint-disable-next-line @typescript-eslint/no-empty-function
_read() {}
}

module.exports = ReadableStreamClone;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dash-case for file names please

1,352 changes: 1,348 additions & 4 deletions package-lock.json

Large diffs are not rendered by default.

16 changes: 14 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
"typescript",
"types"
],
"scripts": {},
"scripts": {
"test": "ts-node test.cloneReadableStream.ts",
"lint": "eslint cloneRead.ts",
"format": "eslint cloneRead.ts --fix"
},
"maintainers": [
{
"name": "levansuper",
Expand All @@ -26,6 +30,14 @@
"url": "[email protected]:levansuper/readable-stream-clone.git"
},
"devDependencies": {
"@types/node": "^13.9.3"
"@typescript-eslint/eslint-plugin": "^4.18.0",
"@typescript-eslint/parser": "^4.18.0",
"eslint": "^7.22.0",
"eslint-config-prettier": "^8.1.0",
"eslint-plugin-prettier": "^3.3.1",
"prettier": "^2.2.1",
"@types/node": "^14.14.35",
"ts-node": "^9.1.1",
"typescript": "^4.2.3"
}
}
16 changes: 16 additions & 0 deletions test.cloneReadableStream.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import * as fs from 'fs';
const ReadableStreamClone = require('./cloneReadableStream');

const readStream = fs.createReadStream('text.txt', { highWaterMark: 3 });

// for test purposes I'm restrict internal buffer threshold to 3 byte
const readClone1 = new ReadableStreamClone(readStream, { highWaterMark: 3 });
const readClone2 = new ReadableStreamClone(readStream, { highWaterMark: 3 });

const writeStream1 = fs.createWriteStream('text1.txt');
const writeStream2 = fs.createWriteStream('text2.txt');

readClone1.pipe(writeStream1);
readClone2.pipe(writeStream2);

console.log('File test.txt was copied - OK.');
Copy link
Owner

@levansuper levansuper Mar 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to stick to dash-case while naming the files and name the test files as clone-readable-stream.spec.ts
Also could we have a separate test folder for all the test files?

33 changes: 33 additions & 0 deletions text.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
Example text file for test purposes
72 changes: 10 additions & 62 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,63 +1,11 @@
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
}
}
"compilerOptions":
{
"target": "es2020",
"module": "commonjs",
"esModuleInterop": true,
"moduleResolution": "node"
},
"include": ["*.ts"],
"exclude": ["node_modules"],
}