.rename - macmcmeans/localDataStorage GitHub Wiki

localDataStorage.rename( existingKey, newKey )

This method assigns the value of existingKey to newKey, where the key prefix is prepended to newKey. The existingKey is deleted from the store. Data types are preserved, so if a Float was set then a Float will be returned.

If newKey already exists, an error will be thrown because existing keys cannot be overwritten.

EXAMPLES:

● localData.rename( 'key1', 'key1-1000' )

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

🏿 The corresponding Memory Key method is _rename.

📝 NOTE: There is nothing to prevent you, inadvertently or otherwise, from renaming an obfuscated key (created using safeset). Once renamed, it is not possible to retrieve the original protected value as the name of the key itself is part of the logic that creates the protection.