Removed deprecated peaks.ready event

Author: chrisn

doc/API.md

@@ -1523,20 +1523,6 @@ instance.destroy();
 
 The following sections describe the available events.
 
-## Initialization Events
-
-### `peaks.ready`
-
-This event is emitted during [`Peaks.init()`](#peaksinitoptions-callback) after the waveform has been loaded and initially rendered.
-
-```js
-instance.on('peaks.ready', function() {
-  console.log('Intialised');
-});
-```
-
-This event is deprecated. You should pass a callback function to [`Peaks.init()`](#peaksinitoptions-callback) to know when initialization is complete.
-
 ## Player Events
 
 ### `player.canplay`

src/main.js

@@ -343,14 +343,14 @@ function checkContainerElements(options) {
  */
 
 Peaks.init = function(opts, callback) {
+  if (!callback) {
+    throw new Error('Peaks.init(): Missing callback function');
+  }
+
   const instance = new Peaks();
 
   let err = instance._setOptions(opts);
 
-  if (!callback) {
-    instance._logger('Peaks.init(): Missing callback function');
-  }
-
   if (!err) {
     err = checkContainerElements(instance.options);
   }
@@ -399,20 +399,14 @@ Peaks.init = function(opts, callback) {
     .then(function() {
       instance._waveformBuilder.init(instance.options, function(err, waveformData) {
         if (err) {
-          if (callback) {
-            callback(err);
-          }
-
+          callback(err);
           return;
         }
 
         err = checkContainerElements(instance.options);
 
         if (err) {
-          if (callback) {
-            callback(err);
-          }
-
+          callback(err);
           return;
         }
 
@@ -446,22 +440,11 @@ Peaks.init = function(opts, callback) {
           instance._cueEmitter = new CueEmitter(instance);
         }
 
-        // Allow applications to attach event handlers before emitting events,
-        // when initialising with local waveform data.
-
-        setTimeout(function() {
-          instance.emit('peaks.ready');
-        }, 0);
-
-        if (callback) {
-          callback(null, instance);
-        }
+        callback(null, instance);
       });
     })
     .catch(function(err) {
-      if (callback) {
-        callback(err);
-      }
+      callback(err);
     });
 
   return instance;
@@ -615,14 +598,6 @@ Peaks.prototype.getWaveformData = function() {
   return this._waveformData;
 };
 
-Peaks.prototype.on = function(type, listener, options) {
-  if (type === 'peaks.ready') {
-    this._logger('Peaks.on(): The peaks.ready event is deprecated');
-  }
-
-  EventEmitter.prototype.on.call(this, type, listener, options);
-};
-
 /**
  * Cleans up a Peaks instance after use.
  */

test/api-spec.js

@@ -5,7 +5,6 @@ import WaveformZoomView from '../src/waveform-zoomview';
 
 import sampleJsonData from './data/sample.json';
 
-import WaveformData from 'waveform-data';
 import Konva from 'konva';
 
 const TestAudioContext = window.AudioContext || window.mozAudioContext || window.webkitAudioContext;
@@ -33,8 +32,8 @@ describe('Peaks', function() {
   });
 
   describe('init', function() {
-    context('with valid options', function() {
-      it('should invoke callback when initialised', function(done) {
+    it('should throw if called without a callback', function() {
+      expect(function() {
         Peaks.init({
           overview: {
             container: document.getElementById('overview-container')
@@ -44,17 +43,13 @@ describe('Peaks', function() {
           },
           mediaElement: document.getElementById('media'),
           dataUri: { arraybuffer: '/base/test/data/sample.dat' }
-        },
-        function(err, instance) {
-          expect(err).to.equal(null);
-          expect(instance).to.be.an.instanceOf(Peaks);
-          instance.destroy();
-          done();
         });
-      });
+      }).to.throw(Error, /callback/);
+    });
 
-      it('should return the peaks instance', function(done) {
-        const result = Peaks.init({
+    context('with valid options', function() {
+      it('should invoke callback when initialised', function(done) {
+        Peaks.init({
           overview: {
             container: document.getElementById('overview-container')
           },
@@ -67,62 +62,27 @@ describe('Peaks', function() {
         function(err, instance) {
           expect(err).to.equal(null);
           expect(instance).to.be.an.instanceOf(Peaks);
-          expect(result).to.equal(instance);
           instance.destroy();
           done();
         });
       });
 
-      it('should emit a peaks.ready event when initialised', function(done) {
-        const logger = sinon.spy();
-
-        Peaks.init({
+      it('should return the peaks instance', function(done) {
+        const result = Peaks.init({
           overview: {
             container: document.getElementById('overview-container')
           },
           zoomview: {
             container: document.getElementById('zoomview-container')
           },
           mediaElement: document.getElementById('media'),
-          dataUri: { arraybuffer: '/base/test/data/sample.dat' },
-          logger: logger
+          dataUri: { arraybuffer: '/base/test/data/sample.dat' }
         },
         function(err, instance) {
           expect(err).to.equal(null);
           expect(instance).to.be.an.instanceOf(Peaks);
-
-          instance.on('peaks.ready', function() {
-            expect(logger.callCount).to.equal(1);
-            expect(logger).calledWithMatch(/deprecated/);
-            expect(instance.getWaveformData()).to.be.an.instanceOf(WaveformData);
-            done();
-          });
-        });
-      });
-
-      it('should emit a peaks.ready event when initialised without a callback', function(done) {
-        const logger = sinon.spy();
-
-        const instance = Peaks.init({
-          overview: {
-            container: document.getElementById('overview-container')
-          },
-          zoomview: {
-            container: document.getElementById('zoomview-container')
-          },
-          mediaElement: document.getElementById('media'),
-          dataUri: { arraybuffer: '/base/test/data/sample.dat' },
-          logger: logger
-        });
-
-        expect(instance).to.be.an.instanceOf(Peaks);
-
-        expect(logger.callCount).to.equal(1);
-
-        instance.on('peaks.ready', function() {
-          expect(logger.callCount).to.equal(2);
-          expect(logger.getCall(0).args[0]).to.match(/callback/);
-          expect(logger.getCall(1).args[0]).to.match(/deprecated/);
+          expect(result).to.equal(instance);
+          instance.destroy();
           done();
         });
       });