Frodo Library - v4.0.0-29
    Preparing search index...

    Type Alias Theme

    type Theme = {
        createTheme(
            themeData: ThemeSkeleton,
            themeId?: string,
            realm?: string,
        ): Promise<ThemeSkeleton>;
        createThemeExportTemplate(): ThemeExportInterface;
        deleteTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
        deleteThemeByName(
            themeName: string,
            realm?: string,
        ): Promise<ThemeSkeleton>;
        deleteThemes(realm?: string): Promise<ThemeSkeleton[]>;
        exportThemes(): Promise<ThemeExportInterface>;
        importThemes(importData: ThemeExportInterface): Promise<ThemeSkeleton[]>;
        readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
        readThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
        readThemes(): Promise<ThemeSkeleton[]>;
        updateTheme(
            themeId: string,
            themeData: ThemeSkeleton,
            realm?: string,
        ): Promise<ThemeSkeleton>;
        updateThemeByName(
            themeName: string,
            themeData: ThemeSkeleton,
            realm?: string,
        ): Promise<ThemeSkeleton>;
        updateThemes(
            themeMap: Record<string, ThemeSkeleton>,
        ): Promise<Record<string, ThemeSkeleton>>;
    }
    Index

    Methods

    createTheme createThemeExportTemplate deleteTheme deleteThemeByName deleteThemes exportThemes importThemes readTheme readThemeByName readThemes updateTheme updateThemeByName updateThemes

    Methods

    • Delete theme by id

      Parameters

      • themeId: string

        theme id

      • Optionalrealm: string

        realm name

      Returns Promise<ThemeSkeleton>

      a promise that resolves to a themes object

    • Delete theme by name

      Parameters

      • themeName: string

        theme name

      • Optionalrealm: string

        realm name

      Returns Promise<ThemeSkeleton>

      a promise that resolves to a themes object

    • Read theme by id

      Parameters

      • themeId: string

        theme id

      • Optionalrealm: string

        realm name

      Returns Promise<ThemeSkeleton>

      a promise that resolves to a theme object

    • Read theme by name

      Parameters

      • themeName: string

        theme name

      • Optionalrealm: string

        realm name

      Returns Promise<ThemeSkeleton>

      a promise that resolves to a theme object

    • Update theme by name

      Parameters

      • themeName: string

        theme name

      • themeData: ThemeSkeleton

        theme object

      • Optionalrealm: string

        realm name

      Returns Promise<ThemeSkeleton>

      a promise that resolves to a theme object

    Settings

    Member Visibility

    On This Page

    Methods