Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

禅道请求构建类

internal

Hierarchy

  • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new default(zentao: default, moduleName: string, methodName?: string, params?: string | [string, any][] | string[] | Record<string, any>): default

  • 创建一个禅道请求构建实例

    Parameters

    • zentao: default

      禅道请求实例

    • moduleName: string

      方法名

    • Optional methodName: string

      模块名

    • Optional params: string | [string, any][] | string[] | Record<string, any>

      请求参数

    Returns default

Properties

Optional _data

_data: string | Record<string, any>

Optional _fields

_fields: string[]

_methodName

_methodName: string

Optional _name

_name: string

Optional _params

_params: string | [string, any][] | string[] | Record<string, any>

Optional _resultConvertor

_resultConvertor: (remoteData: any, result: ZentaoApiResult) => ZentaoApiResult

Type declaration

Optional _url

_url: string

Readonly moduleName

moduleName: string

模块名

Readonly zentao

zentao: default

禅道请求实例

Accessors

data

  • get data(): undefined | string | Record<string, any>

fields

  • get fields(): undefined | string[]

methodName

  • get methodName(): string

name

  • get name(): undefined | string

params

  • get params(): undefined | string | [string, any][] | string[] | Record<string, any>

resultConvertor

url

  • get url(): undefined | string

Methods

appendParams

f

  • 设置方法名，是方法 method(name) 的别名

    alias

    method

    Parameters

    • name: string

      方法名

    Returns default

    禅道请求构建实例自身

filterFields

  • filterFields(...fields: (undefined | string | string[])[]): default

  • 过滤需要返回的属性列表

    Parameters

    • Rest ...fields: (undefined | string | string[])[]

      设置仅返回的属性名称列表

    Returns default

    禅道请求构建实例自身

get

method

named

post

request

  • request(method?: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK"): Promise<ZentaoApiResult>

  • 发起 HTTP 请求，可以指定请求方式

    Parameters

    • Optional method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK"

      请求方式，默认为 GET

    Returns Promise<ZentaoApiResult>

    请求结果

useConverter

withParams

Generated using TypeDoc