bn.request
▸ request(options
): RequestTask
Initiates an HTTPS request.
example
Parameters
Name | Type | Description |
---|---|---|
options | RequestOption <string | ArrayBuffer | IUnknownObject > | request options |
Returns
RequestTask
request task
#
Interface: RequestOption<T>Name | Type | Description |
---|---|---|
url | string | request url |
data? | string | ArrayBuffer | IUnknownObject | request params |
header? | Headers | set request header, can't set Referer . default value of content-type is application/json |
timeout? | number | timeout of request, unit is millisecond |
method? | "OPTIONS" | "HEAD" | "GET" | "POST" | "PUT" | "DELETE" | HTTP request method |
dataType? | string | Returned data format. 'json' - the returned data is JSON. After returning, JSON.parse will be performed on the returned data. |
responseType? | "text" | "arraybuffer" | Response data type. 'text' - The response data is text; 'arraybuffer' - The response data is ArrayBuffer |
usePrefetchCache? | boolean | using prefetched dataremark support from jssdk > 4.0.0 |
fail? | RequestFailCallback | Callback function for failed interface call |
success? | RequestSuccessCallback <T > | Callback function for successful interface call |
complete? | RequestCompleteCallback | he callback function for the end of the interface call |
#
IUnknownObjectƬ IUnknownObject: Object
#
Interface: RequestTaskName | Type | Description |
---|---|---|
abort | (): void | Interrupt request task |
offHeadersReceived | (callback? ): void | Cancel listening for HTTP Response Header event |
onHeadersReceived | (callback ): void | Listen to the HTTP Response Header event. Will be earlier than the requested completion event |
#
abort▸ abort(): void
Interrupt request task
Returns
void
#
offHeadersReceived▸ offHeadersReceived(callback?
): void
Cancel listening for HTTP Response Header event
Parameters
Name | Type |
---|---|
callback? | OffHeadersReceivedCallback |
Returns
void
#
onHeadersReceived▸ onHeadersReceived(callback
): void
Listen to the HTTP Response Header event. Will be earlier than the requested completion event
Parameters
Name | Type |
---|---|
callback | OnHeadersReceivedCallback |
Returns
void
#
OffHeadersReceivedCallbackƬ OffHeadersReceivedCallback: (result
: OnHeadersReceivedCallbackResult
) => void
Type declaration
▸ (result
): void
Parameters
Name | Type |
---|---|
result | OnHeadersReceivedCallbackResult |
Returns
void
#
Interface: OnHeadersReceivedCallbackResultName | Type | Description |
---|---|---|
header | Headers | HTTP Response Header |
#
OnHeadersReceivedCallbackƬ OnHeadersReceivedCallback: (result
: OnHeadersReceivedCallbackResult
) => void
Type declaration
▸ (result
): void
Parameters
Name | Type |
---|---|
result | OnHeadersReceivedCallbackResult |
Returns
void