aly/XIV-Character-Cards
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Reword createCard documentation

Browse source
This commit is contained in:
karashiiro 2021-05-29 17:37:57 -07:00
parent abb8acfbe0
commit 04506ded4e
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
create-card.js
View file

@ -271,9 +271,10 @@ class CardCreator {
* Creates a character card for a character. * Creates a character card for a character.
* @param {number | string} charaId The Lodestone ID of the character to generate a card for. * @param {number | string} charaId The Lodestone ID of the character to generate a card for.
* @param {string | Buffer | null | undefined} customImage Optional parameter providing a custom * @param {string | Buffer | null | undefined} customImage Optional parameter providing a custom
* image to be drawn over the character card. The image should be the same resolution as * image to be drawn between the background of the character card and the black information boxes.
* the default image. The default image size can be retrieved with {@link CardCreator#canvasSize}. * The image should be the same resolution as the default image. The default image size can be
* May be a URL, `data: `URI or a local file path or a Buffer instance. * retrieved with {@link CardCreator#canvasSize}. May be a URL, `data: `URI, a local file path,
* or a Buffer instance.
* @example * @example
* const fs = require("fs"); * const fs = require("fs");
* *