Croshe | FastNative文档

创息公司系统的接口请求类

Hierarchy

Base
- Croshe

Index

Constructors

constructor

Methods

Constructors

constructor

new Croshe(): Croshe

Inherited from Base.constructor
- Defined in FastServer.ts:14
Returns Croshe

Methods

Static appendUrlParams

appendUrlParams(url: string, params: any): string

Inherited from Base.appendUrlParams
- Defined in FastServer.ts:84
追加url参数

Parameters
- url: string
- params: any
Returns string

Static buildCacheKey

buildCacheKey(url: string, params: any): string

- Defined in FastServer.ts:347
构建接口请求的缓存key

Parameters
- url: string
  
  请求地址
- params: any
  
  请求参数
Returns string

Static convertToFormData

convertToFormData(param: any): FormData

Inherited from Base.convertToFormData
- Defined in FastServer.ts:123
转换参数为FormData格式

Parameters
- param: any
  
  任意格式的参数，FormData、Object、Function
Returns FormData

Static doGet

doGet(url: string, params?: any): AxiosPromise<any>

Inherited from Base.doGet
- Defined in FastServer.ts:222
执行get请求

Parameters
- url: string
  
  请求接口地址
- Optional params: any
  
  请求接口参数
Returns AxiosPromise<any>

Static doPost

doPost(url: string, params: any): AxiosPromise<any>

Inherited from Base.doPost
- Defined in FastServer.ts:213
执行post请求

Parameters
- url: string
  
  请求地址
- params: any
  
  请求参数，可为object或formdata
Returns AxiosPromise<any>

Static doRequest

doRequest(method: string, url: string, params: any): AxiosPromise<any>

Inherited from Base.doRequest
- Defined in FastServer.ts:184
发起接口请求

Parameters
- method: string
  
  请求方法，例如，post、get
- url: string
  
  请求地址
- params: any
  
  请求参数
Returns AxiosPromise<any>

Static get

get(url: string, params: any, config?: FastRequestConfig, callBack?: (result: FastResponseData) => void): Promise<FastResponseData>

- Defined in FastServer.ts:338
get请求接口

Parameters
- url: string
  
  接口地址完整的地址，例如：http://loalhost:8080/user/login
- params: any
  
  参数
- Optional config: FastRequestConfig
  
  请求配置
- Optional callBack: (result: FastResponseData) => void
  
  请求接口回调函数，在使用alwaysCache和alwaysBackRequest参数是，建议使用回调函数接收
  - - (result: FastResponseData): void
    - Parameters
      - result: FastResponseData
      Returns void
Returns Promise<FastResponseData>

Static getFinalParams

getFinalParams(): Promise<any>

- Defined in FastServer.ts:238
获取接口的全局参数

Returns Promise<any>

Static getHeaderConfig

getHeaderConfig(): any

Inherited from Base.getHeaderConfig
- Defined in FastServer.ts:21
获取请求接口的默认头信息配置

Returns any

Static getUrlParam

getUrlParam(url: string, paramName: string): null | string

Inherited from Base.getUrlParam
- Defined in FastServer.ts:50
获取url的参数

Parameters
- url: string
  
  地址
- paramName: string
  
  参数名
Returns null | string

Static getUrlParamInfo

getUrlParamInfo(url: string): any

Inherited from Base.getUrlParamInfo
- Defined in FastServer.ts:67
获取url的参数实体对象

Parameters
- url: string
  
  地址
Returns any

Static getWindowUrlInfo

getWindowUrlInfo(): any

Inherited from Base.getWindowUrlInfo
- Defined in FastServer.ts:41
获取地址栏携带的参数对象信息

Returns any

Static getWindowUrlParam

getWindowUrlParam(paramName: string): null | string

Inherited from Base.getWindowUrlParam
- Defined in FastServer.ts:34
获取地址栏携带的参数

Parameters
- paramName: string
  
  参数名
Returns null | string

Static mergeFormData

mergeFormData(...formData: FormData[]): FormData

Inherited from Base.mergeFormData
- Defined in FastServer.ts:106
合并多个FormData参数

Parameters
- Rest ...formData: FormData[]
Returns FormData

Static mergeParams

mergeParams(...params: any[]): FormData

Inherited from Base.mergeParams
- Defined in FastServer.ts:143
合并参数并转换为FormData格式

Parameters
- Rest ...params: any[]
  
  任意多个参数，FormData、Object、Function
Returns FormData

Static mergeParamsByArray

mergeParamsByArray(params: any[]): FormData

Inherited from Base.mergeParamsByArray
- Defined in FastServer.ts:162
将数组格式的参数合并

Parameters
- params: any[]
  
  数组
Returns FormData

Static post

post(url: string, params: any, config?: FastRequestConfig, callBack?: (result: FastResponseData) => void): Promise<FastResponseData>

- Defined in FastServer.ts:327
post请求接口

Parameters
- url: string
  
  接口地址完整的地址，例如：http://loalhost:8080/user/login
- params: any
  
  参数
- Optional config: FastRequestConfig
  
  请求配置
- Optional callBack: (result: FastResponseData) => void
  
  请求接口回调函数，在使用alwaysCache和alwaysBackRequest参数是，建议使用回调函数接收
  - - (result: FastResponseData): void
    - Parameters
      - result: FastResponseData
      Returns void
Returns Promise<FastResponseData>

Static request

request(method: string, url: string, params: any, config?: FastRequestConfig, callBack?: (result: FastResponseData) => void): Promise<FastResponseData>

- Defined in FastServer.ts:263
发起请求接口

Parameters
- method: string
  
  请求方法，例如：post、get
- url: string
  
  接口地址完整的地址，例如：http://loalhost:8080/user/login
- params: any
  
  参数
- Optional config: FastRequestConfig
  
  请求配置
- Optional callBack: (result: FastResponseData) => void
  
  请求接口回调函数，在使用alwaysCache和alwaysBackRequest参数是，建议使用回调函数接收
  - - (result: FastResponseData): void
    - Parameters
      - result: FastResponseData
      Returns void
Returns Promise<FastResponseData>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Croshe

Methods

Static appendUrlParams

Parameters

url: string

params: any

Returns string

Static buildCacheKey

Parameters

url: string

params: any

Returns string

Static convertToFormData

Parameters

param: any

Returns FormData

Static doGet

Parameters

url: string

Optional params: any

Returns AxiosPromise<any>

Static doPost

Parameters

url: string

params: any

Returns AxiosPromise<any>

Static doRequest

Parameters

method: string

url: string

params: any

Returns AxiosPromise<any>

Static get

Parameters

url: string

params: any

Optional config: FastRequestConfig

Optional callBack: (result: FastResponseData) => void

Parameters

result: FastResponseData

Returns void

Returns Promise<FastResponseData>

Static getFinalParams

Returns Promise<any>

Static getHeaderConfig

Returns any

Static getUrlParam

Parameters

url: string

paramName: string

Returns null | string

Static getUrlParamInfo

Parameters

url: string

Returns any

Static getWindowUrlInfo

Returns any

Static getWindowUrlParam

Parameters

paramName: string

Returns null | string

Static mergeFormData

Parameters

Rest ...formData: FormData[]

Returns FormData

Static mergeParams

Parameters

Rest ...params: any[]

Returns FormData

Static mergeParamsByArray

Parameters

params: any[]

Returns FormData

Static post