[github/Chocobozzz/PeerTube.git] / shared / models / plugins / server / managers / plugin-settings-manager.model.ts

export type SettingValue = string | boolean

export interface SettingEntries {
  [settingName: string]: SettingValue
}

export type SettingsChangeCallback = (settings: SettingEntries) => Promise<any>

export interface PluginSettingsManager {
  getSetting: (name: string) => Promise<SettingValue>

  getSettings: (names: string[]) => Promise<SettingEntries>

  setSetting: (name: string, value: SettingValue) => Promise<any>

  onSettingsChange: (cb: SettingsChangeCallback) => void
}
Commit	Line	Data
	1	export type SettingValue = string \| boolean
	2
	3	export interface SettingEntries {
	4	[settingName: string]: SettingValue
	5	}
	6
	7	export type SettingsChangeCallback = (settings: SettingEntries) => Promise<any>
	8
	9	export interface PluginSettingsManager {
	10	getSetting: (name: string) => Promise<SettingValue>
	11
	12	getSettings: (names: string[]) => Promise<SettingEntries>
	13
	14	setSetting: (name: string, value: SettingValue) => Promise<any>
	15
	16	onSettingsChange: (cb: SettingsChangeCallback) => void
	17	}