@falsejs/falsejs 1.1.0 → 3.0.0

package/README.md

@@ -55,15 +55,33 @@ The third argument, `shouldDoSomethingAsyncWithIsTenThousand`, is whether `is-te
 
 The fourth and fifth 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 sixth argument, `strictDisableAprilFoolsSideEffectsCheck`, is `"no"`.
 
+And the last argument is the compatibility mode argument. This one has its own section about how it works which is after the example.
+
 ## Example
 
 ```javascript
 const falsejs = require("@falsejs/falsejs").default
-const falseValue = falsejs.False("yes", "no", "no", "yes", "yes", "no", "no") // outputs a bunch of logs
+const falseValue = falsejs.False("yes", "yes", "yes", "yes", "yes", "no", falsejs.COMPATIBILITY_MODE.NONE) // outputs a bunch of logs
 
 console.log(falseValue) // outputs false
 ```
 
+## Legacy Compatibility Modes
+To ensure the integrity of the returned boolean across every known runtime environment since the dawn of the internet, the `falsejs.False` function supports an optional `compatibilityMode` argument. The checks performed may seem CPU-intensive and unnecessary, but they guarantee that the runtime environment is free of historical browser quirks that could threaten the stable return value of false.
+
+Here's an example:
+```javascript
+const myIE5CompatibleFalseValue = falsejs.False("yes", "yes", "yes", "yes", "yes", "no", falsejs.COMPATIBILITY_MODE.IE5) // Using IE5 compatibility mode
+```
+
+| Mode | Description | Possible Side Effects |
+|----------|----------|----------|
+| `falsejs.COMPATIBILITY_MODE.NONE` | Standard modern behavior | No side effects and extra checks for legacy compatibility. |
+| `falsejs.COMPATIBILITY_MODE.IE5` | Activates JScript Engine Coercion Guard. Runs checks to ensure `false` is not improperly converted by an emulated 1999 environment. | May increase CPU usage to simulate JScript garbage collection. |
+| `falsejs.COMPATIBILITY_MODE.NETSCAPE` | Activates the JavaScript 1.1 Type Coercion Audit. Runs extensive type-coercion validation and audits the DOM for the deprecated Netscape `<layer>` tag. | May cause computer overload due to repetitive type-coercion audits, and it may cause memory leaks due to not cleaning up JSDOM.  |
+| `falsejs.COMPATIBILITY_MODE.OPERA_PRESTO` | Simulates the single-threaded nature of the Presto engine and audits the global state for known Opera non-standard features. | May cause memory leaks, and block CPU during a ~0ms latency.  |
+
+
 ## `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.
@@ -74,7 +92,7 @@ Example:
 
 ```javascript
 const falsejs = require("@falsejs/falsejs").default
-const falseValue = falsejs.False("no", "no", "no")
+const falseValue = falsejs.False("yes", "yes", "yes", "yes", "yes", "no", falsejs.COMPATIBILITY_MODE.NONE)
 const trueValue = require("true-value")
 
 console.log(falsejs.isFalse(falseValue)) // true
@@ -124,7 +142,7 @@ falsejs.injectIntojQuery()
 
 const $ = jQuery
 
-const myFalseValue = $.False("no", "no", "no", "yes", "yes", "no", "no")
+const myFalseValue = $.False("yes", "yes", "yes", "yes", "yes", "no", falsejs.COMPATIBILITY_MODE.NONE)
 console.log(myFalseValue) // false
 console.log($.isFalse(myFalseValue)) // true
 ```
@@ -144,7 +162,7 @@ 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
+  res.send(req.isFalse(req.False("yes", "yes", "yes", "yes", "yes", "no", falsejs.COMPATIBILITY_MODE.NONE)) // sends true to the client
 })
 
 app.listen(PORT)
@@ -181,7 +199,8 @@ const falseValue = falsejs.False(
   "no" /*the first three options you can choose, for examples we set them all to "no"*/,
   disableAprilFoolsSideEffects,
   disableAprilFoolsSideEffects,
-  disableChecking
+  disableChecking,
+  falsejs.COMPATIBILITY_MODE.NETSCAPE // for this example we'll use netscape compatibility mode
 )
 
 // or you can do this, but the above is better
@@ -192,7 +211,8 @@ const falseValue = falsejs.False(
   "no" /*the first three options you can choose, for examples we set them all to "no"*/,
   "yes",
   "yes",
-  "no"
+  "no",
+  falsejs.COMPATIBILITY_MODE.NETSCAPE // for this example we'll use netscape compatibility mode
 )
 ```
 
@@ -222,9 +242,4 @@ FalseJS uses the MIT license.
 
 
 
-
-
-please help me i am going insane
-
-
-
+Making this was very hard, but I was dedicated and now there's a 3000-line long library just to return false. Please help me. Please.

package/biome.json

@@ -6,10 +6,6 @@
     "clientKind": "git",
     "useIgnoreFile": true
   },
-
-	"files": {
-		"ignoreUnknown": false
-	},
 	"formatter": {
 		"enabled": true,
 		"formatWithErrors": false,
@@ -53,5 +49,13 @@
 				"organizeImports": "off"
 			}
 		}
-	}
+	},
+	"files": {
+    "includes": [
+      "**",
+      "!dist/**",
+      "!node_modules/**"
+    ],
+		"ignoreUnknown": false
+  }
 }

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+/** biome-ignore-all lint/complexity/noStaticOnlyClass: BRO ITS A D.TS FILE */
+type COMPATIBILITY_MODE_PARAM = "none" | "ie5" | "netscape" | "opera_presto";
+
+export default class falsejs {
+
+  static COMPATIBILITY_MODE: {
+    readonly NONE: "none",
+    readonly IE5: "ie5",
+    readonly NETSCAPE: "netscape",
+    readonly OPERA_PRESTO: "opera_presto"
+  }
+
+  /**
+   * Returns false from the given parameters.
+   *
+   * @param {"yes"|"no"} loggingEnabled - Indicates whether logging should be enabled.
+   * @param {"yes"|"no"} shouldDoSomethingAsync - A pointless option that indicates whether something should be done asynchronously that just waits 200ms before saying "Did something async"
+   * @param {"yes"|"no"} shouldDoSomethingAsyncWithIsTenThousand - Indicates whether something should be done asynchronously when checking the self equality of 10,000 using the isTenThousand module (credits to james-work-account)
+   * @param {"yes"|"no"} disableAprilFoolsSideEffects - Indicates whether April Fools side effects should be disabled.
+   * @param {"yes"|"no"} definitelyDisableAprilFoolsSideEffects - Indicates whether April Fools side effects should be definitely disabled.
+   * @param {"yes"|"no"} strictDisableAprilFoolsSideEffectsCheck - Indicates whether strict checking for disabling April Fools side effects should be enabled.
+   * @param {"none"|"ie5"|"netscape"|"opera_presto"} compatibilityMode - The compatibility mode for various legcay browser environments.
+   * @returns {boolean} - The calculated boolean value 'false'.
+   */
+  static False(
+    loggingEnabled?: "yes" | "no",
+    shouldDoSomethingAsync?: "yes" | "no",
+    shouldDoSomethingAsyncWithIsTenThousand?: "yes" | "no",
+    disableAprilFoolsSideEffects?: "yes" | "no",
+    definitelyDisableAprilFoolsSideEffects?: "yes" | "no",
+    strictDisableAprilFoolsSideEffectsCheck?: "yes" | "no",
+    compatibilityMode?: COMPATIBILITY_MODE_PARAM
+  ): boolean
+
+  /**
+   * Checks if a given value is false.
+   *
+   * @param {any} value - The value to be checked.
+   * @returns {boolean} - True if the value is false, false otherwise.
+   */
+
+  static isFalse(value: any, loggingEnabled?: "yes" | "no"): boolean
+
+  static injectIntojQuery(): void
+  static expressMiddleware(req: any, res: any, next: any): void
+}