Skip to content

Commit f0644d8

Browse files
committed
Add a description for the added type
1 parent 0ab4515 commit f0644d8

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ 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.
3031
3132
@param imageBuffer - Buffer with the image.
3233
@param options - Image rendering options.
@@ -65,6 +66,7 @@ declare const terminalImage: {
6566
It is recommended to use the percentage option.
6667
You can set width and/or height as columns and/or rows of the terminal window as well.
6768
By default, aspect ratio is always maintained. If you don't want to maintain aspect ratio, set preserveAspectRatio to false.
69+
We use the native terminal rendering by default. If you want to always render via ANSI, set preferNativeRender to false.
6870
6971
@param filePath - File path to the image.
7072
@param options - Image rendering options.

0 commit comments

Comments
 (0)