FalseJS

Better than the keyword itself.

Ever wondered what would happen if JavaScript changed the false keyword to something else, like no, nope, noway, or something else? Chaos. That is what FalseJS is for.

The 10 attempts to get the value of false ensure that if one fails, it will go on to the next, so if JavaScript breaks one, there will still be more attempts. This is an alternative to the library false by mde, which uses the hardcoded boolean value false (which I believe they are trying to resolve on the sister library true, which will probably be passed down to the false library), and is way too short. FalseJS is way better.

Installation

Install FalseJS with your favorite package manager.

NPM: npm install falsejs

Yarn: yarn add falsejs

PNPM: pnpm add falsejs

Import it with require:

const falsejs = require("falsejs").default

Import it with import:

import falsejs from "falsejs"

Usage

falsejs.False is a function that calculates the boolean value false and returns it. It takes three arguments.

function False(
  loggingEnabled?: "yes" | "no",
  shouldDoSomethingAsync?: "yes" | "no",
  shouldDoSomethingAsyncWithIsTenThousand?: "yes" | "no",
  disableAprilFoolsSideEffects?: "yes" | "no",
  definitelyDisableAprilFoolsSideEffects?: "yes" | "no",
  strictDisableAprilFoolsSideEffectsCheck?: "yes" | "no",
  openRandomImageOfDofleWhenDone?: "yes" | "no"
): boolean

The first argument is loggingEnabled, which is whether to output useful and funny logs or not. This can be "yes" or "no". Some logs may still be output even when you pass in "no", because FalseJS uses other libraries that may log things without user consent. "yes" and "no" are basically true and false, except the whole reason you're calling the function is to get a boolean, so it wouldn't make sense to pass in a boolean.

The second argument, shouldDoSomethingAsync, is whether FalseJS should do an asyncronhous promise-based setTimeout and when it's done, if logging is enabled, output [falsejs] Did something async in green. This is just a pointless feature that is by default "no", because it can be "yes" or "no".

The third argument, shouldDoSomethingAsyncWithIsTenThousand, is whether is-ten-thousand, a package used by FalseJS, should have an asynchronous promise-based setTimeout before it checks if a value is 10,000. It can be "yes" or "no".

The third and fourth arguments, disableAprilFoolsSideEffects and definitelyDisableAprilFoolsSideEffects, can be "yes" or "no". Both of them have to be "yes" to bypass the side effects of it being April Fools? What side effects, you may ask? Well, let's just say, FalseJS does something different on April Fools. If these are enabled when it's not April Fools, then an error will be thrown, unless the fifth argument, strictDisableAprilFoolsSideEffectsCheck, is "no".

The sixth argument, openRandomImageOfDofleWhenDone, can be "yes" or "no". If it is "yes", then a random image of Sindre Sorhus's cat Dofle will be opened after false is calculated.

Example

const falsejs = require("falsejs").default
const falseValue = falsejs.False("yes", "no", "no", "yes", "yes", "no", "no") // outputs a bunch of logs

console.log(falseValue) // outputs false

isFalse function

FalseJS also exports a function called isFalse, which returns true if the value is false, otherwise false. This can be used to test whether FalseJS worked and returned false (like it wouldn't, so there's no need to do that). falsejs.isFalse just takes in a value and returns true if the value is false.

It takes in too parameters, the value to check whether it is false, and loggingEnabled which can be "yes" or "no".

Example:

const falsejs = require("falsejs").default
const falseValue = falsejs.False("no", "no", "no")
const trueValue = require("true-value")

console.log(falsejs.isFalse(falseValue)) // true
console.log(falsejs.isFalse(false)) // probably true
console.log(falsejs.isFalse(trueValue)) // false
console.log(falsejs.isFalse("hi")) // false

falsejs.isFalse can also be used as an alternative to running the falsejs.False function and instead just passing a value that isn't false into falsejs.isFalse.

CLI

NPM:

npm install -g falsejs

Yarn:

yarn add -g falsejs

PNPM:

pnpm add -g falsejs

FalseJS provides a CLI.

$ npm install -g falsejs
$ false
false

jQuery plugin

A jQuery plugin is also provided for FalseJS. Here is an example:

const falsejs = require("falsejs").default
global.jQuery = require("jquery")
falsejs.injectIntojQuery()

const $ = jQuery

const myFalseValue = $.False("no", "no", "no", "yes", "yes", "no")
console.log(myFalseValue) // false
console.log($.isFalse(myFalseValue)) // true

Express middleware

Express middleware is also exported. Here is an example:

const express = require("express")
const falsejs = require("falsejs").default
const Bro = require("brototype")

const app = express()
const PORT = Bro(process).doYouEven("env.PORT") ? process.env.PORT : 3000

app.use(falsejs.expressMiddleware)

app.get("/", (req, res) => {
  res.send(req.isFalse(req.False())) // sends true to the client haha! i got out!
})

app.listen(PORT)

April Fools Behavior

Not April Fools Day

• FalseJS will return false by default.
• The flags disableAprilFoolsSideEffects and definitelyDisableAprilFoolsSideEffects do not affect the behavior of FalseJS. It behaves normally as it would on any non-April Fools' Day.
  • However, if strictDisableAprilFoolsSideEffectsCheck is not no" and instead "yes" (by default it's "yes"), it will throw an error if these options are set to "yes", because it's not April Fools' Day, and there are no side effects to disable.
  • If strictDisableAprilFoolsSideEffectsCheck is set to "no", FalseJS behaves normally without throwing an error, even if the side effect parameters are set to "yes".

April Fools Day

• On April Fools' Day, FalseJS always returns true, regardless of the state of the flags.
• To prevent this behavior, you must set both disableAprilFoolsSideEffects to "yes" and definitelyDisableAprilFoolsSideEffects to "yes" when you call FalsejS.
  • If these flags are set to "yes", FalseJS will return its expected behavior (return false), even on April Fools' Day.

Best Usage For April Fools Behavior

This usage ensures that you will always get false whether it's April Fools or not and no errors.

const falsejs = require("falsejs").default
const isAprilFools = require("is-april-fools")
const disableAprilFoolsSideEffects = isAprilFools() ? "yes" : "no"

const falseValue = falsejs.False(
  "no",
  "no",
  "no" /*the first three options you can choose, for examples we set them all to "no"*/,
  disableAprilFoolsSideEffects,
  disableAprilFoolsSideEffects,
  "yes"
)

// or you can do this, but the above is better

const falseValue = falsejs.False(
  "no",
  "no",
  "no" /*the first three options you can choose, for examples we set them all to "no"*/,
  "yes",
  "yes",
  "no"
)

Related Projects

• true-value (the sister project)
• false
• true
• alternative-true
• undefined-is-a-function

License

FalseJS uses the 10xGPWTHPL license.

made with HEAVY BLACK HEART U+2764