# path

**Repository Path**: dove-ohos/path

## Basic Information

- **Project Name**: path
- **Description**: OpenHarmony/HarmonyOS文件路径处理工具库
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/dove-ohos/path
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-08
- **Last Updated**: 2025-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# path

## 简介

[path](https://gitee.com/dove-ohos/path)，是一个OpenHarmony/HarmonyOS文件处理工具库，支持使用API10以上。

## 下载安装

```shell
ohpm install @dove/path
```

## 接口和属性列表
接口列表

| **接口**                             | 参数                                                                                   | 返回值       |
|------------------------------------|--------------------------------------------------------------------------------------|-----------|
| path.join()                        | path：文件夹/文件名 数组                                                                      | 组装后的路径    |
| path.exists()                      | path: 文件/文件名 路径                                                                      | 路径是否存在    |
| path.existSync()                   | path: 文件/文件名 路径                                                                      | 路径是否存在    |
| path.getFileName()                 | src: 文件路径                                                                            | 文件名包括后缀名  |
| path.getFileNameWithoutExtension() | src: 文件路径                                                                            | 文件名不包括后缀名 |
| path.getExtension()                | src:文件路径                                                                             | 文件后缀名     |
| path.generateUniqueFilename()      | basePath: 文件夹根目录<br/> baseName: 文件名不包括后缀 <br/> ext: 文件名后缀 <br/> limit: 重试次数(超出会抛出错误) | 生成后的文件名   |

## 使用示例

``` typescript
import path from '@dove/path';

//拼接路径
const context : Context = getContext(this);
const src = path.join(context.filesDir,'test.txt');

//判断是否存在
await path.exists(src);
path.existsSync(src);

//获取文件名信息
const fn = path.getFileName(src);
const fnw = path.getFileNameWithoutExtension(src);
const ext = path.getExtension(src);

//获取一个新的文件名，注意，默认限制重试1024次，如果超出将会抛出异常，需要使用try-catch处理
const nfn = path.generateUniqueFilename(context.cacheDir, fnw, ext, 1024);

```