Access data from the server-side initial state API within apps https://npmjs.org/@nextcloud/initial-state
83778c15db
--- updated-dependencies: - dependency-name: typescript dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> |
||
|---|---|---|
| .github | ||
| LICENSES | ||
| lib | ||
| test | ||
| .eslintrc.json | ||
| .gitignore | ||
| .npmignore | ||
| AUTHORS.md | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
| REUSE.toml | ||
| package-lock.json | ||
| package.json | ||
| tsconfig.json | ||
| vite.config.ts | ||
| vitest.config.ts | ||
README.md
@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:
loadStatethrows anErrorif the key isn't found, hence you might want to wrap the call with atryblock.
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
})