interface_sdk-js/api/@ohos.file.hash.d.ts
fengjunqing 90f6e3ed1f Rectify the the specification for file_api's JSDoc-files
Signed-off-by: fengjunqing <fengjunqing@huawei.com>
2023-06-21 10:30:45 +08:00

54 lines
1.7 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.
*/
import type { AsyncCallback } from './@ohos.base';
/**
* Hash
*
* @namespace hash
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 9
*/
declare namespace hash {
/**
* Hash file.
*
* @param { string } path - path.
* @param { string } algorithm - algorithm md5 sha1 sha256.
* @returns { Promise<string> } return Promise
* @throws { BusinessError } 13900020 - Invalid argument
* @throws { BusinessError } 13900042 - Unknown error
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 9
*/
function hash(path: string, algorithm: string): Promise<string>;
/**
* Hash file.
*
* @param { string } path - path.
* @param { string } algorithm - algorithm md5 sha1 sha256.
* @param { AsyncCallback<string> } [callback] - callback.
* @throws { BusinessError } 13900020 - Invalid argument
* @throws { BusinessError } 13900042 - Unknown error
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 9
*/
function hash(path: string, algorithm: string, callback: AsyncCallback<string>): void;
}
export default hash;