Store

Key-value store.

When to use

• Create a cache

• Share values between hooks

• Share values between hooks and UI context

The values aren't persisted when your plugin is reloaded.

How to use

Example

my-plugin.ts

// A simple plugin that shows how long scannig took.
function init() {
    $app.onScanCompleted((e) => {
        // Store the scanning duration (in ms)
        $store.set("scan-duration", e.duration)
        
        e.next()
    })
    
    $ui.register((ctx) => {
        // Callback is triggered when the value is updated
        $store.watch<number>("scan-duration", (value) => {
            if(!value) return
            
            ctx.toast.info(`Scanning took ${value/1000} seconds!`)
        })
        
        function getLatestScanDuration() {
            if (!$store.has("scan-duration")) {
                return 0
            }
            return $store.get<number>("scan-duration")
        }
    })
}

Store has a lot more functions that you can discover in the type definition file.