Change case of "function"

This commit is contained in:
Schuyler Cebulskie
2016-11-12 21:07:22 -05:00
parent 90304aa7d6
commit b07a31d44e
4 changed files with 12 additions and 12 deletions

View File

@@ -22,8 +22,8 @@
"String": "string", "String": "string",
"Number": "number", "Number": "number",
"Boolean": "boolean", "Boolean": "boolean",
"Function": "function",
"object": "Object", "object": "Object",
"function": "Function",
"array": "Array", "array": "Array",
"date": "Date", "date": "Date",
"error": "Error" "error": "Error"

View File

@@ -337,7 +337,7 @@ class Client extends EventEmitter {
/** /**
* Sets a timeout that will be automatically cancelled if the client is destroyed. * Sets a timeout that will be automatically cancelled if the client is destroyed.
* @param {function} fn Function to execute * @param {Function} fn Function to execute
* @param {number} delay Time to wait before executing (in milliseconds) * @param {number} delay Time to wait before executing (in milliseconds)
* @param {args} args Arguments for the function (infinite/rest argument, not an array) * @param {args} args Arguments for the function (infinite/rest argument, not an array)
* @returns {Timeout} * @returns {Timeout}
@@ -362,7 +362,7 @@ class Client extends EventEmitter {
/** /**
* Sets an interval that will be automatically cancelled if the client is destroyed. * Sets an interval that will be automatically cancelled if the client is destroyed.
* @param {function} fn Function to execute * @param {Function} fn Function to execute
* @param {number} delay Time to wait before executing (in milliseconds) * @param {number} delay Time to wait before executing (in milliseconds)
* @param {args} args Arguments for the function (infinite/rest argument, not an array) * @param {args} args Arguments for the function (infinite/rest argument, not an array)
* @returns {Timeout} * @returns {Timeout}

View File

@@ -22,8 +22,8 @@ class ClientManager {
/** /**
* Connects the Client to the WebSocket * Connects the Client to the WebSocket
* @param {string} token The authorization token * @param {string} token The authorization token
* @param {function} resolve Function to run when connection is successful * @param {Function} resolve Function to run when connection is successful
* @param {function} reject Function to run when connection fails * @param {Function} reject Function to run when connection fails
*/ */
connectToWebSocket(token, resolve, reject) { connectToWebSocket(token, resolve, reject) {
this.client.emit(Constants.Events.DEBUG, `Authenticated using token ${token}`); this.client.emit(Constants.Events.DEBUG, `Authenticated using token ${token}`);

View File

@@ -127,7 +127,7 @@ class Collection extends Map {
* [Array.find()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find). * [Array.find()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find).
* <warn>Do not use this to obtain an item by its ID. Instead, use `collection.get(id)`. See * <warn>Do not use this to obtain an item by its ID. Instead, use `collection.get(id)`. See
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get) for details.</warn> * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get) for details.</warn>
* @param {string|function} propOrFn The property to test against, or the function to test with * @param {string|Function} propOrFn The property to test against, or the function to test with
* @param {*} [value] The expected value - only applicable and required if using a property for the first argument * @param {*} [value] The expected value - only applicable and required if using a property for the first argument
* @returns {*} * @returns {*}
* @example * @example
@@ -203,7 +203,7 @@ class Collection extends Map {
* Identical to * Identical to
* [Array.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter), * [Array.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter),
* but returns a Collection instead of an Array. * but returns a Collection instead of an Array.
* @param {function} fn Function used to test (should return a boolean) * @param {Function} fn Function used to test (should return a boolean)
* @param {Object} [thisArg] Value to use as `this` when executing function * @param {Object} [thisArg] Value to use as `this` when executing function
* @returns {Collection} * @returns {Collection}
*/ */
@@ -219,7 +219,7 @@ class Collection extends Map {
/** /**
* Identical to * Identical to
* [Array.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter). * [Array.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter).
* @param {function} fn Function used to test (should return a boolean) * @param {Function} fn Function used to test (should return a boolean)
* @param {Object} [thisArg] Value to use as `this` when executing function * @param {Object} [thisArg] Value to use as `this` when executing function
* @returns {Collection} * @returns {Collection}
*/ */
@@ -235,7 +235,7 @@ class Collection extends Map {
/** /**
* Identical to * Identical to
* [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map). * [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).
* @param {function} fn Function that produces an element of the new array, taking three arguments * @param {Function} fn Function that produces an element of the new array, taking three arguments
* @param {*} [thisArg] Value to use as `this` when executing function * @param {*} [thisArg] Value to use as `this` when executing function
* @returns {Array} * @returns {Array}
*/ */
@@ -250,7 +250,7 @@ class Collection extends Map {
/** /**
* Identical to * Identical to
* [Array.some()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some). * [Array.some()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some).
* @param {function} fn Function used to test (should return a boolean) * @param {Function} fn Function used to test (should return a boolean)
* @param {Object} [thisArg] Value to use as `this` when executing function * @param {Object} [thisArg] Value to use as `this` when executing function
* @returns {boolean} * @returns {boolean}
*/ */
@@ -265,7 +265,7 @@ class Collection extends Map {
/** /**
* Identical to * Identical to
* [Array.every()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every). * [Array.every()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every).
* @param {function} fn Function used to test (should return a boolean) * @param {Function} fn Function used to test (should return a boolean)
* @param {Object} [thisArg] Value to use as `this` when executing function * @param {Object} [thisArg] Value to use as `this` when executing function
* @returns {boolean} * @returns {boolean}
*/ */
@@ -280,7 +280,7 @@ class Collection extends Map {
/** /**
* Identical to * Identical to
* [Array.reduce()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce). * [Array.reduce()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce).
* @param {function} fn Function used to reduce * @param {Function} fn Function used to reduce
* @param {*} [startVal] The starting value * @param {*} [startVal] The starting value
* @returns {*} * @returns {*}
*/ */