https://github.com/AlexLakatos/computer-puns

A hand-picked selection of the worst computer puns, really cringe-worthy stuff.
https://github.com/AlexLakatos/computer-puns

computer-puns hacktoberfest hacktoberfest2019 hacktoberfest2020 hacktoberfest2021 hacktoberfest2022 jokes jokes-module puns

Last synced: about 2 months ago
JSON representation

A hand-picked selection of the worst computer puns, really cringe-worthy stuff.

• Host: GitHub
• URL: https://github.com/AlexLakatos/computer-puns
• Owner: AlexLakatos
• License: gpl-3.0
• Created: 2019-03-02T15:39:33.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-19T19:32:47.000Z (11 months ago)
• Last Synced: 2024-04-23T23:38:35.948Z (5 months ago)
• Topics: computer-puns, hacktoberfest, hacktoberfest2019, hacktoberfest2020, hacktoberfest2021, hacktoberfest2022, jokes, jokes-module, puns
• Language: JavaScript
• Homepage: https://puns.dev
• Size: 997 KB
• Stars: 100
• Watchers: 5
• Forks: 59
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# https://puns.dev

A hand-picked selection of the worst computer puns, really cringe worthy stuff.

Submit your own at the bottom of `puns.json` and if they make me cringe, I'll merge them.

> I'm keeping these [gender-neutral](https://en.wikipedia.org/wiki/Gender-neutral_language), a programmer isn't automatically a "he", so please use the [singular they](https://en.wikipedia.org/wiki/Singular_they) pronoun when refering to a person in the puns.

## Node.js Package

[![Build Status](https://travis-ci.org/AlexLakatos/computer-puns.svg?branch=master)](https://travis-ci.org/AlexLakatos/computer-puns)

[![codecov](https://codecov.io/gh/AlexLakatos/computer-puns/branch/master/graph/badge.svg)](https://codecov.io/gh/AlexLakatos/computer-puns)

 [![Known Vulnerabilities](https://snyk.io/test/github/alexlakatos/computer-puns/badge.svg)](https://snyk.io/test/github/alexlakatos/computer-puns)

Also a Node.js package available on NPM and the GitHub registry.

### Install

`npm install puns.dev`

### Usage

```JavaScript

const puns = require("puns.dev");

```

### Methods

#### `.all`

```JavaScript

puns.all()

```

Returns an array of puns:

```JavaScript

[{

  "pun": "Q: How do you comfort a JavaScript bug?",

  "punchline": "A: You console it!"

}]

```

#### `.random`

```JavaScript

puns.random()

```

Returns a pun, as well as the random id that was generated:

```

{

  "pun": "Q: How do you comfort a JavaScript bug?",

  "punchline": "A: You console it!"

  "id": 7

}

```

#### `.get`

```JavaScript

puns.get(id)

```

Returns the pun from the id in the pun list:

```JavaScript

{

  "pun": "Q: How do you comfort a JavaScript bug?",

  "punchline": "A: You console it!"

}

```

#### `.search`

```JavaScript

puns.search([keyword])

```

Returns a list of puns matching the list of keywords:

```JavaScript

[{

  "pun": "Q: How do you comfort a JavaScript bug?",

  "punchline": "A: You console it!"

}]

```

## Node.js CLI

TBD