externalHeadRequest
Hierarchy
- HTTPRequest
- HeadRequest
Index
Methods
staticexternalto
Parameters
externalresourceUri: Answerable<string>
The URI where the
Actor
should send theHTTPRequest
Returns HeadRequest
externaldescribedAs
Changes the description of this object, as returned by
Describable.describedBy
andDescribable.toString
.Parameters
externaldescription: Answerable<string> | MetaQuestion<AxiosRequestConfig<any>, Question<Promise<string>>>
Replaces the current description according to the following rules:
- If
description
is anAnswerable
, it replaces the current description - If
description
is aMetaQuestion
, the current description is passed ascontext
todescription.of(context)
, and the result replaces the current description
- If
Returns this
externalas
Maps this question to one of a different type.
Question.about('number returned as string', actor => '42') // returns: QuestionAdapter<string>
.as(Number) // returns: QuestionAdapter<number>Type parameters
- O
Parameters
externalmapping: (answer: AxiosRequestConfig<any>) => O | Promise<O>
Returns QuestionAdapter<O>
externaldescribedBy
Resolves the description of this object in the context of the provided
actor
.Parameters
externalactor: AnswersQuestions & UsesAbilities & { name: string }
Returns Promise<string>
externaltoString
Returns a human-readable description of this object.
Returns string
externalansweredBy
Parameters
externalactor: AnswersQuestions & UsesAbilities
Returns Promise<AxiosRequestConfig<any>>
externalusing
Parameters
externalconfig: Answerable<{ url?: Answerable<string>; method?: Answerable<string>; baseURL?: Answerable<string>; allowAbsoluteUrls?: Answerable<false> | Answerable<true>; transformRequest?: {} | {}[]; transformResponse?: {} | {}[]; headers?: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any } | { Accept: Answerable<string> | Answerable<number> | Answerable<false> | Answerable<true> | { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any } | Answerable<string>[]; Content-Length: Answerable<string> | Answerable<number> | Answerable<false> | Answerable<true> | { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any } | Answerable<string>[]; User-Agent: Answerable<string> | Answerable<number> | Answerable<false> | Answerable<true> | { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any } | Answerable<string>[]; Content-Encoding: Answerable<string> | Answerable<number> | Answerable<false> | Answerable<true> | { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any } | Answerable<string>[]; Authorization: Answerable<string> | Answerable<number> | Answerable<false> | Answerable<true> | { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any } | Answerable<string>[]; link: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; delete: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; get: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; head: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; options: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; post: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; put: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; patch: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; purge: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; unlink: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; common?: { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any }; Content-Type?: Answerable<string> | Answerable<number> | Answerable<false> | Answerable<true> | { set: any; get: any; has: any; delete: any; clear: any; normalize: any; concat: any; toJSON: any; setContentType: any; getContentType: any; hasContentType: any; setContentLength: any; getContentLength: any; hasContentLength: any; setAccept: any; getAccept: any; hasAccept: any; setUserAgent: any; getUserAgent: any; hasUserAgent: any; setContentEncoding: any; getContentEncoding: any; hasContentEncoding: any; setAuthorization: any; getAuthorization: any; hasAuthorization: any; getSetCookie: any; [iterator]: any } | Answerable<string>[] }; params?: any; paramsSerializer?: { visitor?: {}; dots?: Answerable<false> | Answerable<true>; metaTokens?: Answerable<false> | Answerable<true>; indexes?: Answerable<false> | Answerable<true>; encode?: {}; serialize?: {} } | {}; data?: any; timeout?: Answerable<number>; timeoutErrorMessage?: Answerable<string>; withCredentials?: Answerable<false> | Answerable<true>; adapter?: {} | Answerable<fetch> | Answerable<xhr> | Answerable<http> | { codePointAt: any; includes: any; endsWith: any; normalize: any; repeat: any; startsWith: any; anchor: any; big: any; blink: any; bold: any; fixed: any; fontcolor: any; fontsize: any; italics: any; link: any; small: any; strike: any; sub: any; sup: any; [iterator]: any; padStart: any; padEnd: any; trimEnd: any; trimStart: any; trimLeft: any; trimRight: any; matchAll: any; replaceAll: any; at: any; toString: any; charAt: any; charCodeAt: any; concat: any; indexOf: any; lastIndexOf: any; localeCompare: any; match: any; replace: any; search: any; slice: any; split: any; substring: any; toLowerCase: any; toLocaleLowerCase: any; toUpperCase: any; toLocaleUpperCase: any; trim: any; length: Answerable<number>; substr: any; valueOf: any } | {} | Answerable<"fetch"> | Answerable<"xhr"> | Answerable<"http"> | { readonly [x: number]: Answerable<string>; toString: {}; charAt: {}; ... 47 more ...; [Symbol.iterator]: {}; }[]; auth?: { username: Answerable<string>; password: Answerable<string> }; responseType?: Answerable<text> | Answerable<arraybuffer> | Answerable<blob> | Answerable<document> | Answerable<json> | Answerable<stream> | Answerable<formdata>; responseEncoding?: Answerable<string>; xsrfCookieName?: Answerable<string>; xsrfHeaderName?: Answerable<string>; onUploadProgress?: {}; onDownloadProgress?: {}; maxContentLength?: Answerable<number>; validateStatus?: {}; maxBodyLength?: Answerable<number>; maxRedirects?: Answerable<number>; maxRate?: Answerable<number> | [Answerable<number>, Answerable<number>]; beforeRedirect?: {}; socketPath?: Answerable<string>; transport?: any; httpAgent?: any; httpsAgent?: any; proxy?: Answerable<false> | { host: Answerable<string>; port: Answerable<number>; auth?: { username: Answerable<string>; password: Answerable<string> }; protocol?: Answerable<string> }; cancelToken?: { promise: Answerable<Cancel>; reason?: { message: Answerable<string> }; throwIfRequested: any }; decompress?: Answerable<false> | Answerable<true>; transitional?: { silentJSONParsing?: Answerable<false> | Answerable<true>; forcedJSONParsing?: Answerable<false> | Answerable<true>; clarifyTimeoutError?: Answerable<false> | Answerable<true> }; signal?: { aborted: Answerable<false> | Answerable<true>; onabort?: {}; addEventListener?: {}; removeEventListener?: {} }; insecureHTTPParser?: Answerable<false> | Answerable<true>; env?: { FormData?: {} }; formSerializer?: { visitor?: {}; dots?: Answerable<false> | Answerable<true>; metaTokens?: Answerable<false> | Answerable<true>; indexes?: Answerable<false> | Answerable<true> }; family?: Answerable<4> | Answerable<6>; lookup?: {} | {}; withXSRFToken?: Answerable<false> | Answerable<true> | {}; fetchOptions?: {} }>
Axios request configuration overrides
Returns HeadRequest
The HTTP HEAD method requests the headers that are returned if the specified resource would be requested with an HTTP GET method. Such a request can be done before deciding to download a large resource to save bandwidth, for example.
File download test
Learn more