Renaming progressCb parameter to onProgress

Author: AuHau

README.md

@@ -204,7 +204,7 @@ This will create empty migration with next version in line.
 
 ## API
 
-### `migrate(path, {toVersion, ignoreLock, repoOptions, progressCb, isDryRun}) -> Promise<void>`
+### `migrate(path, {toVersion, ignoreLock, repoOptions, onProgress, isDryRun}) -> Promise<void>`
 
 Executes forward migration to specific version or if not specified to the latest version.
 
@@ -215,10 +215,10 @@ Executes forward migration to specific version or if not specified to the latest
  * `options.toVersion` (int, optional) - version to which the repo should be migrated to. If left out the version of latest migration is used.
  * `options.ignoreLock` (bool, optional) - if true won't lock the repo for applying the migrations. Use with caution.
  * `options.repoOptions` (object, optional) - options that are passed to migrations, that use them to correctly construct datastore. Options are same like for IPFSRepo.
- * `options.progressCb` (function, optional) - callback that is called after finishing execution of each migration to report progress.
+ * `options.onProgress` (function, optional) - callback that is called after finishing execution of each migration to report progress.
  * `options.isDryRun` (bool, optional) - flag that indicates if it is a dry run that should imitate running migration without actually any change.
 
-#### `progressCb(migration, counter, totalMigrations)`
+#### `onProgress(migration, counter, totalMigrations)`
 
 Signature of the progress callback.
 
@@ -227,7 +227,7 @@ Signature of the progress callback.
  * `counter` (int) - current number of migration in the planned migrations streak.
  * `totalMigrations` (int) - total count of migrations that are planned to be run.
 
-### `revert(path, toVersion, {ignoreLock, options, progressCb, isDryRun}) -> Promise<void>`
+### `revert(path, toVersion, {ignoreLock, options, onProgress, isDryRun}) -> Promise<void>`
 
 Executes backward migration to specific version.
 
@@ -238,7 +238,7 @@ Executes backward migration to specific version.
  * `options` (object, optional) - options for the reversion
  * `options.ignoreLock` (bool, optional) - if true won't lock the repo for applying the migrations. Use with caution.
  * `options.options` (object, optional) - options that are passed to migrations, that use them to correctly construct datastore. Options are same like for IPFSRepo.
- * `options.progressCb` (function, optional) - callback that is called after finishing execution of each migration to report progress.
+ * `options.onProgress` (function, optional) - callback that is called after finishing execution of each migration to report progress.
  * `options.isDryRun` (bool, optional) - flag that indicates if it is a dry run that should imitate running migration without actually any change.
 
 ### `getLatestMigrationVersion() -> int`

src/commands.js

@@ -34,7 +34,7 @@ async function migrate ({ repoPath, to, dry, revertOk }) {
   const options = {
     toVersion: to,
     ignoreLock: false,
-    progressCb: reportingClosure(dry ? 'loaded migration' : 'migrated to version'),
+    onProgress: reportingClosure(dry ? 'loaded migration' : 'migrated to version'),
     isDryRun: dry
   }
 

src/index.js

@@ -41,12 +41,12 @@ exports.getLatestMigrationVersion = getLatestMigrationVersion
  * @param {int?} options.toVersion - Version to which the repo should be migrated, if undefined repo will be migrated to the latest version.
  * @param {boolean?} options.ignoreLock - Won't lock the repo for applying the migrations. Use with caution.
  * @param {object?} options.repoOptions - Options that are passed to migrations, that can use them to correctly construct datastore. Options are same like for IPFSRepo.
- * @param {function?} options.progressCb - Callback which will be called after each executed migration to report progress
+ * @param {function?} options.onProgress - Callback which will be called after each executed migration to report progress
  * @param {boolean?} options.isDryRun - Allows to simulate the execution of the migrations without any effect.
  * @param {array?} options.migrations - Array of migrations to migrate. If undefined, the bundled migrations are used. Mainly for testing purpose.
  * @returns {Promise<void>}
  */
-async function migrate (path, {toVersion, ignoreLock=false, repoOptions, progressCb, isDryRun=false, migrations}) {
+async function migrate (path, {toVersion, ignoreLock=false, repoOptions, onProgress, isDryRun=false, migrations}) {
   migrations = migrations || defaultMigrations
 
   if (!path) {
@@ -96,7 +96,7 @@ async function migrate (path, {toVersion, ignoreLock=false, repoOptions, progres
         e.message = `During migration to version ${migration.version} exception was raised: ${e.message}`
         throw e
       }
-      typeof progressCb === 'function' && progressCb(migration, counter, totalMigrations) // Reports on migration process
+      typeof onProgress === 'function' && onProgress(migration, counter, totalMigrations) // Reports on migration process
       log(`Migrating to version ${migration.version} finished`)
     }
 
@@ -118,14 +118,14 @@ exports.migrate = migrate
  * @param {string} path - Path to initialized (!) JS-IPFS repo
  * @param {int} toVersion - Version to which the repo will be reverted.
  * @param {Object} options - Options for the reversion
- * @param {function?} options.progressCb - Callback which will be called after each reverted migration to report progress
+ * @param {function?} options.onProgress - Callback which will be called after each reverted migration to report progress
  * @param {object?} options.repoOptions - Options that are passed to migrations, that can use them to correctly construct datastore. Options are same like for IPFSRepo.
- * @param {boolean?} options.isDryRun - Allows to simulate the execution of the reversion without any effects. Make sense to utilize progressCb with this argument.
+ * @param {boolean?} options.isDryRun - Allows to simulate the execution of the reversion without any effects. Make sense to utilize onProgress with this argument.
  * @param {boolean?} options.ignoreLock - Won't lock the repo for reverting the migrations. Use with caution.
  * @param {array?} options.migrations - Array of migrations to migrate. If undefined, the bundled migrations are used. Mainly for testing purpose.
  * @returns {Promise<void>}
  */
-async function revert (path, toVersion, {ignoreLock=false, repoOptions, progressCb, isDryRun=false, migrations}) {
+async function revert (path, toVersion, {ignoreLock=false, repoOptions, onProgress, isDryRun=false, migrations}) {
   migrations = migrations || defaultMigrations
 
   if (!path) {
@@ -185,7 +185,7 @@ async function revert (path, toVersion, {ignoreLock=false, repoOptions, progress
         e.message = `During reversion to version ${migration.version} exception was raised: ${e.message}`
         throw e
       }
-      typeof progressCb === 'function' && progressCb(migration, counter, totalMigrations) // Reports on migration process
+      typeof onProgress === 'function' && onProgress(migration, counter, totalMigrations) // Reports on migration process
       log(`Reverting to version ${migration.version} finished`)
     }
 

test/index.spec.js

@@ -239,14 +239,14 @@ describe('index.js', () => {
 
     it('should report progress when progress callback is supplied', async () => {
       const options = createOptions()
-      options.progressCb = sinon.stub()
+      options.onProgress = sinon.stub()
       getVersionStub.returns(4)
 
       await expect(migrator.revert('/some/path', 2, options))
         .to.eventually.be.fulfilled()
 
-      expect(options.progressCb.getCall(0).calledWith(sinon.match.any, 1, 2)).to.be.true()
-      expect(options.progressCb.getCall(1).calledWith(sinon.match.any, 2, 2)).to.be.true()
+      expect(options.onProgress.getCall(0).calledWith(sinon.match.any, 1, 2)).to.be.true()
+      expect(options.onProgress.getCall(1).calledWith(sinon.match.any, 2, 2)).to.be.true()
     })
 
     it('should unlock repo when error is thrown', async () => {
@@ -364,14 +364,14 @@ describe('index.js', () => {
 
     it('should report progress when progress callback is supplied', async () => {
       const options = createOptions(4)
-      options.progressCb = sinon.stub()
+      options.onProgress = sinon.stub()
       getVersionStub.returns(2)
 
       await expect(migrator.migrate('/some/path', options))
         .to.eventually.be.fulfilled()
 
-      expect(options.progressCb.getCall(0).calledWith(sinon.match.any, 1, 2)).to.be.true()
-      expect(options.progressCb.getCall(1).calledWith(sinon.match.any, 2, 2)).to.be.true()
+      expect(options.onProgress.getCall(0).calledWith(sinon.match.any, 1, 2)).to.be.true()
+      expect(options.onProgress.getCall(1).calledWith(sinon.match.any, 2, 2)).to.be.true()
     })
 
     it('should unlock repo when error is thrown', async () => {