frankerfacez
TypeScript icon, indicating that this package has built-in type declarations

0.1.1 • Public • Published

💬 FrankerFaceZ (FFZ) API

Unofficial FrankerFaceZ API Wrapper for Node.js

⚙️ Installation

# With YARN:
yarn add frankerfacez

# With NPM:
npm install frankerfacez

📚 Usage

Get user data and emotes

import FrankerFaceZ from "frankerfacez";

FrankerFaceZ.getGlobalEmotes()
    .then(console.log);
// Returns Emote[],

📦 Interfaces

Emote

{
  "id": string,
  "code": string,
  "imageType": "png" | "gif",
  "animated": boolean,
  "src": {
    "low": string,
    "mid": string,
    "high": string,
  },
  "userId?": string,
  "user?": {
    "id": string,
    "name": string,
    "displayName": string,
    "providerId": string
  }
}

❤️

Made with Love by Sammwy, Donate at PayPal

Package Sidebar

Install

npm i frankerfacez

Weekly Downloads

6

Version

0.1.1

License

MIT

Unpacked Size

14.6 kB

Total Files

28

Last publish

Collaborators

  • sammwy