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.

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

Typescript errors, inconsistencies #369

Open
ktwbc opened this issue Jan 8, 2024 · 0 comments
Open

Typescript errors, inconsistencies #369

ktwbc opened this issue Jan 8, 2024 · 0 comments

Comments

@ktwbc
Copy link

ktwbc commented Jan 8, 2024

Screenshot 2024-01-08 at 10 03 08 AM

Typescript is flagging some of the examples copied straight out of docs. For example, createPage appears to not accept the text string, flagging it as only wanting width and height in numbers.

Second issue is even the text string is inconsistent, readme example says letter-size but your jsdocs say it should be letter not letter-size:

Create a new page, specifying either actual width and height, or the name
of a supported page size (eg. 'letter', )
@name createPage
@function
@memberof Recipe
@param {number|string} [pageWidth_or_pageSizeName='letter'] - The page width, or name of medium size.
Known named medium sizes: executive, folio, legal, letter, ledger, tabloid, a0-a10, b0-b10, c0-c10, ra0-ra4, sra0-ara4
@param {number} [pageHeight_or_rotation] - The page height, or rotation (90) when when page size name given.
@param {object} [margins] - page margin definitions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant