🎨Welcomer

Welcomer

Creador de tarjetas de bienvenida

Kind: global class

• Welcomer

  • new Welcomer()

  • .data

  • .avatar : string

  • .titulo : string

  • .subtitulo : string

  • .colorTitulo : string

  • .colorSubtitulo : string

  • .colorCircle : string

  • .colorOverlay : number | string

  • .opacityOverlay : string

  • .typeOverlay : string

  • .colorBackground : string

  • .setColor(id, color) ⇒ Welcomer

  • .setAvatar(value) ⇒ Welcomer

  • .setTitulo(value) ⇒ Welcomer

  • .setSubtitulo(value) ⇒ Welcomer

  • .setColorTitulo(value) ⇒ Welcomer

  • .setColorSubtitulo(value) ⇒ Welcomer

  • .setColorCircle(value) ⇒ Welcomer

  • .setColorOverlay(value) ⇒ Welcomer

  • .setOpacityOverlay(value) ⇒ Welcomer

  • .setBackground(type, [data])

  • .setTypeOverlay(type)

  • .build(ops) ⇒ Promise.<Buffer>

new Welcomer()

Welcome image builder

Example

const welcomeCardURL = await new Welcomer()
        .setAvatar(member.user.displayAvatarURL({ format: 'png', size: 4096 }))
        .setBackground('IMAGE', https://i.imgur.com/aClDVjh.jpg)
        .setTitulo("Titulo de la Tarjeta")
        .setSubtitulo("Subtitulo de la Tarjeta")
        .setOpacityOverlay("0.5")
        .setColorTitulo(#FFFFFF)
        .setColorSubtitulo(#FFFFFF)
        .setColorCircle(#FFFFFF)
        .setColorOverlay(#FFFFFF)
        .setTypeOverlay("rounded")
      welcomeCardURL.build()
        .then(data => {
            canvacard.write(data, "WelcomeCard.png");
        })

welcomer.data

Fondo de la tarjeta

Kind: instance property of Welcomer Properties

Name	Type	Default	Description
backgroundGlobal	object		Fondo de la tarjeta
[backgroundGlobal.type]	"IMAGE" | "COLOR"	"color"	Tipo de fondo

welcomer.avatar : string

Avatar de la tarjeta

Kind: instance property of Welcomer\

welcomer.titulo : string

Título creado con Canvacard

Kind: instance property of Welcomer\

welcomer.subtitulo : string

Subtítulo creado con Canvacard

Kind: instance property of Welcomer\

welcomer.colorTitulo : string

Color del título creado con Canvacard

Kind: instance property of Welcomer\

welcomer.colorSubtitulo : string

Color del Subtítulo creado con Canvacard

Kind: instance property of Welcomer\

welcomer.colorCircle : string

Color del circulo

Kind: instance property of Welcomer\

welcomer.colorOverlay : number | string

Color del overlay

Kind: instance property of Welcomer\

welcomer.opacityOverlay : string

Opacidad del overlay

Kind: instance property of Welcomer\

welcomer.typeOverlay : string

Tipo de overlay

Kind: instance property of Welcomer\

welcomer.colorBackground : string

Color del fondo

Kind: instance property of Welcomer\

welcomer.setColor(id, color) ⇒ Welcomer

Establecer color

Kind: instance method of Welcomer

Param	Type	Description
id	"titulo" | "titulo-border" | "titulo-box" | "subtitulo" | "subtitulo-border" | "subtitulo-box" | "avatar" | "background" | "border"
color	string	Código de color HTML5

welcomer.setAvatar(value) ⇒ Welcomer

Valor del avatar

Kind: instance method of Welcomer

Param	Type
value	string | Buffer

welcomer.setTitulo(value) ⇒ Welcomer

Valor del título

Kind: instance method of Welcomer

Param	Type
value	string

welcomer.setSubtitulo(value) ⇒ Welcomer

Valor del subtítulo

Kind: instance method of Welcomer

Param	Type
value	string

welcomer.setColorTitulo(value) ⇒ Welcomer

Valor del color del título

Kind: instance method of Welcomer

Param	Type
value	string

welcomer.setColorSubtitulo(value) ⇒ Welcomer

Valor del color del subtítulo

Kind: instance method of Welcomer

Param	Type
value	string

welcomer.setColorCircle(value) ⇒ Welcomer

Valor del color del círculo

Kind: instance method of Welcomer

Param	Type
value	string

welcomer.setColorOverlay(value) ⇒ Welcomer

Valor del color del overlay

Kind: instance method of Welcomer

Param	Type
value	string

welcomer.setOpacityOverlay(value) ⇒ Welcomer

Valor del color del overlay

Kind: instance method of Welcomer

Param	Type
value	number | string

welcomer.setBackground(type, [data])

Establecer imagen / color de fondo

Kind: instance method of Welcomer

Param	Type	Description
type	"COLOR" | "IMAGE"	Tipo de fondo
[data]	string | Buffer	Color o imagen de fondo

welcomer.setTypeOverlay(type)

Establecer rectangle / rounded de overlay

Kind: instance method of Welcomer

Param	Type	Description
type	"RECTANGLE" | "ROUNDED"	Tipo de fondo

welcomer.build(ops) ⇒ Promise.<Buffer>

Construye la tarjeta de bienvenida

Kind: instance method of Welcomer

Param	Type	Default	Description
ops	object		Fuentes
[ops.fontX]	string	""MANROPE_BOLD""	Familia tipográfica Bold
[ops.fontY]	string	""MANROPE_REGULAR""	Familia tipográfica regular