Skip to main content

StorageApi

Home > @backstage/core-plugin-api > StorageApi

Provides a key-value persistence API.

Signature:

export interface StorageApi 

Methods

MethodDescription
forBucket(name)Create a bucket to store data in.
observe$(key)Observe the value over time for a particular key in the current bucket.
remove(key)Remove persistent data.
set(key, data)Save persistent data, and emit messages to anyone that is using StorageApi.observe$() for this key.
snapshot(key)Returns an immediate snapshot value for the given key, if possible.