mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 06:03:30 +00:00
118 lines
3.1 KiB
TypeScript
118 lines
3.1 KiB
TypeScript
/*
|
|
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* This module provides the Fetch Response.
|
|
* @interface FetchResponse
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
export interface FetchResponse {
|
|
/**
|
|
* Server status code.
|
|
* @type { number }
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
code: number;
|
|
|
|
/**
|
|
* Data returned by the success function.
|
|
* @type { string | object }
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
data: string | object;
|
|
|
|
/**
|
|
* All headers in the response from the server.
|
|
* @type { Object }
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
headers: Object;
|
|
}
|
|
|
|
/**
|
|
* Obtains data through a network.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
export default class Fetch {
|
|
/**
|
|
* Obtains data through the network.
|
|
* @param { object } options - Options.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
static fetch(options: {
|
|
/**
|
|
* Resource URL.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
url: string;
|
|
|
|
/**
|
|
* Request parameter, which can be of the string type or a JSON object.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
data?: string | object;
|
|
|
|
/**
|
|
* Request header, which accommodates all attributes of the request.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
header?: Object;
|
|
|
|
/**
|
|
* Request methods available: OPTIONS, GET, HEAD, POST, PUT, DELETE and TRACE. The default value is GET.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
method?: string;
|
|
|
|
/**
|
|
* The return type can be text, or JSON. By default, the return type is determined based on Content-Type in the header returned by the server.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
responseType?: string;
|
|
|
|
/**
|
|
* Called when the network data is obtained successfully.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
success?: (data: FetchResponse) => void;
|
|
|
|
/**
|
|
* Called when the network data fails to be obtained.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
fail?: (data: any, code: number) => void;
|
|
|
|
/**
|
|
* Called when the execution is completed.
|
|
* @syscap SystemCapability.Communication.NetStack
|
|
* @since 3
|
|
*/
|
|
complete?: () => void;
|
|
}): void;
|
|
}
|