feat(boolean): add randomBool (#55)

* feat: implement randomBool()

* test: add tests for randomBool()

* chore: export boolean functions

* docs: add random-bool page

* docs: add boolean page directory

* fix: add file extension to import for ESM support

Co-authored-by: Alireza Safaierad <[email protected]>

* fix: add file extension to import for ESM support

Co-authored-by: Alireza Safaierad <[email protected]>

* fix wrong import path to randomInt

---------

Co-authored-by: Alireza Safaierad <[email protected]>

docs/pages/boolean.mdx

@@ -0,0 +1,6 @@
+# Boolean
+
+import meta from './boolean/_meta.json';
+import { TOC } from '../components/TOC.tsx';
+
+<TOC base="/boolean" meta={meta} />

docs/pages/boolean/_meta.json

@@ -0,0 +1,3 @@
+{
+  "random-bool": "randomBool"
+}

docs/pages/boolean/random-bool.mdx

@@ -0,0 +1,21 @@
+# randomBool
+
+Generate a random boolean. (true or false)
+
+### Import
+
+```typescript copy
+import { randomBool } from '@fullstacksjs/toolbox';
+```
+
+### Signature
+
+```typescript copy
+function randomBool(): boolean {}
+```
+
+### Examples
+
+```typescript copy
+randomBool()  // true | false
+```

mod.ts

@@ -1,4 +1,5 @@
 export * from './src/array/index.ts';
+export * from './src/boolean/index.ts';
 export * from './src/error/index.ts';
 export * from './src/function/index.ts';
 export * from './src/node/index.ts';

src/boolean/index.ts

@@ -0,0 +1 @@
+export { randomBool } from './randomBool.ts';

src/boolean/randomBool.spec.ts

@@ -0,0 +1,29 @@
+import { randomBool } from './randomBool';
+
+describe('randomBool', () => {
+  it('should return an boolean', () => {
+    for (let i = 0; i < 100; i++) {
+      const boolean = randomBool();
+
+      expect(boolean).toBeTypeOf('boolean');
+    }
+  });
+
+  it('should select the first item', () => {
+    let i = 0;
+
+    // eslint-disable-next-line jest/no-conditional-in-test
+    for (; i < 100; i++) if (randomBool()) break;
+
+    expect(i).toBeLessThan(100);
+  });
+
+  it('should select the last item', () => {
+    let i = 0;
+
+    // eslint-disable-next-line jest/no-conditional-in-test
+    for (; i < 100; i++) if (!randomBool()) break;
+
+    expect(i).toBeLessThan(100);
+  });
+});

src/boolean/randomBool.ts

@@ -0,0 +1,14 @@
+import { randomInt } from '../number/randomInt.ts';
+
+/**
+ * Generate a random boolean.
+ *
+ * @returns {boolean} random boolean
+ *
+ * @example
+ *
+ * randomBool()     // Returns true or false
+ */
+export function randomBool(): boolean {
+  return !!randomInt(0, 1);
+}

src/index.ts

@@ -1,4 +1,5 @@
 export * from './array/index.ts';
+export * from './boolean/index.ts';
 export * from './error/index.ts';
 export * from './function/index.ts';
 export * from './guards/index.ts';