| code | type | title |
|---|---|---|
true |
page |
expireat |
Sets an expiration timestamp on a key. After the timestamp has been reached, the key will automatically be deleted.
expireat(key, timestamp, [options]);| Arguments | Type | Description |
|---|---|---|
key |
string |
Key |
timestamp |
integer |
Expiration timestamp (Epoch format) |
options |
object |
Optional query arguments |
The options arguments can contain the following option properties:
| Property | Type (default) | Description |
|---|---|---|
queuable |
boolean (true) |
If true, queues the request during downtime, until connected to Kuzzle again |
Resolves to a boolean telling whether the operation was successful or not.
<<< ./snippets/expireat.js