docs: refine README.md

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>

diff --git a/README.md b/README.md
index 1a4cf8234ea3e2de65fc48c2264b7cb799d50771..d16fe9469287cde778ae05a224700a6b8330986a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -117,15 +117,21 @@ Instantiate your pool based on your needs :
 const { DynamicThreadPool, FixedThreadPool, PoolEvents } = require('poolifier')
 
 // a fixed worker-threads pool
-const pool = new FixedThreadPool(15, './yourWorker.js', { errorHandler: e => console.error(e), onlineHandler: () => console.log('worker is online') })
+const pool = new FixedThreadPool(15, './yourWorker.js', {
+  errorHandler: e => console.error(e),
+  onlineHandler: () => console.info('worker is online')
+})
 
-pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
+pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
 
 // or a dynamic worker-threads pool
-const pool = new DynamicThreadPool(10, 100, './yourWorker.js', { errorHandler: e => console.error(e), onlineHandler: () => console.log('worker is online') })
+const pool = new DynamicThreadPool(10, 100, './yourWorker.js', {
+  errorHandler: e => console.error(e),
+  onlineHandler: () => console.info('worker is online')
+})
 
-pool.emitter.on(PoolEvents.full, () => console.log('Pool is full'))
-pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
+pool.emitter.on(PoolEvents.full, () => console.info('Pool is full'))
+pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
 
 // the execute method signature is the same for both implementations,
 // so you can easy switch from one to another

diff --git a/examples/dynamicExample.js b/examples/dynamicExample.js
index 1b7391d759b01c7d6a41dbc0a953bfc33e5f2c8b..59d992a67e202387d2b3dec6e6b6538e326a9985 100644 (file)
--- a/examples/dynamicExample.js
+++ b/examples/dynamicExample.js
@@ -4,7 +4,7 @@ let poolFull = 0
 let poolBusy = 0
 const pool = new DynamicThreadPool(10, 20, './yourWorker.js', {
   errorHandler: e => console.error(e),
-  onlineHandler: () => console.log('worker is online')
+  onlineHandler: () => console.info('worker is online')
 })
 pool.emitter.on(PoolEvents.full, () => poolFull++)
 pool.emitter.on(PoolEvents.busy, () => poolBusy++)
@@ -17,9 +17,9 @@ for (let i = 1; i <= iterations; i++) {
     .then(() => {
       resolved++
       if (resolved === iterations) {
-        console.log('Time taken is ' + (performance.now() - start))
-        console.log('The pool was full for ' + poolFull + ' times')
-        return console.log('The pool was busy for ' + poolBusy + ' times')
+        console.info('Time taken is ' + (performance.now() - start))
+        console.info('The pool was full for ' + poolFull + ' times')
+        return console.info('The pool was busy for ' + poolBusy + ' times')
       }
       return null
     })

diff --git a/examples/fixedExample.js b/examples/fixedExample.js
index 3f103ca5523f85441fc864172f24f7f142cca477..478c37eb056229360dbdbabcf61ab13e7f058e74 100644 (file)
--- a/examples/fixedExample.js
+++ b/examples/fixedExample.js
@@ -3,7 +3,7 @@ let resolved = 0
 let poolBusy = 0
 const pool = new FixedThreadPool(15, './yourWorker.js', {
   errorHandler: e => console.error(e),
-  onlineHandler: () => console.log('worker is online')
+  onlineHandler: () => console.info('worker is online')
 })
 pool.emitter.on(PoolEvents.busy, () => poolBusy++)
 
@@ -15,8 +15,8 @@ for (let i = 1; i <= iterations; i++) {
     .then(() => {
       resolved++
       if (resolved === iterations) {
-        console.log('Time taken is ' + (performance.now() - start))
-        return console.log('The pool was busy for ' + poolBusy + ' times')
+        console.info('Time taken is ' + (performance.now() - start))
+        return console.info('The pool was busy for ' + poolBusy + ' times')
       }
       return null
     })

diff --git a/examples/multiFunctionExample.js b/examples/multiFunctionExample.js
index 213736ea037899024da9e9aab20213ebf518de40..055f143fdafae8ee1eb82e65f161d0f69f6b2e4e 100644 (file)
--- a/examples/multiFunctionExample.js
+++ b/examples/multiFunctionExample.js
@@ -1,16 +1,16 @@
 const { FixedThreadPool } = require('poolifier')
 const pool = new FixedThreadPool(15, './multiFunctionWorker.js', {
   errorHandler: e => console.error(e),
-  onlineHandler: () => console.log('worker is online')
+  onlineHandler: () => console.info('worker is online')
 })
 
 pool
   .execute({ text: 'hello' }, 'fn0')
-  .then(res => console.log(res))
+  .then(res => console.info(res))
   .catch(err => console.error(err))
 pool
   .execute({ text: 'multiple functions' }, 'fn1')
-  .then(res => console.log(res))
+  .then(res => console.info(res))
   .catch(err => console.error(err))
 
 setTimeout(pool.destroy(), 3000)

diff --git a/examples/multiFunctionWorker.js b/examples/multiFunctionWorker.js
index 53217fa04957821ec4def7bca47b4334e21bf4d0..406afa696dcd01e9c2aa68f91e55c4b0ad507c94 100644 (file)
--- a/examples/multiFunctionWorker.js
+++ b/examples/multiFunctionWorker.js
@@ -2,12 +2,12 @@
 const { ThreadWorker } = require('poolifier')
 
 function fn0 (data) {
-  console.log('Executing function 0')
+  console.info('Executing function 0')
   return { data: 'fn0 your input text was' + data.text }
 }
 
 function fn1 (data) {
-  console.log('Executing function 1')
+  console.info('Executing function 1')
   return { data: 'fn1 your input text was' + data.text }
 }
 

diff --git a/examples/typescript/pool.ts b/examples/typescript/pool.ts
index 7268ebdc599cfaf6a8951583c5d06d1ced71f9c3..869e62a8bf718020c155ae221b85921735a61d74 100644 (file)
--- a/examples/typescript/pool.ts
+++ b/examples/typescript/pool.ts
@@ -10,7 +10,7 @@ export const fixedPool = new FixedThreadPool<MyData, Promise<MyResponse>>(
       console.error(e)
     },
     onlineHandler: () => {
-      console.log('Worker is online')
+      console.info('Worker is online')
     }
   }
 )
@@ -24,7 +24,7 @@ export const dynamicPool = new DynamicThreadPool<MyData, Promise<MyResponse>>(
       console.error(e)
     },
     onlineHandler: () => {
-      console.log('Worker is online')
+      console.info('Worker is online')
     }
   }
 )

diff --git a/examples/yourWorker.js b/examples/yourWorker.js
index 7de9485ceb1a228075011e615fb802d7660185b4..b2df8d19093527e0ca67a24f9f84589ab1207050 100644 (file)
--- a/examples/yourWorker.js
+++ b/examples/yourWorker.js
@@ -11,7 +11,7 @@ function yourFunction () {
     }
     JSON.stringify(o)
   }
-  debug === true && console.log('This is the main thread ' + isMainThread)
+  debug === true && console.info('This is the main thread ' + isMainThread)
   return { ok: 1 }
 }