Merged

nicjansma · nicjansma · commit d122e2ba2640 · 2017-07-24T11:03:55.000-04:00
diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,8 @@
 # Changelog
 
+### 1.2.0 (not yet released)
+* Fix various typos [#137](https://github.com/corejavascript/typeahead.js/pull/137)
+
 ### 1.1.1 January 12, 2017
 * Fix hiding of .visuallyhidden style (introduced in #104) [#107](https://github.com/corejavascript/typeahead.js/pull/107)
 
diff --git a/dist/bloodhound.js b/dist/bloodhound.js
@@ -4,12 +4,13 @@
  * Copyright 2013-2017 Twitter, Inc. and other contributors; Licensed MIT
  */
 
+
 (function(root, factory) {
     if (typeof define === "function" && define.amd) {
         define([ "jquery" ], function(a0) {
             return root["Bloodhound"] = factory(a0);
         });
-    } else if (typeof exports === "object") {
+    } else if (typeof module === "object" && module.exports) {
         module.exports = factory(require("jquery"));
     } else {
         root["Bloodhound"] = factory(root["jQuery"]);
@@ -774,7 +775,7 @@
             } else if (o.wildcard) {
                 prepare = prepareByWildcard;
             } else {
-                prepare = idenityPrepare;
+                prepare = identityPrepare;
             }
             return prepare;
             function prepareByReplace(query, settings) {
@@ -785,7 +786,7 @@
                 settings.url = settings.url.replace(wildcard, encodeURIComponent(query));
                 return settings;
             }
-            function idenityPrepare(query, settings) {
+            function identityPrepare(query, settings) {
                 return settings;
             }
         }
diff --git a/dist/bloodhound.min.js b/dist/bloodhound.min.js
diff --git a/dist/typeahead.bundle.js b/dist/typeahead.bundle.js
@@ -4,12 +4,13 @@
  * Copyright 2013-2017 Twitter, Inc. and other contributors; Licensed MIT
  */
 
+
 (function(root, factory) {
     if (typeof define === "function" && define.amd) {
         define([ "jquery" ], function(a0) {
             return root["Bloodhound"] = factory(a0);
         });
-    } else if (typeof exports === "object") {
+    } else if (typeof module === "object" && module.exports) {
         module.exports = factory(require("jquery"));
     } else {
         root["Bloodhound"] = factory(root["jQuery"]);
@@ -774,7 +775,7 @@
             } else if (o.wildcard) {
                 prepare = prepareByWildcard;
             } else {
-                prepare = idenityPrepare;
+                prepare = identityPrepare;
             }
             return prepare;
             function prepareByReplace(query, settings) {
@@ -785,7 +786,7 @@
                 settings.url = settings.url.replace(wildcard, encodeURIComponent(query));
                 return settings;
             }
-            function idenityPrepare(query, settings) {
+            function identityPrepare(query, settings) {
                 return settings;
             }
         }
@@ -956,7 +957,7 @@
         define([ "jquery" ], function(a0) {
             return factory(a0);
         });
-    } else if (typeof exports === "object") {
+    } else if (typeof module === "object" && module.exports) {
         module.exports = factory(require("jquery"));
     } else {
         factory(root["jQuery"]);
diff --git a/dist/typeahead.bundle.min.js b/dist/typeahead.bundle.min.js
diff --git a/dist/typeahead.jquery.js b/dist/typeahead.jquery.js
@@ -4,12 +4,13 @@
  * Copyright 2013-2017 Twitter, Inc. and other contributors; Licensed MIT
  */
 
+
 (function(root, factory) {
     if (typeof define === "function" && define.amd) {
         define([ "jquery" ], function(a0) {
             return factory(a0);
         });
-    } else if (typeof exports === "object") {
+    } else if (typeof module === "object" && module.exports) {
         module.exports = factory(require("jquery"));
     } else {
         factory(root["jQuery"]);
diff --git a/dist/typeahead.jquery.min.js b/dist/typeahead.jquery.min.js
diff --git a/doc/bloodhound.md b/doc/bloodhound.md
@@ -12,7 +12,7 @@ Table of Contents
 * [Usage](#usage)
   * [API](#api)
   * [Options](#options)
-  * [Tokenizers] (#tokenizers)
+  * [Tokenizers](#tokenizers)
   * [Prefetch](#prefetch)
   * [Remote](#remote)
 
@@ -297,6 +297,17 @@ When configuring `remote`, the following options are available.
    you to transform the remote response before the Bloodhound instance operates 
    on it. Defaults to the [identity function].
 
+* `transport` – A function with the signature `transport(options, onSuccess, onError)`
+  that allows you to specify a custom transport:
+  ```javascript
+  transport: function (options, onSuccess, onError) {
+    // Modify the options or replace the next line
+    $.ajax(options)
+      .done(function(data, textStatus, request) { onSuccess(data); })
+      .fail(function(request, textStatus, errorThrown) { onError(errorThrown); });
+  }
+  ```
+
 <!-- section links -->
 
 [identity function]: http://en.wikipedia.org/wiki/Identity_function
diff --git a/doc/jquery_typeahead.md b/doc/jquery_typeahead.md
@@ -155,7 +155,7 @@ Datasets can be configured using the following options.
 
 * `limit` – The max number of suggestions to be displayed. Defaults to `5`.
 
-* `display` – For a given suggestion, determines the string representation 
+* `display` | `displayKey` – For a given suggestion, determines the string representation 
   of it. This will be used when setting the value of the input control after a 
   suggestion is selected. Can be either a key string or a function that 
   transforms a suggestion object into a string. Defaults to stringifying the 
diff --git a/src/bloodhound/bloodhound.js b/src/bloodhound/bloodhound.js
@@ -33,7 +33,7 @@ var Bloodhound = (function() {
       queryTokenizer: o.queryTokenizer
     });
 
-    // hold off on intialization if the intialize option was explicitly false
+    // hold off on initialization if the initialize option was explicitly false
     o.initialize !== false && this.initialize();
   }
 
diff --git a/src/bloodhound/options_parser.js b/src/bloodhound/options_parser.js
@@ -131,7 +131,7 @@ var oParser = (function() {
     }
 
     else {
-      prepare = idenityPrepare;
+      prepare = identityPrepare;
     }
 
     return prepare;
@@ -146,7 +146,7 @@ var oParser = (function() {
       return settings;
     }
 
-    function idenityPrepare(query, settings) {
+    function identityPrepare(query, settings) {
       return settings;
     }
   }
diff --git a/src/typeahead/default_menu.js b/src/typeahead/default_menu.js
@@ -66,7 +66,7 @@ var DefaultMenu = (function() {
 
     _show: function show() {
       // can't use jQuery#show because $node is a span element we want
-      // display: block; not dislay: inline;
+      // display: block; not display: inline;
       this.$node.css('display', 'block');
     }
   });
diff --git a/src/typeahead/plugin.js b/src/typeahead/plugin.js
@@ -223,8 +223,8 @@
     .removeData()
     .css(www.css.hint)
     .css(getBackgroundStyles($input))
-    .prop('readonly', true)
-    .removeAttr('id name placeholder required')
+    .prop({ readonly: true, required: false })
+    .removeAttr('id name placeholder')
     .removeClass('required')
     .attr({ spellcheck: 'false', tabindex: -1 });
   }
diff --git a/src/typeahead/typeahead.js b/src/typeahead/typeahead.js
@@ -111,7 +111,7 @@ var Typeahead = (function() {
         if (_.isMsie() && (isActive || hasActive)) {
           $e.preventDefault();
           // stop immediate in order to prevent Input#_onBlur from
-          // getting exectued
+          // getting executed
           $e.stopImmediatePropagation();
           _.defer(function() { $input.focus(); });
         }
diff --git a/test/bloodhound/bloodhound_spec.js b/test/bloodhound/bloodhound_spec.js
@@ -24,7 +24,7 @@ describe('Bloodhound', function() {
       spyOn(this.bloodhound, '_initialize').andCallThrough();
     });
 
-    it('should not initialize if intialize option is false', function() {
+    it('should not initialize if initialize option is false', function() {
       expect(this.bloodhound._initialize).not.toHaveBeenCalled();
     });
 
@@ -38,7 +38,7 @@ describe('Bloodhound', function() {
       expect(this.bloodhound._initialize.callCount).toBe(1);
     });
 
-    it('should reinitialize if reintialize flag is true', function() {
+    it('should reinitialize if reinitialize flag is true', function() {
       var p1, p2;
 
       p1 = this.bloodhound.initialize();
diff --git a/test/bloodhound/options_parser_spec.js b/test/bloodhound/options_parser_spec.js
@@ -84,7 +84,7 @@ describe('options parser', function() {
       expect(o.prefetch.cache).toBe(true);
     });
 
-    it('should default transform to identiy function', function() {
+    it('should default transform to identity function', function() {
       var o = prefetch();
       expect(o.prefetch.transform('foo')).toBe('foo');
     });
@@ -99,7 +99,7 @@ describe('options parser', function() {
       expect(o.prefetch.transport).toBe($.ajax);
     });
 
-    it('should prepend verison to thumbprint', function() {
+    it('should prepend version to thumbprint', function() {
       var o = prefetch();
       expect(o.prefetch.thumbprint).toBe('%VERSION%');
 
@@ -137,7 +137,7 @@ describe('options parser', function() {
       expect(build({ remote: '/remote' }).remote).toBeDefined();
     });
 
-    it('should default transform to identiy function', function() {
+    it('should default transform to identity function', function() {
       var o = remote();
       expect(o.remote.transform('foo')).toBe('foo');
     });
@@ -147,7 +147,7 @@ describe('options parser', function() {
       expect(o.remote.transport).toBe($.ajax);
     });
 
-    it('should default limiter to debouce', function() {
+    it('should default limiter to debounce', function() {
       var o = remote();
       expect(o.remote.limiter.name).toBe('debounce');
     });
diff --git a/test/typeahead/dataset_spec.js b/test/typeahead/dataset_spec.js
@@ -104,7 +104,7 @@ describe('Dataset', function() {
       expect(this.dataset.$el).not.toContainText('one');
     });
 
-    it('should ignore subesequent invocations of sync', function() {
+    it('should ignore subsequent invocations of sync', function() {
       this.source.andCallFake(multipleSync);
       this.dataset.update('woah');
 
@@ -148,7 +148,7 @@ describe('Dataset', function() {
       expect(spy).not.toHaveBeenCalled();
     });
 
-    it('should trigger asyncCanceled when pending aysnc is canceled', function() {
+    it('should trigger asyncCanceled when pending async is canceled', function() {
       var spy = jasmine.createSpy();
 
       this.dataset.async = true;
@@ -182,7 +182,7 @@ describe('Dataset', function() {
       });
     });
 
-    it('should trigger asyncReceived when aysnc is received', function() {
+    it('should trigger asyncReceived when async is received', function() {
       var spy = jasmine.createSpy();
 
       this.dataset.async = true;
diff --git a/test/typeahead/input_spec.js b/test/typeahead/input_spec.js
@@ -145,13 +145,13 @@ describe('Input', function() {
       expect(spy).toHaveBeenCalled();
     });
 
-    it('should prevent default if no modifers were pressed', function() {
+    it('should prevent default if no modifiers were pressed', function() {
       var $e = simulateKeyEvent(this.$input, 'keydown', KEYS.up);
 
       expect($e.preventDefault).toHaveBeenCalled();
     });
 
-    it('should not prevent default if modifers were pressed', function() {
+    it('should not prevent default if modifiers were pressed', function() {
       var $e = simulateKeyEvent(this.$input, 'keydown', KEYS.up, true);
 
       expect($e.preventDefault).not.toHaveBeenCalled();
@@ -168,13 +168,13 @@ describe('Input', function() {
       expect(spy).toHaveBeenCalled();
     });
 
-    it('should prevent default if no modifers were pressed', function() {
+    it('should prevent default if no modifiers were pressed', function() {
       var $e = simulateKeyEvent(this.$input, 'keydown', KEYS.down);
 
       expect($e.preventDefault).toHaveBeenCalled();
     });
 
-    it('should not prevent default if modifers were pressed', function() {
+    it('should not prevent default if modifiers were pressed', function() {
       var $e = simulateKeyEvent(this.$input, 'keydown', KEYS.down, true);
 
       expect($e.preventDefault).not.toHaveBeenCalled();
diff --git a/test/typeahead/menu_spec.js b/test/typeahead/menu_spec.js
@@ -137,7 +137,7 @@ describe('Menu', function() {
     });
   });
 
-  describe('when asyncReceieved is triggered on a dataset', function() {
+  describe('when asyncReceived is triggered on a dataset', function() {
     it('should propagate event', function() {
       var spy = jasmine.createSpy();
 
diff --git a/test/typeahead/plugin_spec.js b/test/typeahead/plugin_spec.js
@@ -16,31 +16,31 @@ describe('$plugin', function() {
     });
   });
 
-  it('#enable should enable the typaahead', function() {
+  it('#enable should enable the typeahead', function() {
     this.$input.typeahead('disable');
     expect(this.$input.typeahead('isEnabled')).toBe(false);
 
     this.$input.typeahead('enable');
     expect(this.$input.typeahead('isEnabled')).toBe(true);
   });
 
-  it('#disable should disable the typaahead', function() {
+  it('#disable should disable the typeahead', function() {
     this.$input.typeahead('enable');
     expect(this.$input.typeahead('isEnabled')).toBe(true);
 
     this.$input.typeahead('disable');
     expect(this.$input.typeahead('isEnabled')).toBe(false);
   });
 
-  it('#activate should activate the typaahead', function() {
+  it('#activate should activate the typeahead', function() {
     this.$input.typeahead('deactivate');
     expect(this.$input.typeahead('isActive')).toBe(false);
 
     this.$input.typeahead('activate');
     expect(this.$input.typeahead('isActive')).toBe(true);
   });
 
-  it('#activate should fail to activate the typaahead if disabled', function() {
+  it('#activate should fail to activate the typeahead if disabled', function() {
     this.$input.typeahead('deactivate');
     expect(this.$input.typeahead('isActive')).toBe(false);
     this.$input.typeahead('disable');
@@ -49,7 +49,7 @@ describe('$plugin', function() {
     expect(this.$input.typeahead('isActive')).toBe(false);
   });
 
-  it('#deactivate should deactivate the typaahead', function() {
+  it('#deactivate should deactivate the typeahead', function() {
     this.$input.typeahead('activate');
     expect(this.$input.typeahead('isActive')).toBe(true);
 
diff --git a/test/typeahead/status_spec.js b/test/typeahead/status_spec.js
@@ -63,7 +63,7 @@ describe('Status', function() {
 
   });
 
-  describe('when cleaered is triggered on the datasets', function() {
+  describe('when cleared is triggered on the datasets', function() {
     it('should clear the status text on the suggestion', function() {
       status.$el.text('Text that will be cleared');
 
diff --git a/test/typeahead/typeahead_spec.js b/test/typeahead/typeahead_spec.js
@@ -354,7 +354,7 @@ describe('Typeahead', function() {
         expect(this.view.select).not.toHaveBeenCalledWith($el);
       });
 
-      it('should not prevent default if no active selectale', function() {
+      it('should not prevent default if no active selectable', function() {
         var $el;
 
         spyOn(this.view, 'select').andReturn(true);
@@ -430,7 +430,7 @@ describe('Typeahead', function() {
         expect(this.view.select).toHaveBeenCalledWith($el);
       });
 
-      it('should prevent default if active selectale', function() {
+      it('should prevent default if active selectable', function() {
         var $el;
 
         $el = $('<bah>');
@@ -453,7 +453,7 @@ describe('Typeahead', function() {
         expect(this.view.select).not.toHaveBeenCalledWith($el);
       });
 
-      it('should not prevent default if no active selectale', function() {
+      it('should not prevent default if no active selectable', function() {
         var $el;
 
         $el = $('<bah>');

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ var Bloodhound = (function() {`
`33`	`33`	`queryTokenizer: o.queryTokenizer`
`34`	`34`	`});`
`35`	`35`
`36`		`- // hold off on intialization if the intialize option was explicitly false`
	`36`	`+ // hold off on initialization if the initialize option was explicitly false`
`37`	`37`	`o.initialize !== false && this.initialize();`
`38`	`38`	`}`
`39`	`39`