summaryrefslogtreecommitdiff
path: root/cli/tsc
diff options
context:
space:
mode:
authorBartek IwaƄczuk <biwanczuk@gmail.com>2024-11-16 15:13:50 +0000
committerGitHub <noreply@github.com>2024-11-16 15:13:50 +0000
commita1bcdf17a53fb98c476aae9e205817c4a80a363d (patch)
tree3e1cdd0b03e2de8f0dae548829edac28b4ef644b /cli/tsc
parent8d2960d7ccb756de4260a642d960cd01eaaa2478 (diff)
feat(jupyter): Add `Deno.jupyter.image` API (#26284)
This commit adds `Deno.jupyter.image` API to display PNG and JPG images: ``` const data = Deno.readFileSync("./my-image.jpg"); Deno.jupyter.image(data); Deno.jupyter.image("./my-image.jpg"); ```
Diffstat (limited to 'cli/tsc')
-rw-r--r--cli/tsc/dts/lib.deno.unstable.d.ts26
1 files changed, 26 insertions, 0 deletions
diff --git a/cli/tsc/dts/lib.deno.unstable.d.ts b/cli/tsc/dts/lib.deno.unstable.d.ts
index 6234268c3..f8043f932 100644
--- a/cli/tsc/dts/lib.deno.unstable.d.ts
+++ b/cli/tsc/dts/lib.deno.unstable.d.ts
@@ -1181,6 +1181,32 @@ declare namespace Deno {
): Displayable;
/**
+ * Display a JPG or PNG image.
+ *
+ * ```
+ * Deno.jupyter.image("./cat.jpg");
+ * Deno.jupyter.image("./dog.png");
+ * ```
+ *
+ * @category Jupyter
+ * @experimental
+ */
+ export function image(path: string): Displayable;
+
+ /**
+ * Display a JPG or PNG image.
+ *
+ * ```
+ * const img = Deno.readFileSync("./cat.jpg");
+ * Deno.jupyter.image(img);
+ * ```
+ *
+ * @category Jupyter
+ * @experimental
+ */
+ export function image(data: Uint8Array): Displayable;
+
+ /**
* Format an object for displaying in Deno
*
* @param obj - The object to be displayed