Class MetaStore

A dictionary that is available across your entire request, including across page naviagions.

Also if you choose outputAsJson:true (in IPageRequest), this dictionary will be in the JSON response output under content.automation.storage

Example

//store a value that can be read by other pages, and is also available in the response output
page.meta.store.set("answer",42);

Hierarchy

_PlatformObjBinding
- MetaStore

Index

Methods

delete get has set tryGet

Methods

delete

delete(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
boolean if the delete occured (false if key didn't exist)

get

get(key: string): Promise<any>
returns the value for the given key. returns undefined if the key doesn't exist
Parameters
- key: string
Returns Promise<any>

has

has(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
a boolean if the value exists

set

set(key: string, value: any): Promise<void>
store a key/value pair, overwriting any set previously
Parameters
- key: string
- value: any
Returns Promise<void>

tryGet

tryGet(key: string, defaultValue: any): Promise<any>
get a value if it exists, otherwise return a default value
Parameters
- key: string
- defaultValue: any
Returns Promise<any>