1.3.1 • Published 2 years ago

@alfr3xd/discordcards v1.3.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

DISCORDCARDS ⭐

Una librería de imágenes manipualadas con canvas para tus aplicaciones de discord.

INSTALACIÓN 📁

npm i @alfr3xd/discordcards

NPM

DOCUMENTACIÓN 📄

ClasesConstructor
MemberCardCardMemberData
LevelCardCardLevelData
RankingRankingData
FuncionesParámetros
fillRoundRectctx: CanvasRenderingContext2D x: number y: number w: number h: number r: number - {tl: number, tr: number, br: number, bl: number} f?: boolean s?: boolean
abbreviateNumbervalue: number
circleImagectx: CanvasRenderingContext2D x: number y: number w: number h: number f?: boolean s?: boolean

Pronto habrán más módulos para tus aplicaciones

CLASS LevelCard:

.registerFonts(font)

parámetrotypeopcionaldescripción
fontarrayDatos de la fuente de letra

returns: LevelCard

.setUsername(username, color, font)

parámetrotypeopcionaldescripción
usernamestringEl nombre del usuario
colorstringEl color de texto
fontstringLa fuente de letra

returns: LevelCard

.setNickname(nickname, color, font)

parámetrotypeopcionaldescripción
nicknamestringEl nickname del usuario
colorstringEl color de texto
fontstringLa fuente de letra

returns: LevelCard

.setRank(rank, color, text, font)

parámetrotypeopcionaldescripción
ranknumberEl top del ranking del usuario
colorstringEl color de texto
textstringEl texto del ranking: {rank} (alias in text)
fontstringLa fuente de letra

returns: LevelCard

.setLevel(level, color, text, font)

parámetrotypeopcionaldescripción
levelnumberNivel del usuario
colorstringEl color de texto
textstringEl texto del nivel: {level} (alias in text)
fontstringLa fuente de letra

returns: LevelCard

.setXp(xp, max, color, text, font)

parámetrotypeopcionaldescripción
xpnumberExperiencia actual
maxnumberExperiencia máxima
colorstringEl color de texto
textstringEl texto de la xp: {current} {max} (alias in text)
fontstringLa fuente de letra

returns: LevelCard

.setCurrentBarColor(color)

parámetrotypeopcionaldescripción
colorstring o {hex: string, position: number}[]El color de la barra de experiencia

returns: LevelCard

.setBackground(background, blur, radius)

parámetrotypeopcionaldescripción
backgroundstringURL de la imágen de fondo
blurnumberEl difuminado del fondo
radiusstringLa intensidad del borde de la tarjeta

returns: LevelCard

.setAvatar(avatar, color)

parámetrotypeopcionaldescripción
avatarstringURL del avatar del usuario
colorstringColor del aro del usuario

returns: LevelCard

.render()

returns: Promise<Buffer>

LevelCardImage

CLASS MemberCard:

.registerFonts(font)

parámetrotypeopcionaldescripción
fontarrayDatos de la fuente de letra

returns: MemberCard

.setUsername(username, color, font)

parámetrotypeopcionaldescripción
usernamestringNombre de usuario
colorstringEl color del texto
fontstringLa fuente de letra

returns: MemberCard

.setTitle(title, color, font)

parámetrotypeopcionaldescripción
titlestringTítulo de la tarjeta
colorstringEl color del texto
fontstringLa fuente de letra

returns: MemberCard

.setDescription(description, color, font)

parámetrotypeopcionaldescripción
descriptionstringDescripción de la tarjeta
colorstringEl color del texto
fontstringLa fuente de letra

returns: MemberCard

.setMemberCount(memberCount, color, font)

parámetrotypeopcionaldescripción
memberCountstringEl contador de miembros
colorstringEl color del texto
fontstringLa fuente de letra

returns: MemberCard

.setBackground(background, blur, radius)

parámetrotypeopcionaldescripción
backgroundstringURL de la imágen de fondo
blurnumberEl difuminado del fondo
radiusstringLa intensidad del borde de la tarjeta

returns: MemberCard

.setAvatar(avatar, color)

parámetrotypeopcionaldescripción
avatarstringURL del avatar del usuario
colorstringColor del aro del usuario

returns: MemberCard

.setBox(box, color)

parámetrotypeopcionaldescripción
boxbooleanUna caja de fondo
colorstringColor de la caja

returns: MemberCard

.render()

returns: Promise<Buffer>

MemberCardImage

CLASS Ranking:

.registerFonts(font)

parámetrotypeopcionaldescripción
fontarrayDatos de la fuente de letra

returns: Ranking

.setColors(colors)

parámetrotypeopcionaldescripción
colorsRankingData#colorsColores de los textos

returns: Ranking

.setFonts(fonts)

parámetrotypeopcionaldescripción
fontsRankingData#fontsFuentes de letra de los textos

returns: Ranking

.setUsersData(usersData)

parámetrotypeopcionaldescripción
usersDataRankingData#usersDataDatos de los usuarios

returns: Ranking

.render()

returns: Promise<Buffer>

RankingImage

TYPEDEF CardMemberData

{
 username?: string,
 title?: string,
 description?: string,
 memberCount?: string,
 colors?: {
 title: string,
  description: string,
  username: string,
  stroke: string,
  box: string,
  memberCount: string
 }
 avatar?: string,
 background?: string,
 blur?: number,
 radius?: number,
 box?: boolean,
 fonts?: {
  usernameFont: string,
  titleFont: string,
  descriptionFont: string,
  memberCountFont: string
 }
}

TYPEDEF CardLevelData

{
 username?: string,
 nickname?: string,
 rank?: number,
 level?: number,
 xp?: { current: number, max: number },
 colors?: {
  bar?: string | { hex: string, position: number }[],
  stroke?: string,
  username: string,
  nickname: string,
  level: string,
  rank: string,
  xp: string
 },
 images?: { avatar: string, background: string },
 fonts?: {
  usernameFont: string,
  nicknameFont: string,
  rankFont: string,
  levelFont: string,
  xpFont: string
 },
 blur?: number,
 radius?: number,
 levelText?: string,
 rankText?: string,
 xpText?: string
}

TYPEDEF RankingData

{
 colors?: {
  box: string,
  username: string,
  xp: string,
  level: string,
  firstRank: string,
  secondRank: string,
  thirdRank: string
 },
 fonts?: {
  username: string,
  xp: string,
  level: string,
  ranks: string
 },
 usersData?: {
  avatar: string,
  tag: string,
  level: number,
  xp: number,
  max_xp: number,
  top: number
 }[]
}