KeyValueBasedCollection

Methods for key-value-based collections.

set(key, value)

Set a value.

Parameter	Description
key	String | Number Key to value.
value	String | Number | Object | Array Your data to set.

returns String | Number | Object | Array

Example:

user_settings.set("USER_1", {"friend_requests": true});
/*
  {
    "friend_requests": true
  }
*/

get(key)

Get a value.

Parameter	Description
key	String | Number Key to value.

returns String | Number | Object | Array

Example:

user_settings.get("USER_1.friend_requests"); // -> true

push(key, data)

Push a data to array.

Parameter	Description
key	String | Number Key to value.
data	String | Number | Object | Array Data to be push to the array.

returns Array

Example:

user_settings.push("USER_1.friends", "USER_2");
/*
  [
    "USER_2"
  ]
*/

remove(key, data)

Remove a data from array.

Parameter	Description
key	String | Number Key to value.
data	String | Number | Object | Array Data to be remove from the array.

returns Array

Example:

user_settings.remove("USER_1.friends", "USER_2");
/*
  []
*/

find(key, params)

Find a data from array.

Parameter	Description
key	String | Number Key to value.
params	Function | Object The parameters you will use to find the data.

returns Object

Example:

user_settings.find("USER_1.social_media_addresses", data => data.platform === "Instagram");
// or
user_settings.find("USER_1.social_media_addresses", {"platform": "Instagram"});
/*
  {
    "platform": "Instagram",
    "username": "fir4tozden"
  }
*/

filter(key, params)

Filter data from array.

Parameter	Description
key	String | Number Key to value.
params	Function | Object The parameters you will use to filter the data.

returns Array

Example:

user_settings.filter("USER_1.social_media_addresses", data => data.username === "fir4tozden");
// or
user_settings.filter("USER_1.social_media_addresses", {"username": "fir4tozden"});
/*
  [
    {
      "platform": "Instagram",
      "username": "fir4tozden"
    },
    {
      "platform": "Twitter",
      "username": "fir4tozden"
    }
  ]
*/

has(key, params)

Check if they have key or data.

Parameter	Description
key	String | Number Key to value.
params	Function | Object | String | Number (optional) The parameters you will use to check the data.

returns Boolean

Example:

user_settings.has("USER_1.hobbies"); // -> true
user_settings.has("USER_1.hobbies", data => data === "Watching TV"); // -> false
user_settings.has("USER_1.hobbies", "Watching TV"); // -> false
user_settings.has("USER_1.social_media_addresses", {"platform": "Instagram"}); // -> true

increase(key, value)

Increase the number in the value.

Parameter	Description
key	String | Number Key to value.
value	Number The number to be incremented.

returns Number

Example:

user_settings.increase("USER_1.age", 15); // -> 15
user_settings.increase("USER_1.age", 1); // -> 16

decrease(key, value)

Decrease the number in the value.

Parameter	Description
key	String | Number Key to value.
value	Number The number to be decremented.

returns Number

Example:

user_settings.decrease("USER_1.age", 5); // -> 11

delete(key)

Delete a key.

Parameter	Description
key	String | Number Key to value.

returns Number

Example:

user_settings.delete("USER_1.age"); // -> true