Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

node-jokes

sandeep-shome6MIT1.0.0TypeScript support: included

A free and open source library for one-liner random developer friendly jokes in node

node-jokes, jokes, one liner jokes, random jokes, node jokes

readme

node-jokes

A free and open source library for one-liner random developer friendly jokes in node

Installation

Install node-jokes with npm

npm install node-jokes

Usage/Examples

Get random joke

import NodeJoke from "node-jokes";

const joke = NodeJoke.getJoke();
console.log(joke);

Get multiple jokes

import NodeJoke from "node-jokes";

const jokes = NodeJoke.getJokes();
console.log(jokes);

Parameter Reference

Get random joke

const joke = NodeJoke.getJokes("en", "general");
Parameter Type Description
lang string Language preference
category string category preference

Get multiple jokes

const jokes = NodeJoke.getJokes(10, "en", "general");
Parameter Type Description
limit number Numbers of jokes required, default is 10
lang string Language preference
category string category preference

Parameters supports

lang

Parameter Description
en English
esp Spanish
hi Hindi
fr French
jp Japanese

category

Parameter Description
general jokes related to general category
pun jokes related to pun category
life jokes related to life category
programming jokes related to programming category
humor jokes related to humor category
knock-knock jokes related to knock-knock category

Run Locally

Clone the project

git clone https://github.com/sandeep-shome/node-jokes.git

Go to the project directory

cd my-project

Install dependencies

npm install

Start the server

npm run start

Appendix

Node-Joke is a completely free and open-source joke-as-a-service project designed for entertainment. It stores all jokes internally within the package, which can lead to limitations in the randomness of generated jokes. After delivering a few random jokes, there's a possibility of repetition.

As a solo developer, I may not be able to add as many jokes as desired. This project is currently in beta, and I aim to expand the joke library in the future. Enjoy the jokes available now!

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Authors

License

MIT