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

Add example to createCard() doc

Browse source
This commit is contained in:
karashiiro 2021-05-28 02:06:50 -07:00
parent 277884a4e8
commit 5db4cba740
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
create-card.js
View file

@ -249,6 +249,18 @@ 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.
* @example
* const fs = require("fs");
*
* const card = new CardCreator();
* const lodestoneId = "13821878";
*
* await card.ensureInit();
* const png = await card.createCard(lodestoneId);
*
* fs.writeFile("./test.png", png, err => {
* if (err) console.error(err);
* });
* @returns {Promise<Buffer>} A promise representating the construction of the card's image data. * @returns {Promise<Buffer>} A promise representating the construction of the card's image data.
*/ */
async createCard(charaId) { async createCard(charaId) {