TypeError: t.toFixed is not a function

[ianchanning]

TypeError: t.toFixed is not a function

[yGuy]

But the Readme already says that you should inspect the linked typings file. And that file is actually really short and does contain the information you need.https://github.com/yWorks/svg2pdf.js/blob/6b5b4ea98aa2e5a4e2d2c7c8c2937da8cfdadafb/types.d.ts#L43I think the Readme itself is quite long,  already.I totally agree with you that having a page like the one for jspdf would be a great improvement.I personally find it very obvious that an API that is working with scalar values in JS should be using numbers and not strings. As such adding this information explicitly to the Readme could even hurt because if we start adding stuff like this no one will be reading the file because of its sheer size. Like the Apple EULA 😉Let's create a new ticket specifically for creating and linking to a nicer API documentation page. 

[yGuy]

Sorry, but this is still a programming library and it requires at least some basic programming skills to use it. For those who consider numbers and strings to be equal, they probably should not be using it. At least I would not want to optimize for these users.

JavaScript is not 'forgiving if you use the wrong type' - it will typically just do the wrong thing. So in a way, getting an exception is already an improvement, because if we automatically converted strings to numbers, the next programmer would claim that it doesn't work if they to height: smallSize+largeSize when smallSize = "1337" and largeSize = "42" and the result is not 1379 but 133742. That would not be a problem of the library, either, but it's simply a bug in the code of the user.

I agree that we could check the arguments more thoroughly to create nicer exceptions, and I am happy to accept a pull-request for thorough runtime parameter checks, but I do not support the proposed change:

Secretly doing this kind of auto conversion doesn't prevent bugs but actually hides them, IMHO.

[ianchanning]

I think you mis-read my request - I'd hoped it would 'just work' but I wasn't proposing that you fix that or do some auto-conversion.

This was my request:

Given that the number type of the options is strict, could you perhaps include in the README documentation that the options must be numbers.

...

Adding something like the regular jsPDF documentation of doc.html would be very helpful

I will see if I can create a PR for the documentation

[yGuy]

OK, understood.

I would argue that for the purpose of documenting the API (and actually verifying your correct use) you should be using the typescript typings, which indeed document this requirement, clearly:

svg2pdf.js/src/svg2pdf.ts

Line 66 in 6b5b4ea

x?: number

If you were using Typescript, the compiler would have found the problem and told you about the correct usage.

[ianchanning]

Understood, clearly you and I have very different ideas about documentation and who are the type of people who should be using your library. I am clearly not one of the people you want using your library so I will leave you to develop it as you see fit.

Thank you for your library.

[yGuy]

Don't know why the last comment appears to have been added 34 minutes ago, only. I wrote and sent that email before on the second or 3rd of September, more than a month ago. Did you see that response before? Strange...