Subjects and events
puter.kv.del()
Websites Puter Apps Node.js Workers
When passed a key, will remove that key from the key-value storage. If there is no key with the given name in the key-value storage, nothing will happen.
Syntax
puter.kv.del(key)
puter.kv.del(key, optConfig)
Parameters
key (String) (required)
A string containing the name of the key you want to remove.
optConfig (Object) (optional)
KV sharing is in beta. Method shapes, limits, and behavior may change between releases.
The last argument. It takes these properties:
handle(String): Work on data another user shared with you, using thehandlefromputer.kv.listShared(). The key is then relative to the shared prefix. The share needswriteaccess. See Sharing with other users.appUuid(String): Work on another app's data, which the user let your app reach withputer.perms.request('appData', …). It can't be combined withhandle.
Return value
A Promise that will resolve to true when the key has been removed.
Errors
With handle, the promise can reject with these codes:
| Code | Meaning |
|---|---|
kv_handle_not_found |
handle doesn't exist, the share stopped, or it isn't shared with you. |
kv_handle_access_denied |
The share's access doesn't allow this method. |
kv_handle_option_invalid |
handle was combined with appUuid or disableSharing. |
kv_handle_key_invalid |
With handle, the key is empty or longer than 768 bytes. |
kv_handles_disabled |
Shares can't be used this way on this deployment. |
Examples
Delete the key 'name'
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<script>
(async () => {
// create a new key-value pair
await puter.kv.set('name', 'Puter Smith');
puter.print("Key-value pair 'name' created/updated<br>");
// delete the key 'name'
await puter.kv.del('name');
puter.print("Key-value pair 'name' deleted<br>");
// try to retrieve the value of key 'name'
const name = await puter.kv.get('name');
puter.print(`Name is now: ${name}`);
})();
</script>
</body>
</html>