Skip to content

feat(fs): #3243 add encoding option to readTextFile functions #3244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amrbashir merged 3 commits into from
Feb 9, 2026
Merged

feat(fs): #3243 add encoding option to readTextFile functions #3244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe56896
feat(fs): #3243 add encoding option to readFile and readTextFile func…
SeijiOkuda Feb 1, 2026
ef50d1a
feat(fs): add encoding option to ReadFileOptions and update readTextF…
SeijiOkuda Feb 2, 2026
5ad3d80
add change file
amrbashir Feb 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/change-pr-3244.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"fs": minor
"fs-js": minor
---

Add `encoding` option for `readTextFile` and `readTextFileLines`
2 changes: 1 addition & 1 deletion plugins/fs/api-iife.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 6 additions & 4 deletions plugins/fs/guest-js/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,6 +723,8 @@ async function readDir(
interface ReadFileOptions {
/** Base directory for `path` */
baseDir?: BaseDirectory
/** Text encoding to use when reading a text file. Defaults to 'utf-8'. */
encoding?: string
Copy link
Copy Markdown
Member

@amrbashir amrbashir Feb 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing documentation

Copy link
Copy Markdown
Contributor Author

@SeijiOkuda SeijiOkuda Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amrbashir
Thanks for the review!
Added documentation comments.

}

/**
Expand Down Expand Up @@ -753,7 +755,7 @@ async function readFile(
}

/**
* Reads and returns the entire contents of a file as UTF-8 string.
* Reads and returns the entire contents of a file as a string using the specified encoding (default: UTF-8).
* @example
* ```typescript
* import { readTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';
Expand All @@ -777,11 +779,11 @@ async function readTextFile(

const bytes = arr instanceof ArrayBuffer ? arr : Uint8Array.from(arr)

return new TextDecoder().decode(bytes)
return new TextDecoder(options?.encoding ?? 'utf-8').decode(bytes)
}

/**
* Returns an async {@linkcode AsyncIterableIterator} over the lines of a file as UTF-8 string.
* Returns an async {@linkcode AsyncIterableIterator} over the lines of a file, decoded using the specified encoding (default: UTF-8).
* @example
* ```typescript
* import { readTextFileLines, BaseDirectory } from '@tauri-apps/plugin-fs';
Expand Down Expand Up @@ -838,7 +840,7 @@ async function readTextFileLines(
return { value: null, done }
}

const line = new TextDecoder().decode(
const line = new TextDecoder(options?.encoding ?? 'utf-8').decode(
bytes.slice(0, bytes.byteLength - 1)
)

Expand Down
Loading