feat(utils): add getMaybeBooleanFromRichBoolean()

src/index.ts

@@ -142,6 +142,7 @@ export { customDayjs } from './utils/customDayjs'
 export { getCoordinates, coordinatesAreDistinct } from './utils/coordinates'
 export { getHashFromCollection } from './utils/getHashFromCollection'
 export { getLocalizedDayjs } from './utils/getLocalizedDayjs'
+export { getMaybeBooleanFromRichBoolean } from './utils/getMaybeBooleanFromRichBoolean'
 export { getOptionsFromIdAndName } from './utils/getOptionsFromIdAndName'
 export { getOptionsFromLabelledEnum } from './utils/getOptionsFromLabelledEnum'
 export { getPseudoRandomString } from './utils/getPseudoRandomString'

src/utils/__tests__/getMaybeBooleanFromRichBoolean.test.ts

@@ -0,0 +1,24 @@
+import { describe, expect, it } from '@jest/globals'
+
+import { RichBoolean } from '../../constants'
+import { getMaybeBooleanFromRichBoolean } from '../getMaybeBooleanFromRichBoolean'
+
+describe('utils/getMaybeBooleanFromRichBoolean()', () => {
+  it('should return `true` for `RichBoolean.TRUE`', () => {
+    const result = getMaybeBooleanFromRichBoolean(RichBoolean.TRUE)
+
+    expect(result).toBe(true)
+  })
+
+  it('should return `false` for `RichBoolean.FALSE`', () => {
+    const result = getMaybeBooleanFromRichBoolean(RichBoolean.FALSE)
+
+    expect(result).toBe(false)
+  })
+
+  it('should return `undefined` for `RichBoolean.BOTH`', () => {
+    const result = getMaybeBooleanFromRichBoolean(RichBoolean.BOTH)
+
+    expect(result).toBeUndefined()
+  })
+})

src/utils/getMaybeBooleanFromRichBoolean.ts

@@ -0,0 +1,14 @@
+import { RichBoolean } from '../constants'
+
+export function getMaybeBooleanFromRichBoolean(richBoolean: RichBoolean): boolean | undefined {
+  switch (richBoolean) {
+    case RichBoolean.FALSE:
+      return false
+
+    case RichBoolean.TRUE:
+      return true
+
+    default:
+      return undefined
+  }
+}