Automattic / Automattic/node-canvas

Can't find docs on this library's objects

Open
#1,031 8 comments 0 reactions 0 assignees View on GitHub
Community
Dominant language
JavaScript
Stars
10.7k
Forks
1.2k
Avg merge
4d 8h
Merged PRs (30d)
1

Description

The Canvas API itself from HTML5 can be found on MDN, and the non-standard Canvas API is documented here. My question doesn't regard those docs (I think).

My question is, _is there an API documentation for how to use __the new objects__ provided by this library?_

I found this question on SO: https://stackoverflow.com/questions/9548074/nodejs-how-to-add-image-data-from-file-into-canvas

This particular snippet within it is concerning:

`var canvas = new Canvas( img.width, img.height )`

Where `Canvas` is defined here:

`Canvas = require('canvas');`

However, I didn't find any resource documenting this API. All I found was documentation on `Canvas.createCanvas`, and even then there is no description of what createCanvas does, what arguments it takes, and what kind of properties the function has as a javascript object.

Another API that seems to be mysterious is the `new Image()` API. I am assuming it is identical to [`Image()` defined by the HTML Living Standard (MDN)](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/Image), but again there is no doc, not even a sentence saying that "node-canvas `Image()` = HTML living standard `Image()`"

How am I supposed to know how your implementation of `Image()` differs from say Mozilla Firefox's implementation of `Image()`?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.