Skip to content

Commit e43d729

Browse files
authored
Update preferNativeRender option description
Clarified the description of the preferNativeRender option.
1 parent f0644d8 commit e43d729

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
@@ -27,14 +27,13 @@ declare const terminalImage: {
2727
It is recommended to use the percentage option.
2828
You can set width and/or height as columns and/or rows of the terminal window as well.
2929
By default, aspect ratio is always maintained. If you don't want to maintain aspect ratio, set preserveAspectRatio to false.
30-
We use the native terminal rendering by default. If you want to always render via ANSI, set preferNativeRender to false.
3130
3231
@param imageBuffer - Buffer with the image.
3332
@param options - Image rendering options.
3433
@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.
3534
@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.
3635
@param options.preserveAspectRatio - Optional: Whether to maintain image aspect ratio or not. Default: true.
37-
@param options.preferNativeRender - Optional: Render the image using the terminal's native rendering or ANSI rendering. Default: true.
36+
@param options.preferNativeRender - Prefer native terminal image protocols when available; set to false to force ANSI rendering. Default: true.
3837
@returns The ansi escape codes to display the image.
3938
4039
@example

0 commit comments

Comments
 (0)