class PlumeAPI

export default class PlumeAPI

The client to interact with Plume API.

Examples:
const plumeAPI = new PlumeAPI();

const joke = await plumeAPI.joke();
console.log(joke);
rest
achievement
advice
agify
alert
asciiImage
asciiText
blur
boost
captcha
caution
challenge
changeMyMind
color
colorify
colorImage
couple
crypto
decode
definition
didYouMean
drake
duck
duolingo
eightBall
emojify
emojiMix
encode
exec
facts
fortniteMap
fortniteMapImage
fortniteMapImagePois
fox
freeGames
funFact
fuze3
githubRepository
githubUser
grayscale
heightBall
hugo
interaction
invert
ipInfo
iss
issImage
jail
joke
latex
math
meme
minecraftAvatar
minecraftBedrockServerStatus
minecraftBody
minecraftID
minecraftJavaServerStatus
minecraftLatestVersions
minecraftName
minecraftSkin
minecraftVersions
nasaAPOD
nokia
nothing
npm
oogway
pepeHug
plusCode
qrcode
quote
randomColor
randomEmojiMix
rank
reverseText
robloxID
robloxUser
rotate
sadcat
screenshot
stonks
tableFlip
translate
tweet
upsideDown
urban
uuid
wanted
water
weather
welcome
wikipedia
woosh

Constructors

constructor(
options?: PlumeAPIOptions
)

Constructs a new instance of the PlumeAPI class

readonly
rest : PlumeAPIREST

achievement(
text: string
) : Promise<Buffer>

advice(
locale?: Locale
) : Promise<AdviceData>

agify(
name: string
) : Promise<AgifyData>

alert(
text: string
) : Promise<Buffer>

asciiImage(
text: string
font?: AsciiFont | (string & {})
) : Promise<Buffer>

asciiText(
text: string
) : Promise<AsciiData>

blur(
url: string
) : Promise<Buffer>

boost(
avatar: string
username: string
text?: string
) : Promise<Buffer>

captcha() : Promise<{ code: string; image: Buffer; }>

caution(
text: string
) : Promise<Buffer>

challenge(
text: string
) : Promise<Buffer>

changeMyMind(
text: string
) : Promise<Buffer>

color(
hex: string
) : Promise<ColorData>

colorify(
url: string
color: string
) : Promise<Buffer>

colorImage(
hex: string
) : Promise<Buffer>

couple(
avatar1: string
avatar2: string
percentage?: number
primary_color?: string
) : Promise<Buffer>

crypto(
name: string
currency: "usd" | "eur" | (string & {})
) : Promise<CryptoData>

decode(
type: DecodeType
text: string
) : Promise<DecodeData>

definition(
locale: Locale
word: string
) : Promise<DefinitionData>

didYouMean(
search: string
correction: string
) : Promise<Buffer>

drake(
top: string
bottom: string
) : Promise<Buffer>

duck() : Promise<Buffer>

duolingo(
text: string
) : Promise<Buffer>

eightBall(
locale?: Locale
) : Promise<EightBallData>

emojify(
text: string
) : Promise<EmojifyData>

emojiMix(
left: string
right: string
) : Promise<EmojiMixData>

encode(
type: EncodeType
text: string
) : Promise<EncodeData>

exec(
language: ExecLanguage | (string & {})
code: string
) : Promise<ExecData>

facts(
text: string
) : Promise<Buffer>

fortniteMap(
locale?: Locale
) : Promise<FortniteMapData>

fortniteMapImage() : Promise<Buffer>

fortniteMapImagePois(
locale?: Locale
) : Promise<Buffer>

fox() : Promise<Buffer>

freeGames(
locale?: Locale
) : Promise<FreeGamesData>

funFact(
locale?: Locale
) : Promise<FunFactData>

fuze3(
text: string
) : Promise<Buffer>

githubRepository(
name: string
) : Promise<GitHubRepository>

githubUser(
name: string
) : Promise<GitHubUser>

grayscale(
url: string
) : Promise<Buffer>

deprecated
heightBall(
locale?: Locale
) : Promise<HeightBallData>

hugo(
text: string
) : Promise<Buffer>

interaction(
type: InteractionType
) : Promise<InteractionData>

invert(
url: string
) : Promise<Buffer>

ipInfo(
ip: string
) : Promise<IPInfoData>

iss() : Promise<ISSData>

issImage(
circle?: boolean
) : Promise<Buffer>

jail(
avatar: string
) : Promise<Buffer>

joke(
locale?: Locale
) : Promise<JokeData>

latex(
expr: string
) : Promise<Buffer>

math(
expr: string
) : Promise<MathData>

meme() : Promise<MemeData>

minecraftAvatar(
name: string
) : Promise<Buffer>

minecraftBedrockServerStatus(
host: string
) : Promise<MinecraftBedrockServerStatus>

minecraftBody(
name: string
) : Promise<Buffer>

minecraftID(
name: string
) : Promise<MinecraftIDData>

minecraftJavaServerStatus(
host: string
) : Promise<MinecraftJavaServerStatus>

minecraftLatestVersions() : Promise<MinecraftLatestVersions>

minecraftName(
id: string
) : Promise<MinecraftNameData>

minecraftSkin(
name: string
) : Promise<MinecraftSkinData>

minecraftVersions() : Promise<MinecraftVersions>

nasaAPOD() : Promise<NasaAPOD>

nokia(
url: string
) : Promise<Buffer>

nothing(
text: string
) : Promise<Buffer>

npm(
name: string
) : Promise<NPMData>

oogway(
text: string
) : Promise<Buffer>

pepeHug(
avatar: string
) : Promise<Buffer>

plusCode(
lat: number
lon: number
code_length?: PlusCodeLength
) : Promise<PlusCodeData>

qrcode(
text: string
) : Promise<Buffer>

quote(
locale?: Locale
) : Promise<QuoteData>

randomColor() : Promise<ColorData>

randomEmojiMix() : Promise<RandomEmojiMixData>

rank(
avatar: string
global_name: string
username: string
level: number
xp: number
max_xp: number
rank?: number
bg_url?: string
bg_color?: string
blur?: boolean
color?: string
) : Promise<Buffer>

reverseText(
text: string
) : Promise<ReverseTextData>

robloxID(
name: string
) : Promise<RobloxIDData>

robloxUser(
name: string
) : Promise<RobloxUserData>

rotate(
url: string
deg: number
) : Promise<Buffer>

sadcat(
top: string
bottom: string
) : Promise<Buffer>

screenshot(
url: string
) : Promise<Buffer>

stonks(
avatar: string
stonks?: boolean
) : Promise<Buffer>

tableFlip(
avatar: string
) : Promise<Buffer>

translate(
text: string
to: string
) : Promise<TranslateData>

tweet(
avatar: string
name: string
username: string
text: string
retweets?: number
quote_tweets?: number
likes?: number
) : Promise<Buffer>

upsideDown(
text: string
) : Promise<UpsideDownTextData>

urban(
word: string
) : Promise<UrbanData>

uuid() : Promise<UUIDData>

wanted(
avatar: string
) : Promise<Buffer>

water(
text: string
) : Promise<Buffer>

weather(
city: string
) : Promise<WeatherData>

welcome(
avatar: string
text1: string
text2?: string
text3?: string
bg_url?: string
bg_color?: string
font_color?: string
blur?: boolean
avatar_border?: boolean
avatar_border_color?: string
) : Promise<Buffer>

wikipedia(
page: string
locale?: Locale
) : Promise<WikipediaData>

woosh(
avatar: string
) : Promise<Buffer>