.pullall - macmcmeans/localDataStorage GitHub Wiki

localDataStorage.pullall( arrayKeyName, value )

This method yanks all elements matching value from arrayKeyName, an existing Array Key, performing a destructive delete operation. A sparse array will not be returned. The data type of value must match.

EXAMPLE:

🔹 Existing Array Key called 'letters' having value ['a', 'aa', 'b', 'bb', 'a', 'c']:

Remove all elements having the value of 'a': ● localData.pullall( 'letters', 'a' ); --> ['aa', 'b', 'bb', 'c']

The value of the updated arrayKeyName is returned when this method executes.

🌐 This method may fire an event allowing you to monitor the key change.

📝 NOTE: This method is specific to Array Keys and will fail if used on any other key type. This method is related to pull. Array Keys use one-based array indices.