Documentation
    Preparing search index...

    Variable configExportsConst

    configExports: {
        available_languages: {
            ar: string;
            bn: string;
            cs: string;
            da: string;
            de: string;
            el: string;
            en: string;
            es: string;
            et: string;
            fr: string;
            hi: string;
            id: string;
            it: string;
            ja: string;
            lt: string;
            lv: string;
            ne: string;
            nl: string;
            no: string;
            pl: string;
            pt: string;
            ru: string;
            si: string;
            sk: string;
            sl: string;
            sr: string;
            sv: string;
            th: string;
            tr: string;
            uk: string;
            zh: string;
        };
        check_email_mask: (email: string) => boolean;
        configTypes: ConfigTypes;
        deleteConfig: (key: string) => Promise<void>;
        get_base_url: (req?: Req) => string;
        get_latest_npm_version: (
            pkg: string,
            timeout_ms?: number,
        ) => Promise<string>;
        get_saltcorn_npm_versions: (timeout_ms?: number) => Promise<string[]>;
        getAllConfig: () => Promise<void | ConfigTypes>;
        getConfig: (key: string, def?: any) => Promise<any>;
        remove_from_menu: (item: RemoveFromMenuOpts) => Promise<void>;
        save_menu_items: (menu_items: any[]) => Promise<void>;
        setConfig: (key: string, value: any) => Promise<void>;
    } = ...

    Type Declaration

    • available_languages: {
          ar: string;
          bn: string;
          cs: string;
          da: string;
          de: string;
          el: string;
          en: string;
          es: string;
          et: string;
          fr: string;
          hi: string;
          id: string;
          it: string;
          ja: string;
          lt: string;
          lv: string;
          ne: string;
          nl: string;
          no: string;
          pl: string;
          pt: string;
          ru: string;
          si: string;
          sk: string;
          sl: string;
          sr: string;
          sv: string;
          th: string;
          tr: string;
          uk: string;
          zh: string;
      }
    • Functioncheck_email_mask: (email: string) => boolean

      Check email mask

    • NamespaceconfigTypes: ConfigTypes

      Config variables types

    • FunctiondeleteConfig: (key: string) => Promise<void>

      Delete config variable

    • get_base_url: (req?: Req) => string

      Get base url

    • get_latest_npm_version: (pkg: string, timeout_ms?: number) => Promise<string>

      Get latest npm version

    • get_saltcorn_npm_versions: (timeout_ms?: number) => Promise<string[]>
    • FunctiongetAllConfig: () => Promise<void | ConfigTypes>

      Get all config variables list

    • FunctiongetConfig: (key: string, def?: any) => Promise<any>

      Get Config variable value by key (contract)

    • Functionremove_from_menu: (item: RemoveFromMenuOpts) => Promise<void>

      Remove from menu

    • save_menu_items: (menu_items: any[]) => Promise<void>
    • FunctionsetConfig: (key: string, value: any) => Promise<void>

      Set config variable value by key

    Settings

    Member Visibility