@bxjs/base/typings/controller/index.d.ts

import * as __F__ from 'lodash'

declare global {
    /**
     * 路由修饰符，用于定义entries相关入口文件的相关额外属性，方便自动化工具以及框架识别完成各种辅助操作。
     * name 路由名称
     * desc 路由描述
     * path 缺省文件相对路径路由格式的覆盖重写
     * noauth 该路由是否需要登录认证（缺省值为false需要登录认证）
     * nowrap 是否对于JSON请求进行success/content的标准进行包装（缺省值为false需要自动包装使用标准返回结构）
     *      如果nowrap为字符串类型，表示返回的是非json或html类型，而是用户指定的CONTENT-TYPE返回头类型。
     * crontab 定时器的定时时间配置  https://crontab.guru/
     *      * * * * *
     *  minute	0-59
     *  hour	0-23
     *  day of month 1-31
     *  month   1-12 (or names, see below)
     *  day of week	1-7 (1 monday，2 tuesday，... 5 friday, 6 is Saturday，7 is Sunday,)
     */
    function xroute(param?: {
        name?: string, desc?: string, path?: string,
        noauth?: boolean, nowrap?: boolean | string,
        crontab?: string
    }): Function

    function xredirect(url: string, param?: { [index: string]: any }): void

    class xuser {
        // 读取当前用户id与uuid（未登录返回空）
        static id: any
        static uuid: any

        // 业务层登录或登出需要调用一下进行正确的会话状态同步处理，具体的登录逻辑在业务层自己封装实现。支持mock自动用户登录配置简化开发调试。
        static login(user_id: integer_t, user_uuid: string_t): Promise<void>
        static logout(): Promise<void>

        static get(key: string, default_value?): Promise<any>
        static set(key: string, value): Promise<void>
    }

    class xcache {
        static get(key: string, default_value?): Promise<any>
        static set(key: string, value): Promise<void>
    }

    // 获取前端发布的着陆页html内容，id=git分组名/项目名，key为html页面名。
    function xhtml(id: string, key: string): Promise<string>
}