Use an option object instead of positional arguments

puzpuzpuz · Mar 16, 2020 · 39726c0 · 39726c0
1 parent a7d2cc5
commit 39726c0
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ npm i sonic-boom
 'use strict'
 
 const SonicBoom = require('sonic-boom')
-const sonic = new SonicBoom(process.stdout.fd) // or '/path/to/destination'
+const sonic = new SonicBoom({ fd: process.stdout.fd }) // or { dest: '/path/to/destination' }
 
 for (var i = 0; i < 10; i++) {
   sonic.write('hello sonic\n')
@@ -43,22 +43,20 @@ for (var i = 0; i < 10; i++) {
 
 ## API
 
-### SonicBoom(String|Number, [minLength], [sync])
+### SonicBoom(opts) String|Number, [minLength], [sync])
 
 Creates a new instance of SonicBoom.
 
-The first argument can be:
+The options are:
 
-1. a string that is a path to a file to be written to (mode `'a'`)
-2. a file descriptor, something that is returned by `fs.open` or
+* `fd`: a file descriptor, something that is returned by `fs.open` or
    `fs.openSync`.
+* `dest`: a string that is a path to a file to be written to (mode `'a'`).
+* `minLength`: the minimum lenght of the internal buffer that is
+  required to be full before flushing.
+* `sync`: perform writes synchronously (similar to `console.log`).
 
-The second argument is the minimum length of the internal buffer that is
-required before flushing.
-
-The third argument is a flag that, when true, causes `SonicBoom` to perform synchronous writes.
-
-It will emit the `'ready'` event when a file descriptor is available.
+A `SonicBoom` instance will emit the `'ready'` event when a file descriptor is available.
 
 ### SonicBoom#write(string)
 

diff --git a/example.js b/example.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const SonicBoom = require('.')
-const sonic = new SonicBoom(process.stdout.fd) // or 'destination'
+const sonic = new SonicBoom({ fd: process.stdout.fd }) // or 'destination'
 
 for (var i = 0; i < 10; i++) {
   sonic.write('hello sonic\n')

diff --git a/fixtures/firehose.js b/fixtures/firehose.js
@@ -2,7 +2,7 @@
 
 const SonicBoom = require('..')
 
-const out = new SonicBoom(process.stdout.fd)
+const out = new SonicBoom({ fd: process.stdout.fd })
 const str = Buffer.alloc(1000).fill('a').toString()
 
 let i = 0

diff --git a/index.js b/index.js
@@ -45,11 +45,15 @@ function openFile (file, sonic) {
   })
 }
 
-function SonicBoom (fd, minLength, sync) {
+function SonicBoom (opts) {
   if (!(this instanceof SonicBoom)) {
-    return new SonicBoom(fd, minLength, sync)
+    return new SonicBoom(opts)
   }
 
+  var { fd, dest, minLength, sync } = opts || {}
+
+  fd = fd || dest
+
   this._buf = ''
   this.fd = -1
   this._writing = false

diff --git a/test.js b/test.js
@@ -44,7 +44,7 @@ function buildTests (test, sync) {
 
     const dest = file()
     const fd = fs.openSync(dest, 'w')
-    const stream = new SonicBoom(fd, 0, sync)
+    const stream = new SonicBoom({ fd, sync })
 
     stream.on('ready', () => {
       t.pass('ready emitted')
@@ -71,7 +71,7 @@ function buildTests (test, sync) {
 
     const dest = file()
     const fd = fs.openSync(dest, 'w')
-    const stream = new SonicBoom(fd, 0, sync)
+    const stream = new SonicBoom({ fd, sync })
 
     t.ok(stream.write('hello world\n'))
 
@@ -104,7 +104,7 @@ function buildTests (test, sync) {
 
     const dest = file()
     const fd = fs.openSync(dest, 'w')
-    const stream = new SonicBoom(fd, 0, sync)
+    const stream = new SonicBoom({ fd, sync })
     const source = fs.createReadStream(__filename)
 
     source.pipe(stream)
@@ -127,7 +127,7 @@ function buildTests (test, sync) {
     t.plan(6)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 0, sync)
+    const stream = new SonicBoom({ dest, sync })
 
     stream.on('ready', () => {
       t.pass('ready emitted')
@@ -154,7 +154,7 @@ function buildTests (test, sync) {
 
     const dest = file()
     const fd = fs.openSync(dest, 'w')
-    const stream = new SonicBoom(fd, 4096, sync)
+    const stream = new SonicBoom({ fd, minLength: 4096, sync })
 
     t.ok(stream.write('hello world\n'))
     t.ok(stream.write('something else\n'))
@@ -178,7 +178,7 @@ function buildTests (test, sync) {
 
     const dest = file()
     const fd = fs.openSync(dest, 'w')
-    const stream = new SonicBoom(fd, 0, sync)
+    const stream = new SonicBoom({ fd, sync })
 
     t.ok(stream.write('hello world\n'))
     stream.destroy()
@@ -202,7 +202,7 @@ function buildTests (test, sync) {
     t.plan(1)
 
     const dest = file()
-    const stream = new SonicBoom(dest)
+    const stream = new SonicBoom({ dest })
 
     stream.destroy()
     stream.on('close', () => {
@@ -214,7 +214,7 @@ function buildTests (test, sync) {
     t.plan(8)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 4096, sync)
+    const stream = new SonicBoom({ dest, minLength: 4096, sync })
 
     stream.on('ready', () => {
       t.pass('ready emitted')
@@ -254,7 +254,7 @@ function buildTests (test, sync) {
 
     const dest = file()
     const fd = fs.openSync(dest, 'w')
-    const stream = new SonicBoom(fd, 4096, sync)
+    const stream = new SonicBoom({ fd, minLength: 4096, sync })
 
     stream.on('ready', () => {
       t.pass('ready emitted')
@@ -278,7 +278,7 @@ function buildTests (test, sync) {
     t.plan(9)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 0, sync)
+    const stream = new SonicBoom({ dest, sync })
 
     t.ok(stream.write('hello world\n'))
     t.ok(stream.write('something else\n'))
@@ -314,7 +314,7 @@ function buildTests (test, sync) {
     t.plan(9)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 4096, sync)
+    const stream = new SonicBoom({ dest, minLength: 4096, sync })
 
     t.ok(stream.write('hello world\n'))
     t.ok(stream.write('something else\n'))
@@ -352,7 +352,7 @@ function buildTests (test, sync) {
     t.plan(3)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 0, sync)
+    const stream = new SonicBoom({ dest, sync })
 
     t.ok(stream.write('hello world\n'))
     t.ok(stream.write('something else\n'))
@@ -369,7 +369,7 @@ function buildTests (test, sync) {
     t.plan(4)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 4096, sync)
+    const stream = new SonicBoom({ dest, minLength: 4096, sync })
 
     stream.once('ready', () => {
       t.pass('ready emitted')
@@ -391,7 +391,7 @@ function buildTests (test, sync) {
     t.plan(4)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 4096, sync)
+    const stream = new SonicBoom({ dest, minLength: 4096, sync })
 
     stream.once('ready', () => {
       t.pass('ready emitted')
@@ -414,7 +414,7 @@ function buildTests (test, sync) {
     t.plan(3)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 4096, sync)
+    const stream = new SonicBoom({ dest, minLength: 4096, sync })
     const after = dest + '-moved'
     stream.reopen(after)
     stream.write('after reopen\n')
@@ -432,7 +432,7 @@ function buildTests (test, sync) {
     t.plan(9)
 
     const dest = file()
-    const stream = new SonicBoom(dest, 0, sync)
+    const stream = new SonicBoom({ dest, minLength: 0, sync })
 
     t.ok(stream.write('hello world\n'))
     t.ok(stream.write('something else\n'))
@@ -502,7 +502,7 @@ test('retry on EAGAIN', (t) => {
 
   const dest = file()
   const fd = fs.openSync(dest, 'w')
-  const stream = new SonicBoom(fd, 0, false)
+  const stream = new SonicBoom({ fd, sync: false, minLength: 0 })
 
   stream.on('ready', () => {
     t.pass('ready emitted')
@@ -541,7 +541,7 @@ test('retry on EAGAIN (sync)', (t) => {
 
   const dest = file()
   const fd = fs.openSync(dest, 'w')
-  const stream = new SonicBoom(fd, 0, true)
+  const stream = new SonicBoom({ fd, minLength: 0, sync: true })
 
   stream.on('ready', () => {
     t.pass('ready emitted')
@@ -581,7 +581,7 @@ test('write buffers that are not totally written', (t) => {
 
   const dest = file()
   const fd = fs.openSync(dest, 'w')
-  const stream = new SonicBoom(fd, 0, false)
+  const stream = new SonicBoom({ fd, minLength: 0, sync: false })
 
   stream.on('ready', () => {
     t.pass('ready emitted')
@@ -621,7 +621,7 @@ test('write buffers that are not totally written with sync mode', (t) => {
 
   const dest = file()
   const fd = fs.openSync(dest, 'w')
-  const stream = new SonicBoom(fd, 0, true)
+  const stream = new SonicBoom({ fd, minLength: 0, sync: true })
 
   stream.on('ready', () => {
     t.pass('ready emitted')
@@ -657,7 +657,7 @@ test('sync writing is fully sync', (t) => {
 
   const dest = file()
   const fd = fs.openSync(dest, 'w')
-  const stream = new SonicBoom(fd, 0, true)
+  const stream = new SonicBoom({ fd, minLength: 0, sync: true })
   t.ok(stream.write('hello world\n'))
   t.ok(stream.write('something else\n'))
 
@@ -679,7 +679,7 @@ if (process.versions.node.indexOf('6.') !== 0) {
 
     const dest = file()
     const fd = fs.openSync(dest, 'w')
-    const stream = new SonicBoom(fd, 0, false)
+    const stream = new SonicBoom({ fd, minLength: 0, sync: false })
 
     const buf = Buffer.alloc(1024).fill('x').toString() // 1 MB
     let length = 0
@@ -707,7 +707,7 @@ if (process.versions.node.indexOf('6.') !== 0) {
 
     const dest = file()
     const fd = fs.openSync(dest, 'w')
-    const stream = new SonicBoom(fd, 0, true)
+    const stream = new SonicBoom({ fd, minLength: 0, sync: true })
 
     const buf = Buffer.alloc(1024).fill('x').toString() // 1 MB
     let length = 0
@@ -736,7 +736,7 @@ test('write enormously large buffers sync with utf8 multi-byte split', (t) => {
 
   const dest = file()
   const fd = fs.openSync(dest, 'w')
-  const stream = new SonicBoom(fd, 0, true)
+  const stream = new SonicBoom({ fd, minLength: 0, sync: true })
 
   let buf = Buffer.alloc((1024 * 16) - 2).fill('x') // 16MB - 3B
   const length = buf.length + 4