@delirius/welcard/build/index.d.ts

WelCard is a lightweight and futuristic welcome card libary designed for WhatsApp Bots.

export declare class welCard {
    constructor();

    /**
     * Establece el nombre en la welCard.
     * @param name - El nombre que se mostrará en la card.
     * @example
     * ```javascript
     * .setName("Bienvenido/a");
     * ```
     */
    public setName(name: string): this;

    /**
     * Establece el autor en la welCard.
     * @param author - El autor que se mostrará en la card.
     * @example
     * ```javascript
     * .setAuthor('Sareth');
     * ```
     */
    public setAuthor(author: string): this;

    /**
     * Establece el nombre del servidor en la welCard.
     * @param name - El nombre del grupo / servidor.
     * @example
     * ```javascript
     * .setServer('Delirius Group');
     * ```
     */
    public setServer(name: string): this;

    /**
     * Establece el color de fondo de la welCard.
     * @param color - El color de fondo en formato hexadecimal (#RRGGBB) o "auto" para un color automático.
     * @example
     * ```javascript
     * .setColor("auto");
     * ```
     */
    public setColor(color: string): this;

    /**
     * Establece el brillo de la welCard.
     * @param brightness - El nivel de brillo de la tarjeta (0-100).
     * @example
     * ```javascript
     * .setBrightness(50);
     * ```
     */
    public setBrightness(brightness: number): this;

    /**
     * Establece una imagen en miniatura en la welCard.
     * @param thumbnail - URL de la imagen del participante.
     * @example
     * ```javascript
     * .setThumbnail("https://i.postimg.cc/3rLKbgLH/image.jpg");
     * ```
     */
    public setThumbnail(thumbnail: string): this;

    /**
     * Construye la welCard y devuelve una promesa que resuelve en un Buffer.
     *@returns Una promesa que resuelve en un Buffer que representa la tarjeta.
     * @example
     * ```javascript
     * .build().then((buffer) => {
     *     // Hacer algo con el buffer, como guardarlo en disco o enviarlo a un cliente.
     * });
     * ```
     */
    public build(): Promise<Buffer>;
}

  /**
   * Función que crea una tarjeta de personalidad.
   * @param backgroundurl - URL del fondo.
   * @param title - Título de la card
   * @param name - Nombre que se mostrará en la tarjeta.
   * @param perfil - URL de la imagen de perfil.
   * @returns Promesa que resuelve en un Buffer que representa la tarjeta.
   * @example
   * ```javascript
   * const canvas = require("@delirius/welcard");
   * const name = "Sareth";
   * const perfil = "https://i.ibb.co/ZcPLKgK/darlyn-profile-programacion.jpg";
   *
   * canvas.createPersonalityCanvas(name, perfil)
   *   .then((buffer) => {
   *     // Hacer algo con el buffer, como guardarlo en disco o enviarlo a un cliente.
   *   });
   * ```
   */
export function personalidad(backgroundurl: string, title: string, name: string, perfil: string):Promise<Buffer>;

/**
 * Busca letras de canciones y devuelve información sobre la canción.
 * @param term - Término de búsqueda de la canción.
 * @returns Promesa que resuelve en un objeto con información de la canción.
 * @example
 * ```javascript
 * const term = "Money Lisa";
 *
 * searchLyrics(term)
 *   .then((result) => {
 *     console.log(result);
 *   });
 * ```
 */
export function searchLyrics(term: string): Promise<any>

/**
 * Ssweb Scraper from https://www.screenshotmachine.com
 * @function
 * @param {String} url - example https://www.npmjs.com/package/@delirius/welcard
 * @param {String} device - example desktop or tablet & phone
 *
 */
export function ssweb(url: string, device: string): Promise<Buffer>