using an options object rather than a single string option

catdad · Sep 1, 2021 · 5d4b54b · 5d4b54b
1 parent c68f9d6
commit 5d4b54b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 11 deletions.
diff --git a/index.js b/index.js
@@ -8,14 +8,12 @@ var allowedEol = {
   '\r\n': true
 };
 
-module.exports = function lfcrClean(eol) {
-  if (!eol) {
-    // Set a default
-    eol = '\n';
-  }
+module.exports = function lfcrClean(options) {
+  options = options || {};
+  var eol = options.eol || '\n';
 
   if (!allowedEol[eol]) {
-    throw new Error('Invalid EOL: "' + eol + '"');
+    throw new Error('Invalid `eol` option: "' + eol + '"');
   }
 
   var crlf = /\r\n|\n\r|\n|\r/g;

diff --git a/test/index.test.js b/test/index.test.js
@@ -75,7 +75,7 @@ describe('[index]', function () {
     it('accepts \\r\\n as a custom line ending', function (done) {
       es.readArray([
         'chunk\nchunk\rchunk\r\nchunk\r', '\nchunk', '\n',
-      ]).pipe(mod('\r\n')).pipe(es.wait(function (err, data) {
+      ]).pipe(mod({ eol: '\r\n' })).pipe(es.wait(function (err, data) {
         data = data.toString();
 
         expect(data).to.equal('chunk\r\nchunk\r\nchunk\r\nchunk\r\nchunk\r\n');
@@ -87,7 +87,7 @@ describe('[index]', function () {
     it('accepts \\r as a custom line ending', function (done) {
       es.readArray([
         'chunk\nchunk\rchunk\r\nchunk\r', '\nchunk', '\n',
-      ]).pipe(mod('\r')).pipe(es.wait(function (err, data) {
+      ]).pipe(mod({ eol: '\r' })).pipe(es.wait(function (err, data) {
         data = data.toString();
 
         expect(data).to.equal('chunk\rchunk\rchunk\rchunk\rchunk\r');
@@ -99,7 +99,7 @@ describe('[index]', function () {
     it('accepts \\n as a custom line ending', function (done) {
       es.readArray([
         'chunk\nchunk\rchunk\r\nchunk\r', '\nchunk', '\n',
-      ]).pipe(mod('\n')).pipe(es.wait(function (err, data) {
+      ]).pipe(mod({ eol: '\n' })).pipe(es.wait(function (err, data) {
         data = data.toString();
 
         expect(data).to.equal('chunk\nchunk\nchunk\nchunk\nchunk\n');
@@ -110,8 +110,8 @@ describe('[index]', function () {
 
     it('throws if an unknown custom line ending is used', function () {
       expect(function () {
-        mod('wat');
-      }).to.throw(Error, 'Invalid EOL: "wat"');
+        mod({ eol: 'wat' });
+      }).to.throw(Error, 'Invalid `eol` option: "wat"');
     });
   });
 });