Skip to content

Commit ad3ad8b

Browse files
authored
Clarify preferNativeRender option in index.d.ts
1 parent e43d729 commit ad3ad8b

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

index.d.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,13 @@ declare const terminalImage: {
6565
It is recommended to use the percentage option.
6666
You can set width and/or height as columns and/or rows of the terminal window as well.
6767
By default, aspect ratio is always maintained. If you don't want to maintain aspect ratio, set preserveAspectRatio to false.
68-
We use the native terminal rendering by default. If you want to always render via ANSI, set preferNativeRender to false.
6968
7069
@param filePath - File path to the image.
7170
@param options - Image rendering options.
7271
@param options.width - Optional: Custom image width. Can be set as percentage or number of columns of the terminal. It is recommended to use the percentage options.
7372
@param options.height - Optional: Custom image height. Can be set as percentage or number of rows of the terminal. It is recommended to use the percentage options.
7473
@param options.preserveAspectRatio - Optional: Whether to maintain image aspect ratio or not. Default: true.
75-
@param options.preferNativeRender - Optional: Render the image using the terminal's native rendering or ANSI rendering. Default: true.
74+
@param options.preferNativeRender - Prefer native terminal image protocols when available; set to false to force ANSI rendering. Default: true.
7675
@returns The ANSI escape codes to display the image.
7776
7877
@example

0 commit comments

Comments
 (0)