Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Types #1509

Merged
merged 3 commits into from
Jan 9, 2020
Merged

Updating Types #1509

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
56498f0
Updating Types
jpinkster Jan 8, 2020
cf8153d
Update CHANGELOG.md
jpinkster Jan 8, 2020
0a22f37
fix(typings): Updating available types on construction, update addPag…
jpinkster Jan 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ project adheres to [Semantic Versioning](http://semver.org/).
### Added
### Fixed
* Fix BMP issues. (#1497)
* Update typings to support jpg and addPage on NodeCanvasRenderingContext2D (#1509)

2.6.1
==================
Expand Down
6 changes: 5 additions & 1 deletion types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export class Canvas {
/** Constant used in PNG encoding methods. */
readonly PNG_FILTER_PAETH: number

constructor(width: number, height: number, type?: 'pdf'|'svg')
constructor(width: number, height: number, type?: 'pdf'|'svg'|'jpg')
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'jpg' isn't a valid Canvas type, just 'pdf' and 'svg'. Anything else is ignored and creates an image canvas. If you want you could add 'image' here to maybe improve clarity...

node-canvas/src/Canvas.cc

Lines 105 to 110 in 37d556c

if (0 == strcmp("pdf", *Nan::Utf8String(info[2])))
backend = new PdfBackend(width, height);
else if (0 == strcmp("svg", *Nan::Utf8String(info[2])))
backend = new SvgBackend(width, height);
else
backend = new ImageBackend(width, height);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh thanks for that clarity! Updated


getContext(contextId: '2d', contextAttributes?: NodeCanvasRenderingContext2DSettings): NodeCanvasRenderingContext2D

Expand Down Expand Up @@ -212,6 +212,10 @@ declare class NodeCanvasRenderingContext2D extends CanvasRenderingContext2D {
createPattern(...args: any[]): NodeCanvasCanvasPattern
createLinearGradient(x0: number, y0: number, x1: number, y1: number): NodeCanvasCanvasGradient;
createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): NodeCanvasCanvasGradient;
/**
* An additional method .addPage() is then available to create multiple page PDFs
*/
addPage(width?: number, height?: number): void
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, good catch. Can you delete the incorrect declaration from line 130-134 (I had it on the Canvas instance instead of the rendering context) please? You could also copy the text from it that describes the default width/height values.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated!

}
export { NodeCanvasRenderingContext2D as CanvasRenderingContext2D }

Expand Down