ApiParams | Tora

内置请求参数解析及检查工具。

Type parameters

Hierarchy

Judgement<T>
- ApiParams

Index

Constructors

constructor

Properties

data

Methods

Constructors

constructor

new ApiParams<T>(data: T): ApiParams<T>

Inherited from Judgement.constructor
- Defined in src/builtin/judgement.ts:75
Type parameters
- T
Parameters
- data: T
Returns ApiParams<T>

Properties

data

data: T

Methods

Protected all

all(value: any, types: (RegExp | ValueType)[]): boolean

Inherited from Judgement.all
- Defined in src/builtin/judgement.ts:160
Parameters
- value: any
- types: (RegExp | ValueType)[]
Returns boolean

Protected any

any(value: any, types: (RegExp | ValueType)[]): boolean

Inherited from Judgement.any
- Defined in src/builtin/judgement.ts:151
Parameters
- value: any
- types: (RegExp | ValueType)[]
Returns boolean

doIf

doIf(prop: P, match: RegExp | ValueType, then?: (res: PathValue<T, P>) => void): void

- Defined in src/builtin/api-params.ts:164
参数检查，是否匹配目标的 [类型/正则表达式]，如果匹配则执行操作。

Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match: RegExp | ValueType
 
 预设类型或者正则表达式
- Optional then: (res: PathValue<T, P>) => void
 
 回调函数
 - - (res: PathValue<T, P>): void
 - Parameters
 - res: PathValue<T, P>
 Returns void
Returns void

doIfAll

doIfAll(prop: P, match_list: (RegExp | ValueType)[], then?: (res: PathValue<T, P>) => void): void

- Defined in src/builtin/api-params.ts:198
参数检查，是否匹配全部 [类型/正则表达式]，如果匹配则执行操作。

Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match_list: (RegExp | ValueType)[]
 
 预设的多个类型或者正则表达式
- Optional then: (res: PathValue<T, P>) => void
 
 回调函数
 - - (res: PathValue<T, P>): void
 - Parameters
 - res: PathValue<T, P>
 Returns void
Returns void

doIfAny

doIfAny(prop: P, match_list: (RegExp | ValueType)[], then?: (res: PathValue<T, P>) => void): void

- Defined in src/builtin/api-params.ts:181
参数检查，是否匹配多个 [类型/正则表达式] 中的任意一个，如果匹配则执行操作。

Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match_list: (RegExp | ValueType)[]
 
 预设的多个类型或者正则表达式
- Optional then: (res: PathValue<T, P>) => void
 
 回调函数
 - - (res: PathValue<T, P>): void
 - Parameters
 - res: PathValue<T, P>
 Returns void
Returns void

ensure

ensure(prop: P, match?: RegExp | ValueType): Exclude<PathValue<T, P>, undefined>

- Defined in src/builtin/api-params.ts:111
参数检查，是否匹配目标的 [类型/正则表达式]，不匹配则抛出错误信息。

Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- Optional match: RegExp | ValueType
 
 预设类型或者正则表达式
Returns Exclude<PathValue<T, P>, undefined>

ensureAll

ensureAll(prop: P, match_list: (RegExp | ValueType)[]): Exclude<PathValue<T, P>, undefined>

- Defined in src/builtin/api-params.ts:146
参数检查，是否匹配全部 [类型/正则表达式]，不匹配则抛出错误信息。

Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match_list: (RegExp | ValueType)[]
 
 预设的多个类型或者正则表达式
Returns Exclude<PathValue<T, P>, undefined>

ensureAny

ensureAny(prop: P, match_list: (RegExp | ValueType)[]): Exclude<PathValue<T, P>, undefined>

- Defined in src/builtin/api-params.ts:129
参数检查，是否匹配多个 [类型/正则表达式] 中的任意一个，不匹配则抛出错误信息。

Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match_list: (RegExp | ValueType)[]
 
 预设的多个类型或者正则表达式
Returns Exclude<PathValue<T, P>, undefined>

get

get(): T
get(path: P): undefined | PathValue<T, P>
get(path: P, def: PathValue<T, P>): Exclude<PathValue<T, P>, undefined>

Inherited from Judgement.get
- Defined in src/builtin/judgement.ts:81
Returns T
Inherited from Judgement.get
- Defined in src/builtin/judgement.ts:82
Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- path: P
Returns undefined | PathValue<T, P>
Inherited from Judgement.get
- Defined in src/builtin/judgement.ts:83
Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- path: P
- def: PathValue<T, P>
Returns Exclude<PathValue<T, P>, undefined>

getIf

getIf(prop: P, match: RegExp | ValueType): undefined | PathValue<T, P>
getIf(prop: P, match: RegExp | ValueType, def: PathValue<T, P>): Exclude<PathValue<T, P>, undefined>

- Defined in src/builtin/api-params.ts:27
参数检查，是否匹配目标的 [类型/正则表达式]。
- 匹配则返回参数本身。
- 不匹配返回 undefined。
Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match: RegExp | ValueType
 
 预设类型或者正则表达式
Returns undefined | PathValue<T, P>
- Defined in src/builtin/api-params.ts:38
参数检查，是否匹配目标的 [类型/正则表达式]。
- 匹配则返回参数本身。
- 不匹配返回默认值。
Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match: RegExp | ValueType
 
 预设类型或者正则表达式
- def: PathValue<T, P>
 
 默认值
Returns Exclude<PathValue<T, P>, undefined>

getIfAll

getIfAll(prop: P, match_list: (RegExp | ValueType)[]): undefined | PathValue<T, P>
getIfAll(prop: P, match_list: (RegExp | ValueType)[], def: PathValue<T, P>): Exclude<PathValue<T, P>, undefined>

- Defined in src/builtin/api-params.ts:85
参数检查，是否匹配全部 [类型/正则表达式]。
- 匹配则返回参数本身。
- 不匹配返回默认值。
Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match_list: (RegExp | ValueType)[]
 
 预设的多个类型或者正则表达式
Returns undefined | PathValue<T, P>
- Defined in src/builtin/api-params.ts:96
参数检查，是否匹配全部 [类型/正则表达式]。
- 匹配则返回参数本身。
- 不匹配返回默认值。
Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match_list: (RegExp | ValueType)[]
 
 预设的多个类型或者正则表达式
- def: PathValue<T, P>
 
 默认值
Returns Exclude<PathValue<T, P>, undefined>

getIfAny

getIfAny(prop: P, match_list: (RegExp | ValueType)[]): undefined | PathValue<T, P>
getIfAny(prop: P, match_list: (RegExp | ValueType)[], def: PathValue<T, P>): Exclude<PathValue<T, P>, undefined>

- Defined in src/builtin/api-params.ts:56
参数检查，是否匹配多个 [类型/正则表达式] 中的任意一个。
- 匹配则返回参数本身。
- 不匹配返回默认值。
Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match_list: (RegExp | ValueType)[]
 
 预设的多个类型或者正则表达式
Returns undefined | PathValue<T, P>
- Defined in src/builtin/api-params.ts:67
参数检查，是否匹配多个 [类型/正则表达式] 中的任意一个。
- 匹配则返回参数本身。
- 不匹配返回默认值。
Type parameters
- P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`
Parameters
- prop: P
 
 需要匹配的属性
- match_list: (RegExp | ValueType)[]
 
 预设的多个类型或者正则表达式
- def: PathValue<T, P>
 
 默认值
Returns Exclude<PathValue<T, P>, undefined>

Protected testValue

testValue(value: any, type?: RegExp | ValueType): any

Inherited from Judgement.testValue
- Defined in src/builtin/judgement.ts:113
Parameters
- value: any
- Optional type: RegExp | ValueType
Returns any

Type parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

T

Parameters

data: T

Returns ApiParams<T>

Properties

data

Methods

Protected all

Parameters

value: any

types: (RegExp | ValueType)[]

Returns boolean

Protected any

Parameters

value: any

types: (RegExp | ValueType)[]

Returns boolean

doIf

Type parameters

P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`

Parameters

prop: P

match: RegExp | ValueType

Optional then: (res: PathValue<T, P>) => void

Parameters

res: PathValue<T, P>

Returns void

Returns void

doIfAll

Type parameters

P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`

Parameters

prop: P

match_list: (RegExp | ValueType)[]

Optional then: (res: PathValue<T, P>) => void

Parameters

res: PathValue<T, P>

Returns void

Returns void

doIfAny

Type parameters

P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`

Parameters

prop: P

match_list: (RegExp | ValueType)[]

Optional then: (res: PathValue<T, P>) => void

Parameters

res: PathValue<T, P>

Returns void

Returns void

ensure

Type parameters

P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`

Parameters

prop: P

Optional match: RegExp | ValueType

Returns Exclude<PathValue<T, P>, undefined>

ensureAll

Type parameters

P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`

Parameters

prop: P

match_list: (RegExp | ValueType)[]

Returns Exclude<PathValue<T, P>, undefined>

ensureAny

Type parameters

P: string | `${string}.${string}` | `${string}.${string}.${string}` | `${string}.${string}.${string}.${string}` | `${string}.${string}.${string}.${string}.${string}`

Parameters

prop: P

match_list: (RegExp | ValueType)[]