@fxtop/proxy
Version:
a lightweight web proxy tool based on Nodejs
41 lines (40 loc) • 1.3 kB
TypeScript
export interface Result {
error: number;
data?: any;
message?: string;
}
declare function getSystemName(): string;
declare const _default: {
/**
* Get System Name - 获取系统名称
*
* @return {String} sysName - 系统名称
*/
getSystemName: typeof getSystemName;
/**
* Trust Root Cert - 导入系统证书
* @param {string} [path] - 存放跟证书的绝对路径
* @returns {Promise} 导入结果
*/
trustRootCert(path?: string | undefined): Promise<Result>;
/**
* Start System Proxy - 启动系统代理
*
* @param {number} [port=8888] 代理服务监听端口
* @param {boolean} [isProxyHttps=false] 是否代理HTTPS服务
*
* @return {Promise} 启动系统代理结果
*
* @description 返回结果Promise中,error不为零,代表启动失败,可通过message查看失败原因。
*/
startSysProxy(port?: number, isProxyHttps?: boolean): Promise<Result>;
/**
* Stop System Proxy - 关闭系统代理
*
* @return {Promise} 关闭系统代理结果
*
* @description 返回结果Promise中,error不为零,代表关闭失败,可通过message查看失败原因。
*/
stopSysProxy(): Promise<Result>;
};
export default _default;