@nextcloud/initial-state
v2.2.0
Published
Access data from the nextcloud server-side initial state API within apps.
Downloads
28,254
Maintainers
Keywords
Readme
@nextcloud/initial-state
Access data from the server-side initial state API within apps.
Installation
npm install @nextcloud/initial-state --save
yarn add @nextcloud/initial-state
Usage
Check "Providing the initial state with PHP" for more details about initial state.
Note:
loadState
throws anError
if the key isn't found, hence you might want to wrap the call with atry
block.
import { loadState } from '@nextcloud/initial-state'
const val = loadState('myapp', 'user_preference')
// Provide a fallback value to return when the state is not found
const valWithFallback = loadState('myapp', 'user_preference', 'no_preference')
You can provide a type anotation for result.
import { loadState } from '@nextcloud/initial-state'
interface UserPreference {
refreshInterval: number
}
const val = loadState<UserPreference>('myapp', 'user_preference', {
refreshInterval: 15_000
})