chore: fix comment typos

joshuaslate · joshuaslate · commit e14ef07e9e6f · 2020-08-08T22:24:42.000Z
diff --git a/_src/lib/node_cache.coffee b/_src/lib/node_cache.coffee
@@ -94,7 +94,7 @@ module.exports = class NodeCache extends EventEmitter
 		if (err = @_isInvalidKey( key ))?
 			throw err
 
-		# get data and incremet stats
+		# get data and increment stats
 		if @data[ key ]? and @_check( key, @data[ key ] )
 			@stats.hits++
 			_ret = @_unwrap( @data[ key ] )
@@ -148,7 +148,7 @@ module.exports = class NodeCache extends EventEmitter
 	# **Parameters:**
 	#
 	# * `key` ( String | Number ): cache key
-	# * `value` ( Any ): A element to cache. If the option `option.forceString` is `true` the module trys to translate it to a serialized JSON
+	# * `value` ( Any ): An element to cache. If the option `option.forceString` is `true` the module trys to translate it to a serialized JSON
 	# * `[ ttl ]` ( Number | String ): ( optional ) The time to live in seconds.
 	#
 	# **Example:**
@@ -204,7 +204,7 @@ module.exports = class NodeCache extends EventEmitter
 	#
 	# **Parameters:**
 	#
-	# * `keyValueSet` ( Object[] ): an array of object which includes key,value and ttl
+	# * `keyValueSet` ( Object[] ): an array of objects which include key, value, and ttl
 	#
 	# **Example:**
 	#
@@ -251,7 +251,7 @@ module.exports = class NodeCache extends EventEmitter
 	#
 	# **Parameters:**
 	#
-	# * `keys` ( String | Number | String|Number[] ): cache key to delete or a array of cache keys
+	# * `keys` ( String | Number | String|Number[] ): cache key to delete or an array of cache keys
 	#
 	# **Return**
 	#
@@ -357,7 +357,7 @@ module.exports = class NodeCache extends EventEmitter
 	#
 	# **Parameters:**
 	#
-	# * `key` ( String | Number ): cache key to check the ttl value
+	# * `key` ( String | Number ): cache key to check the ttl value of
 	#
 	# **Return**
 	#

Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ module.exports = class NodeCache extends EventEmitter`
`94`	`94`	`if (err = @_isInvalidKey( key ))?`
`95`	`95`	`throw err`
`96`	`96`
`97`		`- # get data and incremet stats`
	`97`	`+ # get data and increment stats`
`98`	`98`	`if @data[ key ]? and @_check( key, @data[ key ] )`
`99`	`99`	`@stats.hits++`
`100`	`100`	`_ret = @_unwrap( @data[ key ] )`
`@@ -148,7 +148,7 @@ module.exports = class NodeCache extends EventEmitter`
`148`	`148`	`# Parameters:`
`149`	`149`	`#`
`150`	`150`	# * `key` ( String \| Number ): cache key
`151`		- # * `value` ( Any ): A element to cache. If the option `option.forceString` is `true` the module trys to translate it to a serialized JSON
	`151`	+ # * `value` ( Any ): An element to cache. If the option `option.forceString` is `true` the module trys to translate it to a serialized JSON
`152`	`152`	# * `[ ttl ]` ( Number \| String ): ( optional ) The time to live in seconds.
`153`	`153`	`#`
`154`	`154`	`# Example:`
`@@ -204,7 +204,7 @@ module.exports = class NodeCache extends EventEmitter`
`204`	`204`	`#`
`205`	`205`	`# Parameters:`
`206`	`206`	`#`
`207`		- # * `keyValueSet` ( Object[] ): an array of object which includes key,value and ttl
	`207`	+ # * `keyValueSet` ( Object[] ): an array of objects which include key, value, and ttl
`208`	`208`	`#`
`209`	`209`	`# Example:`
`210`	`210`	`#`
`@@ -251,7 +251,7 @@ module.exports = class NodeCache extends EventEmitter`
`251`	`251`	`#`
`252`	`252`	`# Parameters:`
`253`	`253`	`#`
`254`		- # * `keys` ( String \| Number \| String\|Number[] ): cache key to delete or a array of cache keys
	`254`	+ # * `keys` ( String \| Number \| String\|Number[] ): cache key to delete or an array of cache keys
`255`	`255`	`#`
`256`	`256`	`# Return`
`257`	`257`	`#`
`@@ -357,7 +357,7 @@ module.exports = class NodeCache extends EventEmitter`
`357`	`357`	`#`
`358`	`358`	`# Parameters:`
`359`	`359`	`#`
`360`		- # * `key` ( String \| Number ): cache key to check the ttl value
	`360`	+ # * `key` ( String \| Number ): cache key to check the ttl value of
`361`	`361`	`#`
`362`	`362`	`# Return`
`363`	`363`	`#`