From 760c8d632c62ecfd598975ebbf69deb70ce86a64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Knut=20H=C3=BChne?= Date: Wed, 6 Aug 2025 12:38:30 +0200 Subject: [PATCH] Mark `canvasContext` as optional In #20016, the `canvasContext` property of `RenderParameters` was deprecated in favor of the new `canvas` property. The JSDoc was updated to include the new parameter along with the old one. I think the old one should be enclosed in `[]` to mark it as optional (and to allow usage from TypeScript with just the `canvas` parameter provided). I also reordered the properties so that all required properties come first, follow by optional ones. --- src/display/api.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/display/api.js b/src/display/api.js index f77d975208d18..1db1dbcce75c2 100644 --- a/src/display/api.js +++ b/src/display/api.js @@ -1182,16 +1182,16 @@ class PDFDocumentProxy { * Page render parameters. * * @typedef {Object} RenderParameters - * @property {CanvasRenderingContext2D} canvasContext - 2D context of a DOM - * Canvas object for backwards compatibility; it is recommended to use the - * `canvas` parameter instead. - * If the context must absolutely be used to render the page, the canvas must - * be null. * @property {HTMLCanvasElement|null} canvas - A DOM Canvas object. The default * value is the canvas associated with the `canvasContext` parameter if no * value is provided explicitly. * @property {PageViewport} viewport - Rendering viewport obtained by calling * the `PDFPageProxy.getViewport` method. + * @property {CanvasRenderingContext2D} [canvasContext] - 2D context of a DOM + * Canvas object for backwards compatibility; it is recommended to use the + * `canvas` parameter instead. + * If the context must absolutely be used to render the page, the canvas must + * be null. * @property {string} [intent] - Rendering intent, can be 'display', 'print', * or 'any'. The default value is 'display'. * @property {number} [annotationMode] Controls which annotations are rendered