adds test, documentation and renames method parameter

sujeshthekkepatt · sujeshthekkepatt · commit 130776ceef49 · 2019-09-03T18:36:58.000+05:30
diff --git a/_src/lib/node_cache.coffee b/_src/lib/node_cache.coffee
@@ -206,6 +206,27 @@ module.exports = class NodeCache extends EventEmitter
 		# return true
 		return true
 	
+
+	# ## mset
+	#
+	# set multiple key,value and ttl
+	#
+	# **Parameters:**
+	#
+	# * `keyValueSet` ( Object[] ): an array of object which includes key,value and ttl
+	#
+	# **Example:**
+	#
+	#     myCache.mset([
+	#					{
+	#					key:"myKey",
+	#					val:"myValue"
+	#					ttl:[optionsl]
+	#					}
+	# 					])
+	#
+	#
+	
 	mset: ( keyValueSet ) =>
 		# check if cache is overflowing
 		if (@stats.keys + keyValueSet.length >= @options.maxKeys && @options.maxKeys > -1)
@@ -215,7 +236,7 @@ module.exports = class NodeCache extends EventEmitter
 		# loop over keyValueSet to validate key and ttl
 
 		for keyValuePair in keyValueSet
-			{ key, value, ttl } = keyValuePair
+			{ key, val, ttl } = keyValuePair
 
 			# check if there is ttl and it's a number
 			if ttl and typeof ttl isnt "number"
@@ -228,8 +249,8 @@ module.exports = class NodeCache extends EventEmitter
 				throw err
 
 		for keyValuePair in keyValueSet
-			{ key, value, ttl } = keyValuePair
-			@set(key, value, ttl)
+			{ key, val, ttl } = keyValuePair
+			@set(key, val, ttl)
 		return true
 
 	# ## del
@@ -635,4 +656,4 @@ module.exports = class NodeCache extends EventEmitter
 		"ECACHEFULL": "Cache max key size exceeded"
 		"EKEYTYPE": "The key argument has to be of type `string` or `number`. Found: `__key`"
 		"EKEYSTYPE": "The keys argument has to be an array."
-		"ETTLTYPE": "The ttl argument has to be an integer."
+		"ETTLTYPE": "The ttl argument has to be a number."
diff --git a/_src/test/mocha_test.coffee b/_src/test/mocha_test.coffee
@@ -34,6 +34,10 @@ localCacheNoDelete = new nodeCache({
 	deleteOnExpire: false
 })
 
+localCacheMset = new nodeCache({
+	stdTTL: 0
+})
+
 BENCH = {}
 
 # just for testing disable the check period
@@ -1107,5 +1111,68 @@ describe "`#{pkg.name}@#{pkg.version}` on `node@#{process.version}`", () ->
 			false.should.eql cachedRegex.test(noMatch)
 			return
 		return
+	
+	describe "mset", () ->
+		before () ->
+			state =
+				keyValueSet: [
+
+						key: randomString 10
+						val: randomString 10
+					,
+						key: randomString 10
+						val: randomString 10
+
+				]
+
+			return
+
+		it "mset an array of key value pairs", () ->
+			res = localCacheMset.mset state.keyValueSet
+			true.should.eql res
+			2.should.eql localCacheMset.getStats().keys
+			return
+		
+		it "mset - integer key", () ->
+			localCacheMset.flushAll()
+			state.keyValueSet[0].key = randomNumber 10
+			res = localCacheMset.mset state.keyValueSet
+			true.should.eql res
+			2.should.eql localCacheMset.getStats().keys
+			return
+		
+		it "mset - boolean key throw error", () ->
+			localCacheMset.flushAll()
+			state.keyValueSet[0].key = true
+
+			(() -> localCacheMset.mset(state.keyValueSet)).should.throw({
+					name: "EKEYTYPE"
+					message: "The key argument has to be of type `string` or `number`. Found: `boolean`"
+				})
+			return
+		
+		it "mset - object key throw error", () ->
+			localCacheMset.flushAll()
+			state.keyValueSet[0].key = { a: 1 }
+
+			(() -> localCacheMset.mset(state.keyValueSet)).should.throw({
+					name: "EKEYTYPE"
+					message: "The key argument has to be of type `string` or `number`. Found: `object`"
+				})
+			return
+
+		it "mset - ttl type error check", () ->
+			localCacheMset.flushAll()
+			state.keyValueSet[0].ttl = { a: 1 }
+
+			(() -> localCacheMset.mset(state.keyValueSet)).should.throw({
+					name: "ETTLTYPE"
+					message: "The ttl argument has to be a number."
+				})
+			return
+		
+
+
+		return
 
 	return
