puter.kv.expireAt()

Set the expiration timestamp (in seconds) for a key in the key-value store.

Syntax

puter.kv.expireAt(key, timestampSeconds)

Parameters

key (String) (required)

A string containing the name of the key.

timestampSeconds (Number) (required)

The Unix timestamp (in seconds) at which the key will be removed from the key-value store. Use seconds, not the milliseconds Date.now() returns. A timestamp at or before now, including 0, expires the key immediately.

Return value

A Promise that will resolve to true when the expiry time has been set.

Keys That Don't Exist

A missing or already-expired key becomes an empty entry with the TTL you gave it, rather than staying absent. puter.kv.list() shows it and puter.kv.get() reads it as null, the same as a missing key — the old value, if there was one, never comes back. puter.kv.incr() rejects such an entry, the same as any non-number value.

To remove a key's TTL instead of setting one, use puter.kv.set() or puter.kv.update() with a null TTL.

Examples

Retrieve the value of a key after it expires

<html>
<body>
    <script src="https://js.puter.com/v2/"></script>
    <script>
        (async () => {
            // (1) Create a new key-value pair
            await puter.kv.set('name', 'Puter Smith');
            puter.print("Key-value pair 'name' created/updated<br>");

            // (2) Set key to expire in 1 second
            await puter.kv.expireAt('name', (Date.now()/1000) + 1);
            
            // (3) Wait 2 seconds and get the value
            setTimeout(async () => {
                const name = await puter.kv.get('name');
                puter.print("Value :", name);
            }, 2000);
        })();
    </script>
</body>
</html>