neil/silverbullet
1
0
Fork 0
Code

Documentation for readSettings call

Browse Source
This commit is contained in:
Zef Hemel 2022-07-18 10:51:28 +02:00
parent c5ac6ea035
commit 3658bd46ec
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
packages/plugs/lib/settings_page.ts
View File

@ -1,5 +1,15 @@
import { readYamlPage } from "./yaml_page"; import { readYamlPage } from "./yaml_page";
/**
* Convenience function to read a specific set of settings from the `SETTINGS` page as well as default values
* in case they are not specified.
* Example: `await readSettings({showPreview: false})` will return an object like `{showPreview: false}` (or `true`)
* in case this setting is specifically set in the `SETTINGS` page.
*
* @param settings object with settings to fetch and their default values
* @returns an object with the same shape as `settings` but with non-default values override based on `SETTINGS`
*/
export async function readSettings<T extends object>(settings: T): Promise<T> { export async function readSettings<T extends object>(settings: T): Promise<T> {
try { try {
let allSettings = (await readYamlPage("SETTINGS", ["yaml"])) || {}; let allSettings = (await readYamlPage("SETTINGS", ["yaml"])) || {};