FunKitJS

A lightweight JavaScript library for jokes, dad jokes, roasts, advice, and quotes — bring fun to your Node.js and TypeScript projects.

Table of Contents

• Features
• Installation
• Quick Start
• Usage
• CLI
• API Reference
• TypeScript Support
• Project Structure
• Links
• License

Features

• 🎭 Random jokes from a curated collection
• 👨 Dad jokes for maximum cringe
• 🔥 Playful roasts for friendly banter
• 💡 Random advice and life tips
• 💬 Inspirational and motivational quotes
• 📦 Zero runtime dependencies
• ⚡ Fast and lightweight
• 🟦 Built-in TypeScript support
• 🔄 Python-style compatibility aliases
• 💻 Built-in CLI support

Installation

npm install @fmasterpro27/funkitjs

Quick Start

CommonJS

const {
  joke,
  dad_joke,
  roast,
  advice,
  quote,
  quoteData,

  get_joke,
  get_dad_joke,
  get_roast,
  get_advice,

  version,
} = require("@fmasterpro27/funkitjs");

console.log(joke());
console.log(dad_joke());
console.log(roast());
console.log(advice());

console.log(quote());
console.log(quoteData());

console.log(get_joke());
console.log(get_dad_joke());
console.log(get_roast());
console.log(get_advice());

console.log(version);

ES Modules

import {
  joke,
  dad_joke,
  roast,
  advice,
  quote,
  quoteData,
  get_joke,
  get_dad_joke,
  get_roast,
  get_advice,
  version,
} from "@fmasterpro27/funkitjs";

console.log(advice());
console.log(quote());

Usage

Joke

const { joke } = require("@fmasterpro27/funkitjs");

console.log(joke());

Dad Joke

const { dad_joke } = require("@fmasterpro27/funkitjs");

console.log(dad_joke());

Roast

const { roast } = require("@fmasterpro27/funkitjs");

console.log(roast());

Advice

const { advice } = require("@fmasterpro27/funkitjs");

console.log(advice());

Quote

const { quote } = require("@fmasterpro27/funkitjs");

console.log(quote());

Quote Data

const { quoteData } = require("@fmasterpro27/funkitjs");

console.log(quoteData());

Example output:

{
  id: 1,
  quote: "Stay hungry, stay foolish.",
  author: "Steve Jobs"
}

CLI

Install globally:

npm install -g @fmasterpro27/funkitjs

Examples:

funkit joke
funkit dad-joke
funkit roast
funkit advice

funkit quote
funkit quote-data

funkit get-joke
funkit get-dad-joke
funkit get-roast
funkit get-advice

funkit version
funkit help

API Reference

joke()

Returns a random joke.

const text = joke();

Returns:

string;

dad_joke()

Returns a random dad joke.

const text = dad_joke();

Returns:

string;

roast()

Returns a random roast.

const text = roast();

Returns:

string;

advice()

Returns a random piece of advice.

const text = advice();

Returns:

string;

quote()

Returns a random quote.

const text = quote();

Returns:

string;

quoteData()

Returns complete quote metadata.

const data = quoteData();

Returns:

{
  id: number;
  quote: string;
  author: string;
}

TypeScript Support

import {
  joke,
  dad_joke,
  roast,
  advice,
  quote,
  quoteData,
  get_joke,
  get_dad_joke,
  get_roast,
  get_advice,
  version,
} from "@fmasterpro27/funkitjs";

const text: string = advice();

Project Structure

funkitjs/
├── bin/
│   └── funkit.js
├── src/
│   ├── index.js
│   ├── jokes.js
│   ├── dad_jokes.js
│   ├── roasts.js
│   ├── advices.js
│   ├── quotes.js
│   ├── version.js
│   └── data/
│       ├── jokes.json
│       ├── dad_jokes.json
│       ├── roasts.json
│       ├── advices.json
│       └── quotes.json
├── tests/
│   ├── jokes.test.js
│   ├── roasts.test.js
│   ├── advice.test.js
│   └── quotes.test.js
├── index.d.ts
├── package.json
├── LICENSE
└── README.md

Links

• GitHub: https://github.com/Fmasterpro27/FunKitJS
• Issues: https://github.com/Fmasterpro27/FunKitJS/issues
• npm: https://www.npmjs.com/package/@fmasterpro27/funkitjs

License

This project is licensed under the Apache License 2.0.

See the LICENSE file for details.