Documentation
    Preparing search index...

    Variable state

    state: {
        add_tenant: (t: string) => void;
        features: Readonly<
            {
                aggregation_query: true;
                api_view_route: true;
                async_validate: true;
                bootstrap5: true;
                capacitor: true;
                capacitor_version: 7;
                deep_public_plugin_serve: true;
                dynamic_auth_parameters: true;
                ellipsize: true;
                esm_plugins: true;
                fieldrepeats_in_field_attributes: true;
                file_fieldviews_cfg_workflows: true;
                get_view_goto: true;
                getrows_tree_field: true;
                json_state_query: true;
                list_builder: true;
                metadata: true;
                multitype_fieldviews: true;
                nested_fieldrepeats: true;
                no_plugin_fieldview_length_check: true;
                prefix_or_in_queries: true;
                public_user_role: 100;
                serve_static_dependencies: true;
                stringify_json_fields: true;
                table_create_callback: true;
                table_undo: true;
                version_plugin_serve_path: true;
                workflows: true;
            },
        >;
        get_other_domain_tenant: (hostname: string) => string;
        get_process_init_time: () => Date;
        getAllTenants: () => Record<string, State>;
        getApp__: () => (s: string) => string;
        getReq__: () => (s: string) => string;
        getRootState: () => State;
        getState: () => State | undefined;
        getTenant: (ten: string) => State;
        init_multi_tenant: (
            plugin_loader: (s: string) => Promise<void>,
            disableMigrate: boolean,
            tenantList: string[],
            setupMultiNodeListener: Function,
        ) => Promise<void>;
        process_send: (v: any) => void;
        restart_tenant: (plugin_loader: Function) => Promise<void>;
        set_tenant_base_url: (tenant_subdomain: string, value?: string) => void;
        State: typeof State;
    }

    Type Declaration

    • add_tenant: (t: string) => void

      Add tenant to State

    • features: Readonly<
          {
              aggregation_query: true;
              api_view_route: true;
              async_validate: true;
              bootstrap5: true;
              capacitor: true;
              capacitor_version: 7;
              deep_public_plugin_serve: true;
              dynamic_auth_parameters: true;
              ellipsize: true;
              esm_plugins: true;
              fieldrepeats_in_field_attributes: true;
              file_fieldviews_cfg_workflows: true;
              get_view_goto: true;
              getrows_tree_field: true;
              json_state_query: true;
              list_builder: true;
              metadata: true;
              multitype_fieldviews: true;
              nested_fieldrepeats: true;
              no_plugin_fieldview_length_check: true;
              prefix_or_in_queries: true;
              public_user_role: 100;
              serve_static_dependencies: true;
              stringify_json_fields: true;
              table_create_callback: true;
              table_undo: true;
              version_plugin_serve_path: true;
              workflows: true;
          },
      >

      State Features - Help modules figure out what features are available in core saltcorn. This is necessary because modules need to work on different versions of core saltcorn

    • get_other_domain_tenant: (hostname: string) => string

      Get tenant that has another domain (not subdomain)

    • get_process_init_time: () => Date

      Get Process Init Time - moment when Saltcorn process was initiated

    • getAllTenants: () => Record<string, State>

      Returns all Tenants (from State)

    • getApp__: () => (s: string) => string
    • getReq__: () => (s: string) => string
    • getRootState: () => State
    • FunctiongetState: () => State | undefined

      Get the state in the current tenant

    • getTenant: (ten: string) => State

      Get tenant from State

    • init_multi_tenant: (
          plugin_loader: (s: string) => Promise<void>,
          disableMigrate: boolean,
          tenantList: string[],
          setupMultiNodeListener: Function,
      ) => Promise<void>

      Switch to multi_tenant

    • process_send: (v: any) => void
    • restart_tenant: (plugin_loader: Function) => Promise<void>

      Restart tenant (means reload of plugins)

    • set_tenant_base_url: (tenant_subdomain: string, value?: string) => void

      Set tenant base url??? From my point of view it just add tenant to list of otherdomaintenant

    • State: typeof State

    Settings

    Member Visibility