Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-05-02 06:21:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for text document encoding methods (#242299)

Browse Source
This commit is contained in:
Benjamin Pasero
2025-02-28 13:54:30 +01:00
committed by GitHub
parent 559a51e69f
commit 7625487ec2
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/vscode-dts/vscode.proposed.textDocumentEncoding.d.ts vendored
View File

@@ -69,7 +69,7 @@ declare module 'vscode' {
*
* *Note* that if you open a document with an encoding that does not
* support decoding the underlying bytes, content may be replaced with
* substitution characters appropriate for the character encoding.
* substitution characters as appropriate.
*/
encoding?: string;
}): Thenable<TextDocument>;
@@ -99,7 +99,7 @@ declare module 'vscode' {
*
* *Note* that if you open a document with an encoding that does not
* support decoding the underlying bytes, content may be replaced with
* substitution characters appropriate for the character encoding.
* substitution characters as appropriate.
*/
encoding?: string;
}): Thenable<TextDocument>;
@@ -128,15 +128,18 @@ declare module 'vscode' {
}): Thenable<TextDocument>;
/**
* Decodes the content from a `Uint8Array` to a `string`.
* Decodes the content from a `Uint8Array` to a `string`. You MUST
* provide the entire content at once to ensure that the encoding
* can properly apply. Do not use this method to decode content
* in chunks, as that may lead to incorrect results.
*
* If no encoding is provided, will try to pick an encoding based
* on user settings and the content of the buffer (for example
* byte order marks).
*
* *Note* that if you decode content that is unsupported by the
* encoding, the result may contain substitution characters appropriate
* for the character encoding.
* encoding, the result may contain substitution characters as
* appropriate.
*
* @throws This method will throw an error when the content is binary.
*