Objet API

Découvrez l’objet API du déclencheur event-stream des Actions.

L’objet API du déclencheur event-stream des Actions comprend :

​

api.cache

Stockez et récupérez des données conservées entre les exécutions.

​

api.cache.delete(key)

Supprime l’enregistrement associé à la valeur mise en cache à la clé fournie, s’il existe.

Paramètres

Masquer Paramètres

key · string

La clé de l’enregistrement de cache à supprimer.

​

api.cache.get(key)

Récupère l’enregistrement associé à la valeur mise en cache sous la clé fournie, s’il existe. Si un enregistrement est trouvé, la valeur mise en cache se trouve dans la propriété value de l’objet renvoyé.

Paramètres

Masquer Paramètres

key · string

La clé de l’enregistrement stocké dans le cache.

​

api.cache.set(key, value, options)

Stocke ou met à jour une valeur de type chaîne dans le cache à la clé spécifiée.

Les valeurs stockées dans ce cache sont limitées au déclencheur dans lequel elles sont définies. Elles sont soumises aux limites du cache Actions.

Les valeurs stockées de cette façon auront une durée de vie pouvant atteindre les valeurs ttl ou expires_at spécifiées. Si aucune durée de vie n’est précisée, une durée de vie par défaut de 15 minutes est utilisée. Les durées de vie ne peuvent pas dépasser la durée maximale indiquée dans les limites du cache Actions.

Important : Ce cache est conçu pour des données éphémères de courte durée. Les éléments peuvent ne pas être disponibles dans des transactions ultérieures, même si leur durée de vie n’est pas encore écoulée.

Paramètres

Masquer Paramètres

key · string

La clé de l’enregistrement à stocker.

value · string

La valeur de l’enregistrement à stocker.

options · cachesetoptions

Options permettant d’ajuster le comportement du cache. Facultatif.

Afficher propriétés des options

expires_at · number

L’heure d’expiration absolue, en millisecondes depuis l’époque Unix. Bien que les enregistrements mis en cache puissent être évincés plus tôt, ils ne seront jamais conservés au-delà de la valeur expires_at fournie.

Remarque : Cette valeur ne doit pas être fournie si une valeur a également été fournie pour ttl. Si les deux options sont fournies, la date d’expiration la plus rapprochée sera utilisée. Facultatif.

ttl · number

La durée de vie de cette entrée de cache, en millisecondes. Bien que les valeurs mises en cache puissent être évincées plus tôt, elles ne seront jamais conservées au-delà de la valeur ttl fournie.

Remarque : Cette valeur ne doit pas être fournie si une valeur a également été fournie pour expires_at. Si les deux options sont fournies, la date d’expiration la plus rapprochée sera utilisée. Facultatif.