jira-rest-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Omit<RequestConfig, "data" | "params" | "url" | "responseType">
    • FullRequestParams

Index

Properties

Methods

Properties

Optional adapter

adapter: AxiosAdapter

Optional auth

auth: AxiosBasicCredentials

Optional baseURL

baseURL: string

Optional body

body: unknown

request body

Optional cancelToken

cancelToken: CancelToken

Optional decompress

decompress: boolean

Optional format

format: ResponseType

format of response (i.e. response.json() -> format: "json")

Optional headers

headers: any

Optional httpAgent

httpAgent: any

Optional httpsAgent

httpsAgent: any

Optional maxBodyLength

maxBodyLength: number

Optional maxContentLength

maxContentLength: number

Optional maxRedirects

maxRedirects: number

Optional method

method: Method

path

path: string

request path

Optional proxy

proxy: false | AxiosProxyConfig

Optional query

query: QueryParamsType

query params

Optional secure

secure: boolean

set parameter to true for call securityWorker for this request

Optional socketPath

socketPath: null | string

Optional timeout

timeout: number

Optional timeoutErrorMessage

timeoutErrorMessage: string

Optional transformRequest

transformRequest: AxiosTransformer | AxiosTransformer[]

Optional transformResponse

transformResponse: AxiosTransformer | AxiosTransformer[]

Optional transitional

transitional: TransitionalOptions

Optional type

type: ContentType

content type of request body

Optional validateStatus

validateStatus: null | ((status: number) => boolean)

Optional withCredentials

withCredentials: boolean

Optional xsrfCookieName

xsrfCookieName: string

Optional xsrfHeaderName

xsrfHeaderName: string

Methods

Optional onDownloadProgress

  • onDownloadProgress(progressEvent: any): void

  • Parameters

    • progressEvent: any

    Returns void

Optional onUploadProgress

  • onUploadProgress(progressEvent: any): void

  • Parameters

    • progressEvent: any

    Returns void

Optional paramsSerializer

  • paramsSerializer(params: any): string

  • Parameters

    • params: any

    Returns string

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc