External module "core/settings"

Index

Type aliases

DefaultValueEval

Functions

Type aliases

DefaultValueEval

DefaultValueEval: function

Type declaration

- (): string
- Returns string

Functions

find

find(key: any, defaultValue?: string | DefaultValueEval): Promise<string>

- Defined in core/settings.ts:29
Fetches a Setting and returns its value.

Parameters
- key: any
  
  Key
- Optional defaultValue: string | DefaultValueEval
Returns Promise<string>

findArticlesSidebar

findArticlesSidebar(category: "about" | "docs"): Promise<object[]>

- Defined in core/settings.ts:52
Parameters
- category: "about" | "docs"
Returns Promise<object[]>

findNumber

findNumber(key: string, defaultValue: number): Promise<number>

- Defined in core/settings.ts:47
Parameters
- key: string
- defaultValue: number
Returns Promise<number>

save

save(key: any, value: any): Promise<void>

- Defined in core/settings.ts:76
Sets a Setting value.

Parameters
- key: any
  
  Key
- value: any
  
  The new value
Returns Promise<void>

Generated using TypeDoc