Feat: Added onCharAppended support

Author: Jeecabs

README.md

@@ -1,3 +1,12 @@
+# Intention of this fork
+
+This fork is strictly exists to replicate the solution for:
+https://stackoverflow.com/questions/49291904/play-sound-at-each-char-with-typedjs
+
+Where a callback ("onCharAppended") is exposes for when each character is typed to allowing for playing a sound or other events on character typed.
+
+# Original Repo's Readme
+
 [![Build Status](https://travis-ci.org/mattboldt/typed.js.svg?branch=typed-2.0)](https://travis-ci.org/mattboldt/typed.js)
 [![Code Climate](https://codeclimate.com/github/mattboldt/typed.js/badges/gpa.svg)](https://codeclimate.com/github/mattboldt/typed.js)
 [![GitHub release](https://img.shields.io/github/release/mattboldt/typed.js.svg)]()
@@ -38,7 +47,7 @@ import Typed from 'typed.js';
 
 var options = {
   strings: ['<i>First</i> sentence.', '&amp; a second sentence.'],
-  typeSpeed: 40
+  typeSpeed: 40,
 };
 
 var typed = new Typed('.element', options);
@@ -116,7 +125,7 @@ You can pause in the middle of a string for a given amount of time by including
 ```javascript
 var typed = new Typed('.element', {
   // Waits 1000ms after typing "First"
-  strings: ['First ^1000 sentence.', 'Second sentence.']
+  strings: ['First ^1000 sentence.', 'Second sentence.'],
 });
 ```
 
@@ -127,7 +136,7 @@ In the following example, this would only backspace the words after "This is a"
 ```javascript
 var typed = new Typed('.element', {
   strings: ['This is a JavaScript library', 'This is an ES6 module'],
-  smartBackspace: true // Default value
+  smartBackspace: true, // Default value
 });
 ```
 
@@ -137,7 +146,7 @@ The following example would emulate how a terminal acts when typing a command an
 
 ```javascript
 var typed = new Typed('.element', {
-  strings: ['git push --force ^1000\n `pushed to origin with option force`']
+  strings: ['git push --force ^1000\n `pushed to origin with option force`'],
 });
 ```
 
@@ -167,7 +176,7 @@ var typed = new Typed('.element', {
     'These are the default values...',
     'You know what you should do?',
     'Use your own!',
-    'Have a great day!'
+    'Have a great day!',
   ],
   stringsElement: null,
 
@@ -312,7 +321,7 @@ var typed = new Typed('.element', {
    * After destroy
    * @param {Typed} self
    */
-  onDestroy: (self) => {}
+  onDestroy: (self) => {},
 });
 ```
 

index.d.ts

@@ -121,6 +121,8 @@ declare module 'typed.js' {
      * After destroy
      */
     onDestroy?(self: Typed): void;
+
+    onCharAppended: (char: string, self: Typed) => {};
   }
 
   export default class Typed {

src/defaults.js

@@ -92,73 +92,79 @@ const defaults = {
    * Before it begins typing
    * @param {Typed} self
    */
-  onBegin: (self) => {},
+  onBegin: (self) => { },
 
   /**
    * All typing is complete
    * @param {Typed} self
    */
-  onComplete: (self) => {},
+  onComplete: (self) => { },
 
   /**
    * Before each string is typed
    * @param {number} arrayPos
    * @param {Typed} self
    */
-  preStringTyped: (arrayPos, self) => {},
+  preStringTyped: (arrayPos, self) => { },
 
   /**
    * After each string is typed
    * @param {number} arrayPos
    * @param {Typed} self
    */
-  onStringTyped: (arrayPos, self) => {},
+  onStringTyped: (arrayPos, self) => { },
 
   /**
    * During looping, after last string is typed
    * @param {Typed} self
    */
-  onLastStringBackspaced: (self) => {},
+  onLastStringBackspaced: (self) => { },
 
   /**
    * Typing has been stopped
    * @param {number} arrayPos
    * @param {Typed} self
    */
-  onTypingPaused: (arrayPos, self) => {},
+  onTypingPaused: (arrayPos, self) => { },
 
   /**
    * Typing has been started after being stopped
    * @param {number} arrayPos
    * @param {Typed} self
    */
-  onTypingResumed: (arrayPos, self) => {},
+  onTypingResumed: (arrayPos, self) => { },
 
   /**
    * After reset
    * @param {Typed} self
    */
-  onReset: (self) => {},
+  onReset: (self) => { },
 
   /**
    * After stop
    * @param {number} arrayPos
    * @param {Typed} self
    */
-  onStop: (arrayPos, self) => {},
+  onStop: (arrayPos, self) => { },
 
   /**
    * After start
    * @param {number} arrayPos
    * @param {Typed} self
    */
-  onStart: (arrayPos, self) => {},
+  onStart: (arrayPos, self) => { },
 
   /**
    * After destroy
    * @param {Typed} self
    */
-  onDestroy: (self) => {}
+  onDestroy: (self) => { },
+  /**
+   * After a character has been appended.
+   * @param {*} char The character that has been appended
+   * @param {*} self 
+   */
+  onCharAppended: (char, self) =>  { },
 };
 
 export default defaults;

src/typed.js

@@ -187,6 +187,7 @@ export default class Typed {
 
       // humanized value for typing
     }, humanize);
+    this.options.onCharAppended(substr.charAt(0), this);
   }
 
   /**