Skip to content

AlexanderKugler/IsWambo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 

Repository files navigation

Wambo Checker 🕵️‍♀️🧽

A lightweight NPM package that checks if a string is 'Wambo' or if it isn't. Inspired by the legendary scene from SpongeBob SquarePants, this tool is perfect for all fans of Patrick, Mermaid Man, and the science of Wambology! 🐚🦸‍♂️

Installation 📦

Install the package via NPM:

Socket Badge

npm i is-wambo

Usage 🚀

Import the package and use the functions:

const { isWambo, isNotWambo, isWamboCaseSensitive, isNotWamboCaseSensitive, isWamboWithCapitalW, isNotWamboWithCapitalW } = require('is-wambo');

console.log(isWambo('Wambo')); // true
console.log(isWambo('wumbo')); // false

console.log(isNotWambo('Wambo')); // false
console.log(isNotWambo('wumbo')); // true

console.log(isWamboCaseSensitive('wambo')); // true
console.log(isWamboCaseSensitive('Wambo')); // false

console.log(isNotWamboCaseSensitive('wambo')); // false
console.log(isNotWamboCaseSensitive('Wambo')); // true

console.log(isWamboWithCapitalW('Wambo')); // true
console.log(isWamboWithCapitalW('wambo')); // false

console.log(isNotWamboWithCapitalW('Wambo')); // false
console.log(isNotWamboWithCapitalW('wambo')); // true

Why Wambo? 🤔

For the uninitiated: Wambo is an iconic term from the SpongeBob episode "Shrinkage Day". Patrick explains to SpongeBob the versatile application of Wambo:

"I wambo, you wambo, he/she/it wambos; wambo, to wambo, wamboing, have wamboed... Wamborama, Wambology, the study of Wambo. It's first-grade, SpongeBob!"

Features ✨

  • Simple: Just one function! Check if your input is Wambo.
  • Lightweight: Minimal code, maximum fun.
  • Nostalgic: For everyone who grew up with SpongeBob and Patrick.

API 🛠️

isWambo(input: string): boolean

  • input: The string to be checked.
  • Return value: Returns true if the string is Wambo (case-insensitive), otherwise false.

isNotWambo(input: string): boolean

  • input: The string to be checked.
  • Return value: Returns false if the string is Wambo (case-insensitive), otherwise true.

isWamboCaseSensitive(input: string): boolean

  • input: The string to be checked.
  • Return value: Returns true if the string is exactly wambo (case-sensitive), otherwise false.

isNotWamboCaseSensitive(input: string): boolean

  • input: The string to be checked.
  • Return value: Returns false if the string is exactly wambo (case-sensitive), otherwise true.

isWamboWithCapitalW(input: string): boolean

  • input: The string to be checked.
  • Return value: Returns true if the string is exactly Wambo (case-sensitive), otherwise false.

isNotWamboWithCapitalW(input: string): boolean

  • input: The string to be checked.
  • Return value: Returns false if the string is exactly Wambo (case-sensitive), otherwise true.

License 📄

This package is released under the Apache License Version 2.0.


Wambology: It's not just science, it's a way of life. 🌈🚀