docs(api): fix incorrect example and clarify description for dirname in path API docs (#13417)

This commit is contained in:
MidnightCrowing
2025-05-12 16:35:35 +08:00
committed by GitHub
parent b7cdb3b39e
commit d3586a2afa

View File

@@ -674,12 +674,12 @@ async function join(...paths: string[]): Promise<string> {
}
/**
* Returns the directory name of a `path`. Trailing directory separators are ignored.
* Returns the parent directory of a given `path`. Trailing directory separators are ignored.
* @example
* ```typescript
* import { dirname } from '@tauri-apps/api/path';
* const dir = await dirname('/path/to/somedir/');
* assert(dir === 'somedir');
* assert(dir === '/path/to');
* ```
*
* @since 1.0.0