@yiero/gmlib
Version:
GM Lib for Tampermonkey/ScriptCat
46 lines (45 loc) • 2.2 kB
TypeScript
/**
* 通过 GM_xmlhttpRequest, 发送 GET 请求
*
* @param url 请求地址
* @param [method] 请求方式(GET)
* @param [param] 请求网页参数
* @param [GMXmlHttpRequestConfig] 油猴请求参数
*
* @warn 需要授权函数 `GM_xmlhttpRequest`
*
* @example gmRequest( 'https://baidu.com' ) - 请求网页内容
* @example gmRequest( 'https://api.bilibili.com/x/report/click/now' ) - 请求接口 JSON 内容
* @example gmRequest( 'https://api.bilibili.com/x/player/videoshot', 'GET', {aid: 999} - 携带网页参数请求
*
*
* @see https://www.tampermonkey.net/documentation.php?ext=dhdg#api:GM_xmlhttpRequest
*/
export declare function gmRequest<T extends string | Record<string, unknown> | Document>(url: string, method?: 'GET', param?: Record<string, string>, GMXmlHttpRequestConfig?: Partial<GMTypes.XHRDetails>): Promise<T>;
/**
* 通过 GM_xmlhttpRequest, 发送 POST 请求
*
* @param url 请求地址
* @param method 请求方式(POST)
* @param [data] 请求体参数
* @param [GMXmlHttpRequestConfig] 油猴请求参数
*
* @warn 需要授权函数 `GM_xmlhttpRequest`
*
* @example gmRequest( 'https://reqres.in/api/users', 'POST', {name: 'paul rudd',movies: [ 'I Love You Man', 'Role Models' ]} ) - 发送 POST 请求, 并携带数据
*
* @see https://www.tampermonkey.net/documentation.php?ext=dhdg#api:GM_xmlhttpRequest
*/
export declare function gmRequest<T extends string | Record<string, unknown> | Document, K>(url: string, method: 'POST', data?: Record<string, K>, GMXmlHttpRequestConfig?: Partial<GMTypes.XHRDetails>): Promise<T>;
/**
* 调用油猴API配置参数, 进行网络请求
*
* @param GMXmlHttpRequestConfig 油猴请求参数
*
* @warn 需要授权函数 `GM_xmlhttpRequest`
*
* @example gmRequest( {url: 'https://reqres.in/api/users',method: 'POST',name: 'paul rudd',movies: [ 'I Love You Man', 'Role Models' ],headers: {'Content-Type': 'application/json',}} ) - 发送 POST 请求
*
* @see https://www.tampermonkey.net/documentation.php?ext=dhdg#api:GM_xmlhttpRequest
*/
export declare function gmRequest<T extends string | Record<string, unknown> | Document>(GMXmlHttpRequestConfig: GMTypes.XHRDetails): Promise<T>;