bee-jokes is a lightweight TypeScript/JavaScript package that delivers clean, categorized, and multilingual jokes — fast and ready to sting your apps with humor!
npm install bee-jokes!Logo
bash
md my-project
cd my-project
npm install bee-jokes
`
💿 Usage/Examples
`javascript
import { Joke } from 'bee-jokes';
// const {Joke} = require("bee-jokes")
const joke = new Joke();
const my_joke = joke.getJoke({});
console.log(my_joke);
/* Output
{
"id": "travel-001",
"joke": "I used to be a travel agent, but I gave it up. It was just too much baggage.",
"category": "travel",
"langCode": "en",
"tags": ["agent", "luggage", "pun"]
} */
`
🧰 All functions
Usage and paramter list of all avilable functions
$3
Retrieves a joke by its unique ID.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const my_joke = joke.getJokeById('programming-001');
console.log(my_joke);
/* Output
{
"id": "programming-001",
"joke": "Why do programmers prefer dark mode? Because light attracts bugs.",
"category": "programming",
"langCode": "en",
"tags": ["bugs", "dark-mode", "developer"]
} */
`
| Parameter | Type | required | Description |
| --------- | -------- | -------- | ------------------------------- |
| id | string | True | The ID of the joke to retrieve. |
Returns: IJoke | null — The matching joke object if found, otherwise null.
$3
Retrieves all jokes.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const all_jokes = joke.getAllJokes();
console.log(all_jokes);
/* Output
[
{
"id": "programming-001",
"joke": "Why do programmers prefer dark mode? Because light attracts bugs.",
"category": "programming",
"langCode": "en",
"tags": ["bugs", "dark-mode", "developer"]
},
{
"id": "travel-001",
"joke": "I used to be a travel agent, but I gave it up. It was just too much baggage.",
"category": "travel",
"langCode": "en",
"tags": ["agent", "luggage", "pun"]
}
...
] */
`
| Parameter | Type | required | Description |
| --------- | ---- | -------- | ---------------------------------- |
| - | - | - | This function takes no parameters. |
Returns: IJoke[] | null — The matching joke object if found, otherwise null.
$3
Retrieves a single joke based on the specified category and language.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const my_joke = joke.getJoke({ category: 'programming', lang: 'en' });
console.log(my_joke);
/* Output
{
"id": "programming-001",
"joke": "Why do programmers prefer dark mode? Because light attracts bugs.",
"category": "programming",
"langCode": "en",
"tags": ["bugs", "dark-mode", "developer"]
} */
`
| Parameter | Type | required | Description |
| ---------- | -------- | -------- | ------------------------------------------------------------------------- |
| category | string | False | The category of the joke (defaults to a random category if not provided). |
| lang | string | False | The language code for the joke (defaults to "en" if not provided). |
Returns: IJoke | null — The matching joke object if found, otherwise null.
$3
Retrieves multiple jokes based on the specified category, language, and range.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const jokes = joke.getManyJokes({ category: 'programming', lang: 'en', range: 5 });
console.log(jokes);
/* Output
[
{
"id": "programming-001",
"joke": "Why do programmers prefer dark mode? Because light attracts bugs.",
"category": "programming",
"langCode": "en",
"tags": ["bugs", "dark-mode", "developer"]
},
{
"id": "programming-002",
"joke": "Why do programmers always mix up Halloween and Christmas? Because Oct 31 == Dec 25!",
"category": "programming",
"langCode": "en",
"tags": ["dates", "binary", "developer"]
},
...
] */
`
| Parameter | Type | required | Description |
| ---------- | -------- | -------- | ------------------------------------------------------------------------- |
| category | string | False | The category of the joke (defaults to a random category if not provided). |
| lang | string | False | The language code for the joke (defaults to "en" if not provided). |
| range | number | False | The maximum number of jokes to return (defaults to 10) |
Returns: IJoke[] | null — The matching joke object if found, otherwise null.
$3
Retrieves jokes that contain at least one of the specified keyword tags.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const jokes = joke.getJokeByKeyword(['bugs', 'developer'], 5);
console.log(jokes);
/* Output
[
{
"id": "programming-001",
"joke": "Why do programmers prefer dark mode? Because light attracts bugs.",
"category": "programming",
"langCode": "en",
"tags": ["bugs", "dark-mode", "developer"]
},
...
]
*/
`
| Parameter | Type | required | Description |
| --------- | -------- | -------- | ------------------------------------------------------ |
| tags | array | true | An array of keyword tags to match against joke tags. |
| range | number | False | The maximum number of jokes to return (defaults to 10) |
$3
Retrieves a random joke in the specified language.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const randomJoke = joke.getRandomJoke('en');
console.log(randomJoke);
/* Output
{
"id": "programming-002",
"joke": "Why do programmers always mix up Halloween and Christmas? Because Oct 31 == Dec 25!",
"category": "programming",
"langCode": "en",
"tags": ["dates", "binary", "developer"]
}
*/
`
| Parameter | Type | required | Description |
| --------- | -------- | -------- | ------------------------------------------------------------------ |
| lang | string | False | The language code for the joke (defaults to "en" if not provided). |
Returns: IJoke | null — The matching joke object if found, otherwise null.
$3
Retrieves a list of safe jokes based on the specified category, language, and range.
Safe jokes are filtered using the filterSafeJokes utility.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const safeJokes = joke.getSafeJokes({ category: 'programming', lang: 'en', range: 5 });
console.log(safeJokes);
/* Output
{
"id": "programming-002",
"joke": "Why do programmers always mix up Halloween and Christmas? Because Oct 31 == Dec 25!",
"category": "programming",
"langCode": "en",
"tags": ["dates", "binary", "developer"]
}
*/
`
| Parameter | Type | required | Description |
| ---------- | -------- | -------- | ------------------------------------------------------------------------- |
| category | string | False | The category of the joke (defaults to a random category if not provided). |
| lang | string | False | The language code for the joke (defaults to "en" if not provided). |
| range | number | False | The maximum number of jokes to return (defaults to 10) |
Returns: IJoke[] | null — The matching joke object if found, otherwise null.
$3
Retrieves the list of supported languages.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const languages = joke.getLanguages();
console.log(languages);
/* Output
[
{
"name": "programming",
"description": "Jokes for developers, coders, and software engineers."
},
{
"name": "general",
"description": "Light-hearted and everyday jokes for everyone."
},
{
"name": "dadjokes",
"description": "Classic groan-worthy dad jokes and puns."
},
...
]
*/
`
| Parameter | Type | required | Description |
| --------- | ---- | -------- | ---------------------------------- |
| - | - | - | This function takes no parameters. |
Returns: ILanguage[] | null — An array of language objects, each containing a language code and its corresponding name..
$3
Retrieves the list of available joke categories.
`javascript
import { Joke } from 'bee-jokes';
const joke = new Joke();
const categories = joke.getCategories();
console.log(categories);
/* Output
[
{ "code": "en", "language": "English" },
{ "code": "hi", "language": "Hindi" },
{ "code": "es", "language": "Spanish" },
...
]
*/
`
| Parameter | Type | required | Description |
| --------- | ---- | -------- | ---------------------------------- |
| - | - | - | This function takes no parameters. |
Returns: ICategory[] | null — An array of category objects, each containing the category name..
🤝 Contribution
Contributions are welcome and appreciated!
If you have suggestions for improvements, feel free to open an issue or submit a pull request.
Let’s make bee-jokes better together! 🐝✨
🚀 Run Locally
Clone the project
`bash
git clone https://github.com/sandeep-shome/bee-jokes.git
`
Go to the project directory
`bash
cd my-project
`
🔧 Install dependencies
`bash
npm install
`
_You can now explore and modify the package as per your needs._
📦 Build the Project
`bash
npm run build
`
🧪 Running Tests
To run tests, run the following command
`bash
npm run test
``