Skip to content

Commit

Permalink
Docs: add mixin example
Browse files Browse the repository at this point in the history
  • Loading branch information
sleelin committed Jan 8, 2025
1 parent 2722ac0 commit 163c28e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions example/src/mixin.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/**
* This provides methods used for event handling. It's not meant to
* be used directly.
* @mixin
* @memberOf Geometry
*/
var Eventful = {
/**
* Register a handler function to be called whenever this event is fired.
* @param {string} eventName - Name of the event.
* @param {function(Object)} handler - The handler to call.
*/
on: function(eventName, handler) {
// code...
},

/**
* Fire an event, causing all handlers for that event name to run.
* @param {string} eventName - Name of the event.
* @param {Object} eventData - The data provided to each handler.
*/
fire: function(eventName, eventData) {
// code...
}
};

0 comments on commit 163c28e

Please # to comment.