2024-06-15 13:02:35 +08:00
/* tslint:disable */
/* eslint-disable */
/ * *
* Admin . NET 通 用 权 限 开 发 平 台
* 让 . NET 开 发 更 简 单 、 更 通 用 、 更 流 行 。 整 合 最 新 技 术 , 模 块 插 件 式 开 发 , 前 后 端 分 离 , 开 箱 即 用 。 < br / > < u > < b > < font color = 'FF0000' > 👮 不 得 利 用 本 项 目 从 事 危 害 国 家 安 全 、 扰 乱 社 会 秩 序 、 侵 犯 他 人 合 法 权 益 等 法 律 法 规 禁 止 的 活 动 ! 任 何 基 于 本 项 目 二 次 开 发 而 产 生 的 一 切 法 律 纠 纷 和 责 任 , 我 们 不 承 担 任 何 责 任 ! < / font > < / b > < / u >
*
* OpenAPI spec version : 1.0.0
*
*
* NOTE : This class is auto generated by the swagger code generator program .
* https : //github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually .
* /
import globalAxios , { AxiosResponse , AxiosInstance , AxiosRequestConfig } from 'axios' ;
import { Configuration } from '../configuration' ;
// Some imports not used depending on template conditions
// @ts-ignore
import { BASE_PATH , COLLECTION_FORMATS , RequestArgs , BaseAPI , RequiredError } from '../base' ;
2024-08-14 02:51:40 +08:00
import { AdminResultIDisposable } from '../models' ;
2024-06-15 13:02:35 +08:00
import { AdminResultInt32 } from '../models' ;
import { AdminResultListString } from '../models' ;
import { AdminResultObject } from '../models' ;
/ * *
* SysCacheApi - axios parameter creator
* @export
* /
export const SysCacheApiAxiosParamCreator = function ( configuration? : Configuration ) {
return {
2024-08-14 02:51:40 +08:00
/ * *
*
* @summary 申 请 分 布 式 锁
* @param { string } key 要 锁 定 的 key
* @param { number } msTimeout 申 请 锁 等 待 的 时 间 , 单 位 毫 秒
* @param { number } msExpire 锁 过 期 时 间 , 超 过 该 时 间 没 有 主 动 是 放 则 自 动 是 放 , 必 须 整 数 秒 , 单 位 毫 秒
* @param { boolean } throwOnFailure 失 败 时 是 否 抛 出 异 常 , 如 不 抛 出 异 常 , 可 通 过 判 断 返 回 null得知申请锁失败
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost : async ( key : string , msTimeout : number , msExpire : number , throwOnFailure : boolean , options : AxiosRequestConfig = { } ) : Promise < RequestArgs > = > {
// verify required parameter 'key' is not null or undefined
if ( key === null || key === undefined ) {
throw new RequiredError ( 'key' , 'Required parameter key was null or undefined when calling apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost.' ) ;
}
// verify required parameter 'msTimeout' is not null or undefined
if ( msTimeout === null || msTimeout === undefined ) {
throw new RequiredError ( 'msTimeout' , 'Required parameter msTimeout was null or undefined when calling apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost.' ) ;
}
// verify required parameter 'msExpire' is not null or undefined
if ( msExpire === null || msExpire === undefined ) {
throw new RequiredError ( 'msExpire' , 'Required parameter msExpire was null or undefined when calling apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost.' ) ;
}
// verify required parameter 'throwOnFailure' is not null or undefined
if ( throwOnFailure === null || throwOnFailure === undefined ) {
throw new RequiredError ( 'throwOnFailure' , 'Required parameter throwOnFailure was null or undefined when calling apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost.' ) ;
}
const localVarPath = ` /api/sysCache/beginCacheLock/{key}/{msTimeout}/{msExpire}/{throwOnFailure} `
. replace ( ` { ${ "key" } } ` , encodeURIComponent ( String ( key ) ) )
. replace ( ` { ${ "msTimeout" } } ` , encodeURIComponent ( String ( msTimeout ) ) )
. replace ( ` { ${ "msExpire" } } ` , encodeURIComponent ( String ( msExpire ) ) )
. replace ( ` { ${ "throwOnFailure" } } ` , encodeURIComponent ( String ( throwOnFailure ) ) ) ;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL ( localVarPath , 'https://example.com' ) ;
let baseOptions ;
if ( configuration ) {
baseOptions = configuration . baseOptions ;
}
const localVarRequestOptions :AxiosRequestConfig = { method : 'POST' , . . . baseOptions , . . . options } ;
const localVarHeaderParameter = { } as any ;
const localVarQueryParameter = { } as any ;
// authentication Bearer required
// http bearer authentication required
if ( configuration && configuration . accessToken ) {
const accessToken = typeof configuration . accessToken === 'function'
? await configuration . accessToken ( )
: await configuration . accessToken ;
localVarHeaderParameter [ "Authorization" ] = "Bearer " + accessToken ;
}
const query = new URLSearchParams ( localVarUrlObj . search ) ;
for ( const key in localVarQueryParameter ) {
query . set ( key , localVarQueryParameter [ key ] ) ;
}
for ( const key in options . params ) {
query . set ( key , options . params [ key ] ) ;
}
localVarUrlObj . search = ( new URLSearchParams ( query ) ) . toString ( ) ;
let headersFromBaseOptions = baseOptions && baseOptions . headers ? baseOptions . headers : { } ;
localVarRequestOptions . headers = { . . . localVarHeaderParameter , . . . headersFromBaseOptions , . . . options . headers } ;
return {
url : localVarUrlObj.pathname + localVarUrlObj . search + localVarUrlObj . hash ,
options : localVarRequestOptions ,
} ;
} ,
2024-08-13 00:55:21 +08:00
/ * *
*
* @summary 清 空 所 有 缓 存 🔖
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
2024-08-15 02:25:00 +08:00
apiSysCacheClearPost : async ( options : AxiosRequestConfig = { } ) : Promise < RequestArgs > = > {
2024-08-13 00:55:21 +08:00
const localVarPath = ` /api/sysCache/clear ` ;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL ( localVarPath , 'https://example.com' ) ;
let baseOptions ;
if ( configuration ) {
baseOptions = configuration . baseOptions ;
}
2024-08-15 02:25:00 +08:00
const localVarRequestOptions :AxiosRequestConfig = { method : 'POST' , . . . baseOptions , . . . options } ;
2024-08-13 00:55:21 +08:00
const localVarHeaderParameter = { } as any ;
const localVarQueryParameter = { } as any ;
// authentication Bearer required
// http bearer authentication required
if ( configuration && configuration . accessToken ) {
const accessToken = typeof configuration . accessToken === 'function'
? await configuration . accessToken ( )
: await configuration . accessToken ;
localVarHeaderParameter [ "Authorization" ] = "Bearer " + accessToken ;
}
const query = new URLSearchParams ( localVarUrlObj . search ) ;
for ( const key in localVarQueryParameter ) {
query . set ( key , localVarQueryParameter [ key ] ) ;
}
for ( const key in options . params ) {
query . set ( key , options . params [ key ] ) ;
}
localVarUrlObj . search = ( new URLSearchParams ( query ) ) . toString ( ) ;
let headersFromBaseOptions = baseOptions && baseOptions . headers ? baseOptions . headers : { } ;
localVarRequestOptions . headers = { . . . localVarHeaderParameter , . . . headersFromBaseOptions , . . . options . headers } ;
return {
url : localVarUrlObj.pathname + localVarUrlObj . search + localVarUrlObj . hash ,
options : localVarRequestOptions ,
} ;
} ,
2024-06-15 13:02:35 +08:00
/ * *
*
* @summary 根 据 键 名 前 缀 删 除 缓 存 🔖
* @param { string } prefixKey 键 名 前 缀
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
apiSysCacheDeleteByPreKeyPrefixKeyPost : async ( prefixKey : string , options : AxiosRequestConfig = { } ) : Promise < RequestArgs > = > {
// verify required parameter 'prefixKey' is not null or undefined
if ( prefixKey === null || prefixKey === undefined ) {
throw new RequiredError ( 'prefixKey' , 'Required parameter prefixKey was null or undefined when calling apiSysCacheDeleteByPreKeyPrefixKeyPost.' ) ;
}
const localVarPath = ` /api/sysCache/deleteByPreKey/{prefixKey} `
. replace ( ` { ${ "prefixKey" } } ` , encodeURIComponent ( String ( prefixKey ) ) ) ;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL ( localVarPath , 'https://example.com' ) ;
let baseOptions ;
if ( configuration ) {
baseOptions = configuration . baseOptions ;
}
const localVarRequestOptions :AxiosRequestConfig = { method : 'POST' , . . . baseOptions , . . . options } ;
const localVarHeaderParameter = { } as any ;
const localVarQueryParameter = { } as any ;
// authentication Bearer required
// http bearer authentication required
if ( configuration && configuration . accessToken ) {
const accessToken = typeof configuration . accessToken === 'function'
? await configuration . accessToken ( )
: await configuration . accessToken ;
localVarHeaderParameter [ "Authorization" ] = "Bearer " + accessToken ;
}
const query = new URLSearchParams ( localVarUrlObj . search ) ;
for ( const key in localVarQueryParameter ) {
query . set ( key , localVarQueryParameter [ key ] ) ;
}
for ( const key in options . params ) {
query . set ( key , options . params [ key ] ) ;
}
localVarUrlObj . search = ( new URLSearchParams ( query ) ) . toString ( ) ;
let headersFromBaseOptions = baseOptions && baseOptions . headers ? baseOptions . headers : { } ;
localVarRequestOptions . headers = { . . . localVarHeaderParameter , . . . headersFromBaseOptions , . . . options . headers } ;
return {
url : localVarUrlObj.pathname + localVarUrlObj . search + localVarUrlObj . hash ,
options : localVarRequestOptions ,
} ;
} ,
/ * *
*
* @summary 删 除 缓 存 🔖
* @param { string } key
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
apiSysCacheDeleteKeyPost : async ( key : string , options : AxiosRequestConfig = { } ) : Promise < RequestArgs > = > {
// verify required parameter 'key' is not null or undefined
if ( key === null || key === undefined ) {
throw new RequiredError ( 'key' , 'Required parameter key was null or undefined when calling apiSysCacheDeleteKeyPost.' ) ;
}
const localVarPath = ` /api/sysCache/delete/{key} `
. replace ( ` { ${ "key" } } ` , encodeURIComponent ( String ( key ) ) ) ;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL ( localVarPath , 'https://example.com' ) ;
let baseOptions ;
if ( configuration ) {
baseOptions = configuration . baseOptions ;
}
const localVarRequestOptions :AxiosRequestConfig = { method : 'POST' , . . . baseOptions , . . . options } ;
const localVarHeaderParameter = { } as any ;
const localVarQueryParameter = { } as any ;
// authentication Bearer required
// http bearer authentication required
if ( configuration && configuration . accessToken ) {
const accessToken = typeof configuration . accessToken === 'function'
? await configuration . accessToken ( )
: await configuration . accessToken ;
localVarHeaderParameter [ "Authorization" ] = "Bearer " + accessToken ;
}
const query = new URLSearchParams ( localVarUrlObj . search ) ;
for ( const key in localVarQueryParameter ) {
query . set ( key , localVarQueryParameter [ key ] ) ;
}
for ( const key in options . params ) {
query . set ( key , options . params [ key ] ) ;
}
localVarUrlObj . search = ( new URLSearchParams ( query ) ) . toString ( ) ;
let headersFromBaseOptions = baseOptions && baseOptions . headers ? baseOptions . headers : { } ;
localVarRequestOptions . headers = { . . . localVarHeaderParameter , . . . headersFromBaseOptions , . . . options . headers } ;
return {
url : localVarUrlObj.pathname + localVarUrlObj . search + localVarUrlObj . hash ,
options : localVarRequestOptions ,
} ;
} ,
/ * *
*
* @summary 获 取 缓 存 键 名 集 合 🔖
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
apiSysCacheKeyListGet : async ( options : AxiosRequestConfig = { } ) : Promise < RequestArgs > = > {
const localVarPath = ` /api/sysCache/keyList ` ;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL ( localVarPath , 'https://example.com' ) ;
let baseOptions ;
if ( configuration ) {
baseOptions = configuration . baseOptions ;
}
const localVarRequestOptions :AxiosRequestConfig = { method : 'GET' , . . . baseOptions , . . . options } ;
const localVarHeaderParameter = { } as any ;
const localVarQueryParameter = { } as any ;
// authentication Bearer required
// http bearer authentication required
if ( configuration && configuration . accessToken ) {
const accessToken = typeof configuration . accessToken === 'function'
? await configuration . accessToken ( )
: await configuration . accessToken ;
localVarHeaderParameter [ "Authorization" ] = "Bearer " + accessToken ;
}
const query = new URLSearchParams ( localVarUrlObj . search ) ;
for ( const key in localVarQueryParameter ) {
query . set ( key , localVarQueryParameter [ key ] ) ;
}
for ( const key in options . params ) {
query . set ( key , options . params [ key ] ) ;
}
localVarUrlObj . search = ( new URLSearchParams ( query ) ) . toString ( ) ;
let headersFromBaseOptions = baseOptions && baseOptions . headers ? baseOptions . headers : { } ;
localVarRequestOptions . headers = { . . . localVarHeaderParameter , . . . headersFromBaseOptions , . . . options . headers } ;
return {
url : localVarUrlObj.pathname + localVarUrlObj . search + localVarUrlObj . hash ,
options : localVarRequestOptions ,
} ;
} ,
/ * *
*
* @summary 根 据 键 名 前 缀 获 取 键 名 集 合 🔖
* @param { string } prefixKey 键 名 前 缀
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
apiSysCacheKeysByPrefixKeyPrefixKeyGet : async ( prefixKey : string , options : AxiosRequestConfig = { } ) : Promise < RequestArgs > = > {
// verify required parameter 'prefixKey' is not null or undefined
if ( prefixKey === null || prefixKey === undefined ) {
throw new RequiredError ( 'prefixKey' , 'Required parameter prefixKey was null or undefined when calling apiSysCacheKeysByPrefixKeyPrefixKeyGet.' ) ;
}
const localVarPath = ` /api/sysCache/keysByPrefixKey/{prefixKey} `
. replace ( ` { ${ "prefixKey" } } ` , encodeURIComponent ( String ( prefixKey ) ) ) ;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL ( localVarPath , 'https://example.com' ) ;
let baseOptions ;
if ( configuration ) {
baseOptions = configuration . baseOptions ;
}
const localVarRequestOptions :AxiosRequestConfig = { method : 'GET' , . . . baseOptions , . . . options } ;
const localVarHeaderParameter = { } as any ;
const localVarQueryParameter = { } as any ;
// authentication Bearer required
// http bearer authentication required
if ( configuration && configuration . accessToken ) {
const accessToken = typeof configuration . accessToken === 'function'
? await configuration . accessToken ( )
: await configuration . accessToken ;
localVarHeaderParameter [ "Authorization" ] = "Bearer " + accessToken ;
}
const query = new URLSearchParams ( localVarUrlObj . search ) ;
for ( const key in localVarQueryParameter ) {
query . set ( key , localVarQueryParameter [ key ] ) ;
}
for ( const key in options . params ) {
query . set ( key , options . params [ key ] ) ;
}
localVarUrlObj . search = ( new URLSearchParams ( query ) ) . toString ( ) ;
let headersFromBaseOptions = baseOptions && baseOptions . headers ? baseOptions . headers : { } ;
localVarRequestOptions . headers = { . . . localVarHeaderParameter , . . . headersFromBaseOptions , . . . options . headers } ;
return {
url : localVarUrlObj.pathname + localVarUrlObj . search + localVarUrlObj . hash ,
options : localVarRequestOptions ,
} ;
} ,
/ * *
*
* @summary 获 取 缓 存 值 🔖
* @param { string } key
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
apiSysCacheValueKeyGet : async ( key : string , options : AxiosRequestConfig = { } ) : Promise < RequestArgs > = > {
// verify required parameter 'key' is not null or undefined
if ( key === null || key === undefined ) {
throw new RequiredError ( 'key' , 'Required parameter key was null or undefined when calling apiSysCacheValueKeyGet.' ) ;
}
const localVarPath = ` /api/sysCache/value/{key} `
. replace ( ` { ${ "key" } } ` , encodeURIComponent ( String ( key ) ) ) ;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL ( localVarPath , 'https://example.com' ) ;
let baseOptions ;
if ( configuration ) {
baseOptions = configuration . baseOptions ;
}
const localVarRequestOptions :AxiosRequestConfig = { method : 'GET' , . . . baseOptions , . . . options } ;
const localVarHeaderParameter = { } as any ;
const localVarQueryParameter = { } as any ;
// authentication Bearer required
// http bearer authentication required
if ( configuration && configuration . accessToken ) {
const accessToken = typeof configuration . accessToken === 'function'
? await configuration . accessToken ( )
: await configuration . accessToken ;
localVarHeaderParameter [ "Authorization" ] = "Bearer " + accessToken ;
}
const query = new URLSearchParams ( localVarUrlObj . search ) ;
for ( const key in localVarQueryParameter ) {
query . set ( key , localVarQueryParameter [ key ] ) ;
}
for ( const key in options . params ) {
query . set ( key , options . params [ key ] ) ;
}
localVarUrlObj . search = ( new URLSearchParams ( query ) ) . toString ( ) ;
let headersFromBaseOptions = baseOptions && baseOptions . headers ? baseOptions . headers : { } ;
localVarRequestOptions . headers = { . . . localVarHeaderParameter , . . . headersFromBaseOptions , . . . options . headers } ;
return {
url : localVarUrlObj.pathname + localVarUrlObj . search + localVarUrlObj . hash ,
options : localVarRequestOptions ,
} ;
} ,
}
} ;
/ * *
* SysCacheApi - functional programming interface
* @export
* /
export const SysCacheApiFp = function ( configuration? : Configuration ) {
return {
2024-08-14 02:51:40 +08:00
/ * *
*
* @summary 申 请 分 布 式 锁
* @param { string } key 要 锁 定 的 key
* @param { number } msTimeout 申 请 锁 等 待 的 时 间 , 单 位 毫 秒
* @param { number } msExpire 锁 过 期 时 间 , 超 过 该 时 间 没 有 主 动 是 放 则 自 动 是 放 , 必 须 整 数 秒 , 单 位 毫 秒
* @param { boolean } throwOnFailure 失 败 时 是 否 抛 出 异 常 , 如 不 抛 出 异 常 , 可 通 过 判 断 返 回 null得知申请锁失败
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost ( key : string , msTimeout : number , msExpire : number , throwOnFailure : boolean , options? : AxiosRequestConfig ) : Promise < ( axios? : AxiosInstance , basePath? : string ) = > Promise < AxiosResponse < AdminResultIDisposable > >> {
const localVarAxiosArgs = await SysCacheApiAxiosParamCreator ( configuration ) . apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost ( key , msTimeout , msExpire , throwOnFailure , options ) ;
return ( axios : AxiosInstance = globalAxios , basePath : string = BASE_PATH ) = > {
const axiosRequestArgs :AxiosRequestConfig = { . . . localVarAxiosArgs . options , url : basePath + localVarAxiosArgs . url } ;
return axios . request ( axiosRequestArgs ) ;
} ;
} ,
2024-08-13 00:55:21 +08:00
/ * *
*
* @summary 清 空 所 有 缓 存 🔖
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
2024-08-15 02:25:00 +08:00
async apiSysCacheClearPost ( options? : AxiosRequestConfig ) : Promise < ( axios? : AxiosInstance , basePath? : string ) = > Promise < AxiosResponse < void > >> {
const localVarAxiosArgs = await SysCacheApiAxiosParamCreator ( configuration ) . apiSysCacheClearPost ( options ) ;
2024-08-13 00:55:21 +08:00
return ( axios : AxiosInstance = globalAxios , basePath : string = BASE_PATH ) = > {
const axiosRequestArgs :AxiosRequestConfig = { . . . localVarAxiosArgs . options , url : basePath + localVarAxiosArgs . url } ;
return axios . request ( axiosRequestArgs ) ;
} ;
} ,
2024-06-15 13:02:35 +08:00
/ * *
*
* @summary 根 据 键 名 前 缀 删 除 缓 存 🔖
* @param { string } prefixKey 键 名 前 缀
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheDeleteByPreKeyPrefixKeyPost ( prefixKey : string , options? : AxiosRequestConfig ) : Promise < ( axios? : AxiosInstance , basePath? : string ) = > Promise < AxiosResponse < AdminResultInt32 > >> {
const localVarAxiosArgs = await SysCacheApiAxiosParamCreator ( configuration ) . apiSysCacheDeleteByPreKeyPrefixKeyPost ( prefixKey , options ) ;
return ( axios : AxiosInstance = globalAxios , basePath : string = BASE_PATH ) = > {
const axiosRequestArgs :AxiosRequestConfig = { . . . localVarAxiosArgs . options , url : basePath + localVarAxiosArgs . url } ;
return axios . request ( axiosRequestArgs ) ;
} ;
} ,
/ * *
*
* @summary 删 除 缓 存 🔖
* @param { string } key
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheDeleteKeyPost ( key : string , options? : AxiosRequestConfig ) : Promise < ( axios? : AxiosInstance , basePath? : string ) = > Promise < AxiosResponse < AdminResultInt32 > >> {
const localVarAxiosArgs = await SysCacheApiAxiosParamCreator ( configuration ) . apiSysCacheDeleteKeyPost ( key , options ) ;
return ( axios : AxiosInstance = globalAxios , basePath : string = BASE_PATH ) = > {
const axiosRequestArgs :AxiosRequestConfig = { . . . localVarAxiosArgs . options , url : basePath + localVarAxiosArgs . url } ;
return axios . request ( axiosRequestArgs ) ;
} ;
} ,
/ * *
*
* @summary 获 取 缓 存 键 名 集 合 🔖
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheKeyListGet ( options? : AxiosRequestConfig ) : Promise < ( axios? : AxiosInstance , basePath? : string ) = > Promise < AxiosResponse < AdminResultListString > >> {
const localVarAxiosArgs = await SysCacheApiAxiosParamCreator ( configuration ) . apiSysCacheKeyListGet ( options ) ;
return ( axios : AxiosInstance = globalAxios , basePath : string = BASE_PATH ) = > {
const axiosRequestArgs :AxiosRequestConfig = { . . . localVarAxiosArgs . options , url : basePath + localVarAxiosArgs . url } ;
return axios . request ( axiosRequestArgs ) ;
} ;
} ,
/ * *
*
* @summary 根 据 键 名 前 缀 获 取 键 名 集 合 🔖
* @param { string } prefixKey 键 名 前 缀
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheKeysByPrefixKeyPrefixKeyGet ( prefixKey : string , options? : AxiosRequestConfig ) : Promise < ( axios? : AxiosInstance , basePath? : string ) = > Promise < AxiosResponse < AdminResultListString > >> {
const localVarAxiosArgs = await SysCacheApiAxiosParamCreator ( configuration ) . apiSysCacheKeysByPrefixKeyPrefixKeyGet ( prefixKey , options ) ;
return ( axios : AxiosInstance = globalAxios , basePath : string = BASE_PATH ) = > {
const axiosRequestArgs :AxiosRequestConfig = { . . . localVarAxiosArgs . options , url : basePath + localVarAxiosArgs . url } ;
return axios . request ( axiosRequestArgs ) ;
} ;
} ,
/ * *
*
* @summary 获 取 缓 存 值 🔖
* @param { string } key
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheValueKeyGet ( key : string , options? : AxiosRequestConfig ) : Promise < ( axios? : AxiosInstance , basePath? : string ) = > Promise < AxiosResponse < AdminResultObject > >> {
const localVarAxiosArgs = await SysCacheApiAxiosParamCreator ( configuration ) . apiSysCacheValueKeyGet ( key , options ) ;
return ( axios : AxiosInstance = globalAxios , basePath : string = BASE_PATH ) = > {
const axiosRequestArgs :AxiosRequestConfig = { . . . localVarAxiosArgs . options , url : basePath + localVarAxiosArgs . url } ;
return axios . request ( axiosRequestArgs ) ;
} ;
} ,
}
} ;
/ * *
* SysCacheApi - factory interface
* @export
* /
export const SysCacheApiFactory = function ( configuration? : Configuration , basePath? : string , axios? : AxiosInstance ) {
return {
2024-08-14 02:51:40 +08:00
/ * *
*
* @summary 申 请 分 布 式 锁
* @param { string } key 要 锁 定 的 key
* @param { number } msTimeout 申 请 锁 等 待 的 时 间 , 单 位 毫 秒
* @param { number } msExpire 锁 过 期 时 间 , 超 过 该 时 间 没 有 主 动 是 放 则 自 动 是 放 , 必 须 整 数 秒 , 单 位 毫 秒
* @param { boolean } throwOnFailure 失 败 时 是 否 抛 出 异 常 , 如 不 抛 出 异 常 , 可 通 过 判 断 返 回 null得知申请锁失败
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost ( key : string , msTimeout : number , msExpire : number , throwOnFailure : boolean , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultIDisposable > > {
return SysCacheApiFp ( configuration ) . apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost ( key , msTimeout , msExpire , throwOnFailure , options ) . then ( ( request ) = > request ( axios , basePath ) ) ;
} ,
2024-08-13 00:55:21 +08:00
/ * *
*
* @summary 清 空 所 有 缓 存 🔖
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
2024-08-15 02:25:00 +08:00
async apiSysCacheClearPost ( options? : AxiosRequestConfig ) : Promise < AxiosResponse < void > > {
return SysCacheApiFp ( configuration ) . apiSysCacheClearPost ( options ) . then ( ( request ) = > request ( axios , basePath ) ) ;
2024-08-13 00:55:21 +08:00
} ,
2024-06-15 13:02:35 +08:00
/ * *
*
* @summary 根 据 键 名 前 缀 删 除 缓 存 🔖
* @param { string } prefixKey 键 名 前 缀
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheDeleteByPreKeyPrefixKeyPost ( prefixKey : string , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultInt32 > > {
return SysCacheApiFp ( configuration ) . apiSysCacheDeleteByPreKeyPrefixKeyPost ( prefixKey , options ) . then ( ( request ) = > request ( axios , basePath ) ) ;
} ,
/ * *
*
* @summary 删 除 缓 存 🔖
* @param { string } key
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheDeleteKeyPost ( key : string , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultInt32 > > {
return SysCacheApiFp ( configuration ) . apiSysCacheDeleteKeyPost ( key , options ) . then ( ( request ) = > request ( axios , basePath ) ) ;
} ,
/ * *
*
* @summary 获 取 缓 存 键 名 集 合 🔖
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheKeyListGet ( options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultListString > > {
return SysCacheApiFp ( configuration ) . apiSysCacheKeyListGet ( options ) . then ( ( request ) = > request ( axios , basePath ) ) ;
} ,
/ * *
*
* @summary 根 据 键 名 前 缀 获 取 键 名 集 合 🔖
* @param { string } prefixKey 键 名 前 缀
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheKeysByPrefixKeyPrefixKeyGet ( prefixKey : string , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultListString > > {
return SysCacheApiFp ( configuration ) . apiSysCacheKeysByPrefixKeyPrefixKeyGet ( prefixKey , options ) . then ( ( request ) = > request ( axios , basePath ) ) ;
} ,
/ * *
*
* @summary 获 取 缓 存 值 🔖
* @param { string } key
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* /
async apiSysCacheValueKeyGet ( key : string , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultObject > > {
return SysCacheApiFp ( configuration ) . apiSysCacheValueKeyGet ( key , options ) . then ( ( request ) = > request ( axios , basePath ) ) ;
} ,
} ;
} ;
/ * *
* SysCacheApi - object - oriented interface
* @export
* @class SysCacheApi
* @extends { BaseAPI }
* /
export class SysCacheApi extends BaseAPI {
2024-08-14 02:51:40 +08:00
/ * *
*
* @summary 申 请 分 布 式 锁
* @param { string } key 要 锁 定 的 key
* @param { number } msTimeout 申 请 锁 等 待 的 时 间 , 单 位 毫 秒
* @param { number } msExpire 锁 过 期 时 间 , 超 过 该 时 间 没 有 主 动 是 放 则 自 动 是 放 , 必 须 整 数 秒 , 单 位 毫 秒
* @param { boolean } throwOnFailure 失 败 时 是 否 抛 出 异 常 , 如 不 抛 出 异 常 , 可 通 过 判 断 返 回 null得知申请锁失败
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* @memberof SysCacheApi
* /
public async apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost ( key : string , msTimeout : number , msExpire : number , throwOnFailure : boolean , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultIDisposable > > {
return SysCacheApiFp ( this . configuration ) . apiSysCacheBeginCacheLockKeyMsTimeoutMsExpireThrowOnFailurePost ( key , msTimeout , msExpire , throwOnFailure , options ) . then ( ( request ) = > request ( this . axios , this . basePath ) ) ;
}
2024-08-13 00:55:21 +08:00
/ * *
*
* @summary 清 空 所 有 缓 存 🔖
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* @memberof SysCacheApi
* /
2024-08-15 02:25:00 +08:00
public async apiSysCacheClearPost ( options? : AxiosRequestConfig ) : Promise < AxiosResponse < void > > {
return SysCacheApiFp ( this . configuration ) . apiSysCacheClearPost ( options ) . then ( ( request ) = > request ( this . axios , this . basePath ) ) ;
2024-08-13 00:55:21 +08:00
}
2024-06-15 13:02:35 +08:00
/ * *
*
* @summary 根 据 键 名 前 缀 删 除 缓 存 🔖
* @param { string } prefixKey 键 名 前 缀
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* @memberof SysCacheApi
* /
public async apiSysCacheDeleteByPreKeyPrefixKeyPost ( prefixKey : string , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultInt32 > > {
return SysCacheApiFp ( this . configuration ) . apiSysCacheDeleteByPreKeyPrefixKeyPost ( prefixKey , options ) . then ( ( request ) = > request ( this . axios , this . basePath ) ) ;
}
/ * *
*
* @summary 删 除 缓 存 🔖
* @param { string } key
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* @memberof SysCacheApi
* /
public async apiSysCacheDeleteKeyPost ( key : string , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultInt32 > > {
return SysCacheApiFp ( this . configuration ) . apiSysCacheDeleteKeyPost ( key , options ) . then ( ( request ) = > request ( this . axios , this . basePath ) ) ;
}
/ * *
*
* @summary 获 取 缓 存 键 名 集 合 🔖
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* @memberof SysCacheApi
* /
public async apiSysCacheKeyListGet ( options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultListString > > {
return SysCacheApiFp ( this . configuration ) . apiSysCacheKeyListGet ( options ) . then ( ( request ) = > request ( this . axios , this . basePath ) ) ;
}
/ * *
*
* @summary 根 据 键 名 前 缀 获 取 键 名 集 合 🔖
* @param { string } prefixKey 键 名 前 缀
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* @memberof SysCacheApi
* /
public async apiSysCacheKeysByPrefixKeyPrefixKeyGet ( prefixKey : string , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultListString > > {
return SysCacheApiFp ( this . configuration ) . apiSysCacheKeysByPrefixKeyPrefixKeyGet ( prefixKey , options ) . then ( ( request ) = > request ( this . axios , this . basePath ) ) ;
}
/ * *
*
* @summary 获 取 缓 存 值 🔖
* @param { string } key
* @param { * } [ options ] Override http request option .
* @throws { RequiredError }
* @memberof SysCacheApi
* /
public async apiSysCacheValueKeyGet ( key : string , options? : AxiosRequestConfig ) : Promise < AxiosResponse < AdminResultObject > > {
return SysCacheApiFp ( this . configuration ) . apiSysCacheValueKeyGet ( key , options ) . then ( ( request ) = > request ( this . axios , this . basePath ) ) ;
}
}