Class PlumeAPI

The client to interact with Plume API

Index

Constructors

Methods

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

Properties

rest

Constructors

constructor

new PlumeAPI(options?: PlumeAPIOptions): PlumeAPI
Parameters
- Optionaloptions: PlumeAPIOptions
Returns PlumeAPI
- Defined in src/PlumeAPI.ts:64

Methods

achievement

achievement(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:379

advice

advice(locale?: Locale): Promise<AdviceData>
Parameters
- Optionallocale: Locale
Returns Promise<AdviceData>
- Defined in src/PlumeAPI.ts:75

agify

agify(name: string): Promise<AgifyData>
Parameters
- name: string
Returns Promise<AgifyData>
- Defined in src/PlumeAPI.ts:80

alert

alert(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:384

asciiImage

asciiImage(text: string, font?: AsciiFont): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
- Optionalfont: AsciiFont
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:85

asciiText

asciiText(text: string): Promise<AsciiData>
Parameters
- text: string
Returns Promise<AsciiData>
- Defined in src/PlumeAPI.ts:90

blur

blur(url: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- url: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:429

boost

boost(
    avatar: string,
    username: string,
    text?: string,
): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar: string
- username: string
- Optionaltext: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:533

captcha

captcha(): Promise<{ code: string; image: Buffer }>
Returns Promise<{ code: string; image: Buffer }>
- Defined in src/PlumeAPI.ts:194

caution

caution(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:389

challenge

challenge(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:394

changeMyMind

changeMyMind(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:456

color

color(hex: string): Promise<ColorData>
Parameters
- hex: string
Returns Promise<ColorData>
- Defined in src/PlumeAPI.ts:169

colorify

colorify(url: string, color: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- url: string
- color: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:434

colorImage

colorImage(hex: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- hex: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:174

couple

couple(
    avatar1: string,
    avatar2: string,
    percentage?: number,
    primary_color?: string,
): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar1: string
- avatar2: string
- Optionalpercentage: number
- Optionalprimary_color: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:538

crypto

crypto(name: string, currency: "usd" | "eur"): Promise<CryptoData>
Parameters
- name: string
- currency: "usd" | "eur"
Returns Promise<CryptoData>
- Defined in src/PlumeAPI.ts:205

decode

decode(type: DecodeType, text: string): Promise<DecodeData>
Parameters
- type: DecodeType
- text: string
Returns Promise<DecodeData>
- Defined in src/PlumeAPI.ts:293

definition

definition(locale: Locale, word: string): Promise<DefinitionData>
Parameters
- locale: Locale
- word: string
Returns Promise<DefinitionData>
- Defined in src/PlumeAPI.ts:210

didYouMean

didYouMean(search: string, correction: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- search: string
- correction: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:461

drake

drake(top: string, bottom: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- top: string
- bottom: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:466

duck

duck(): Promise<Buffer<ArrayBufferLike>>
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:276

duolingo

duolingo(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:471

eightBall

eightBall(locale?: Locale): Promise<HeightBallData>
Parameters
- Optionallocale: Locale
Returns Promise<HeightBallData>
- Defined in src/PlumeAPI.ts:70

emojify

emojify(text: string): Promise<EmojifyData>
Parameters
- text: string
Returns Promise<EmojifyData>
- Defined in src/PlumeAPI.ts:108

emojiMix

emojiMix(left: string, right: string): Promise<EmojiMixData>
Parameters
- left: string
- right: string
Returns Promise<EmojiMixData>
- Defined in src/PlumeAPI.ts:103

encode

encode(type: EncodeType, text: string): Promise<EncodeData>
Parameters
- type: EncodeType
- text: string
Returns Promise<EncodeData>
- Defined in src/PlumeAPI.ts:286

exec

exec(language: ExecLanguage, code: string): Promise<ExecData>
Parameters
- language: ExecLanguage
- code: string
Returns Promise<ExecData>
- Defined in src/PlumeAPI.ts:215

facts

facts(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:476

fortniteMap

fortniteMap(locale?: Locale): Promise<FortniteMapData>
Parameters
- Optionallocale: Locale
Returns Promise<FortniteMapData>
- Defined in src/PlumeAPI.ts:309

fortniteMapImage

fortniteMapImage(): Promise<Buffer<ArrayBufferLike>>
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:305

fortniteMapImagePois

fortniteMapImagePois(locale?: Locale): Promise<Buffer<ArrayBufferLike>>
Parameters
- Optionallocale: Locale
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:300

fox

fox(): Promise<Buffer<ArrayBufferLike>>
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:280

freeGames

freeGames(locale?: Locale): Promise<FreeGamesData>
Parameters
- Optionallocale: Locale
Returns Promise<FreeGamesData>
- Defined in src/PlumeAPI.ts:220

funFact

funFact(locale?: Locale): Promise<FunFactData>
Parameters
- Optionallocale: Locale
Returns Promise<FunFactData>
- Defined in src/PlumeAPI.ts:113

fuze3

fuze3(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:481

githubRepository

githubRepository(name: string): Promise<GitHubRepository>
Parameters
- name: string
Returns Promise<GitHubRepository>
- Defined in src/PlumeAPI.ts:182

githubUser

githubUser(name: string): Promise<GitHubUser>
Parameters
- name: string
Returns Promise<GitHubUser>
- Defined in src/PlumeAPI.ts:187

grayscale

grayscale(url: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- url: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:439

heightBall

heightBall(locale?: Locale): Promise<HeightBallData>
Parameters
- Optionallocale: Locale
Returns Promise<HeightBallData>
Deprecated
Use eightBall instead
- Defined in src/PlumeAPI.ts:98

hugo

hugo(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:486

interaction

interaction(type: InteractionType): Promise<InteractionData>
Parameters
- type: InteractionType
Returns Promise<InteractionData>
- Defined in src/PlumeAPI.ts:373

invert

invert(url: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- url: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:444

ipInfo

ipInfo(ip: string): Promise<IPInfoData>
Parameters
- ip: string
Returns Promise<IPInfoData>
- Defined in src/PlumeAPI.ts:225

iss

iss(): Promise<ISSData>
Returns Promise<ISSData>
- Defined in src/PlumeAPI.ts:123

issImage

issImage(circle?: boolean): Promise<Buffer<ArrayBufferLike>>
Parameters
- Optionalcircle: boolean
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:118

jail

jail(avatar: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:399

joke

joke(locale?: Locale): Promise<JokeData>
Parameters
- Optionallocale: Locale
Returns Promise<JokeData>
- Defined in src/PlumeAPI.ts:127

latex

latex(expr: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- expr: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:235

math

math(expr: string): Promise<MathData>
Parameters
- expr: string
Returns Promise<MathData>
- Defined in src/PlumeAPI.ts:132

meme

meme(): Promise<MemeData>
Returns Promise<MemeData>
- Defined in src/PlumeAPI.ts:137

minecraftAvatar

minecraftAvatar(name: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- name: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:316

minecraftBedrockServerStatus

minecraftBedrockServerStatus(
host: string,
): Promise<MinecraftBedrockServerStatus>
Parameters
- host: string
Returns Promise<MinecraftBedrockServerStatus>
- Defined in src/PlumeAPI.ts:341

minecraftBody

minecraftBody(name: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- name: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:321

minecraftID

minecraftID(name: string): Promise<MinecraftIDData>
Parameters
- name: string
Returns Promise<MinecraftIDData>
- Defined in src/PlumeAPI.ts:326

minecraftJavaServerStatus

minecraftJavaServerStatus(host: string): Promise<MinecraftJavaServerStatus>
Parameters
- host: string
Returns Promise<MinecraftJavaServerStatus>
- Defined in src/PlumeAPI.ts:346

minecraftLatestVersions

minecraftLatestVersions(): Promise<MinecraftLatestVersions>
Returns Promise<MinecraftLatestVersions>
- Defined in src/PlumeAPI.ts:351

minecraftName

minecraftName(id: string): Promise<MinecraftNameData>
Parameters
- id: string
Returns Promise<MinecraftNameData>
- Defined in src/PlumeAPI.ts:331

minecraftSkin

minecraftSkin(name: string): Promise<MinecraftSkinData>
Parameters
- name: string
Returns Promise<MinecraftSkinData>
- Defined in src/PlumeAPI.ts:336

minecraftVersions

minecraftVersions(): Promise<MinecraftVersions>
Returns Promise<MinecraftVersions>
- Defined in src/PlumeAPI.ts:355

nasaAPOD

nasaAPOD(): Promise<NasaAPOD>
Returns Promise<NasaAPOD>
- Defined in src/PlumeAPI.ts:141

nokia

nokia(url: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- url: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:404

nothing

nothing(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:491

npm

npm(name: string): Promise<NPMData>
Parameters
- name: string
Returns Promise<NPMData>
- Defined in src/PlumeAPI.ts:145

oogway

oogway(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:496

pepeHug

pepeHug(avatar: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:501

plusCode

plusCode(
    lat: number,
    lon: number,
    code_length?: PlusCodeLength,
): Promise<PlusCodeData>
Parameters
- lat: number
- lon: number
- Optionalcode_length: PlusCodeLength
Returns Promise<PlusCodeData>
- Defined in src/PlumeAPI.ts:230

qrcode

qrcode(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:240

quote

quote(locale?: Locale): Promise<QuoteData>
Parameters
- Optionallocale: Locale
Returns Promise<QuoteData>
- Defined in src/PlumeAPI.ts:150

randomColor

randomColor(): Promise<ColorData>
Returns Promise<ColorData>
- Defined in src/PlumeAPI.ts:178

randomEmojiMix

randomEmojiMix(): Promise<RandomEmojiMixData>
Returns Promise<RandomEmojiMixData>
- Defined in src/PlumeAPI.ts:155

rank

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<ArrayBufferLike>>
Parameters
- avatar: string
- global_name: string
- username: string
- level: number
- xp: number
- max_xp: number
- Optionalrank: number
- Optionalbg_url: string
- Optionalbg_color: string
- Optionalblur: boolean
- Optionalcolor: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:548

reverseText

reverseText(text: string): Promise<ReverseTextData>
Parameters
- text: string
Returns Promise<ReverseTextData>
- Defined in src/PlumeAPI.ts:245

robloxID

robloxID(name: string): Promise<RobloxIDData>
Parameters
- name: string
Returns Promise<RobloxIDData>
- Defined in src/PlumeAPI.ts:361

robloxUser

robloxUser(name: string): Promise<RobloxUserData>
Parameters
- name: string
Returns Promise<RobloxUserData>
- Defined in src/PlumeAPI.ts:366

rotate

rotate(url: string, deg: number): Promise<Buffer<ArrayBufferLike>>
Parameters
- url: string
- deg: number
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:449

sadcat

sadcat(top: string, bottom: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- top: string
- bottom: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:506

screenshot

screenshot(url: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- url: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:250

stonks

stonks(avatar: string, stonks?: boolean): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar: string
- Optionalstonks: boolean
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:511

tableFlip

tableFlip(avatar: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:516

translate

translate(text: string, to: string): Promise<TranslateData>
Parameters
- text: string
- to: string
Returns Promise<TranslateData>
- Defined in src/PlumeAPI.ts:255

tweet(
    avatar: string,
    name: string,
    username: string,
    text: string,
    retweets?: number,
    quote_tweets?: number,
    likes?: number,
): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar: string
- name: string
- username: string
- text: string
- Optionalretweets: number
- Optionalquote_tweets: number
- Optionallikes: number
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:409

upsideDown

upsideDown(text: string): Promise<UpsideDownTextData>
Parameters
- text: string
Returns Promise<UpsideDownTextData>
- Defined in src/PlumeAPI.ts:159

urban

urban(word: string): Promise<UrbanData>
Parameters
- word: string
Returns Promise<UrbanData>
- Defined in src/PlumeAPI.ts:164

uuid

uuid(): Promise<UUIDData>
Returns Promise<UUIDData>
- Defined in src/PlumeAPI.ts:260

wanted

wanted(avatar: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:422

water

water(text: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- text: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:521

weather

weather(city: string): Promise<WeatherData>
Parameters
- city: string
Returns Promise<WeatherData>
- Defined in src/PlumeAPI.ts:264

welcome

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<ArrayBufferLike>>
Parameters
- avatar: string
- text1: string
- Optionaltext2: string
- Optionaltext3: string
- Optionalbg_url: string
- Optionalbg_color: string
- Optionalfont_color: string
- Optionalblur: boolean
- Optionalavatar_border: boolean
- Optionalavatar_border_color: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:577

wikipedia

wikipedia(page: string, locale?: Locale): Promise<WikipediaData>
Parameters
- page: string
- Optionallocale: Locale
Returns Promise<WikipediaData>
- Defined in src/PlumeAPI.ts:269

woosh

woosh(avatar: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- avatar: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/PlumeAPI.ts:526

Properties

`Readonly`rest

rest: PlumeAPIREST

Class PlumeAPI

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns PlumeAPI

Methods

achievement

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

advice

Parameters

Returns Promise<AdviceData>

agify

Parameters

Returns Promise<AgifyData>

alert

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

asciiImage

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

asciiText

Parameters

Returns Promise<AsciiData>

blur

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

boost

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

captcha

Returns Promise<{ code: string; image: Buffer }>

caution

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

challenge

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

changeMyMind

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

color

Parameters

Returns Promise<ColorData>

colorify

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

colorImage

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

couple

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

crypto

Parameters

Returns Promise<CryptoData>

decode

Parameters

Returns Promise<DecodeData>

definition

Parameters

Returns Promise<DefinitionData>

didYouMean

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

drake

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

duck

Returns Promise<Buffer<ArrayBufferLike>>

duolingo

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

eightBall

Parameters

Returns Promise<HeightBallData>