https://github.com/e-chan1007/windows-directory-localization
Localize Windows's special directories such as Documents or Desktop
https://github.com/e-chan1007/windows-directory-localization
Last synced: 3 months ago
JSON representation
Localize Windows's special directories such as Documents or Desktop
- Host: GitHub
- URL: https://github.com/e-chan1007/windows-directory-localization
- Owner: e-chan1007
- License: mit
- Created: 2022-01-28T14:39:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-29T15:25:43.000Z (over 3 years ago)
- Last Synced: 2025-03-27T16:23:52.714Z (6 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/windows-directory-localization
- Size: 852 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# windows-directory-localization
Localize Windows's special directories such as Documents or Desktop
## Usage
```js
import localizeDirName from "windows-directory-localization";
// Example in Japanese:
localizeDirName("C:\\Users\\user\\Desktop"); // Expects to be "デスクトップ", which means "Desktop" in Japanese
```
If the specified directory is not found or doesn't have a localized name, it will be fallen back to the directory's original name.
```js
localizeDirName("C:\\Users\\user\\AppData"); // Expects to be "AppData"
localizeDirName("C:\\Users\\user\\NotFound"); // Expects to be "NotFound"
```
This module calls Windows API directly so that you can use not only Japanese but also any language supported by Windows.
Also, this is **NOT able to use on other platforms**, therefore.
---
Windows のディレクトリ名を翻訳された表示名に変換します。
## 使い方
```js
import localizeDirName from "windows-directory-localization";
localizeDirName("C:\\Users\\user\\Desktop"); // "デスクトップ"
```
指定されたディレクトリが存在しない場合や、表示名が存在しない場合は、元の名前をそのまま返します。
```js
localizeDirName("C:\\Users\\user\\AppData"); // "AppData"
localizeDirName("C:\\Users\\user\\NotFound"); // "NotFound"
```
Windows API を直接呼び出しているため、日本語に限らず多言語で利用が可能です。
この仕様により、**他の OS 上では動作しません**。