Add boolean support for datatype.boolean and helpers.maybe

[ST-DDT]

Clear and concise description of the problem

Currently there is no easy way to convert boolean? to boolean. This feature is somewhat similar to rangeToNumber.

export const createUser = (includeOrganization?: boolean) => {
     name: faker.internet.userName(),
     organization: ( includeOrganization ?? faker.datatype.boolean()) ? createOrganization() : undefined;
}

I'm aware that there might be better ways to implement this.

Suggested solution

boolean(options: boolean | number | { probability: number}) {
    if (typeof options === 'boolean') {
        return options;
    }
    ....
}

The same for helpers.maybe, then you can use it like this:

export const createUser = (includeOrganization?: boolean) => {
     name: faker.internet.userName(),
     organization: faker.helpers.maybe(() => createOrganization(), includeOrganization);
};

Alternative

Doing nothing

Additional context

I considered this while writing the examples for #1508 (comment).

[ST-DDT]

If you are interested in this feature. Please upvote this issue.

[github-actions]

Thank you for your feature proposal.

We marked it as "waiting for user interest" for now to gather some feedback from our community:

• If you would like to see this feature be implemented, please react to the description with an up-vote (:+1:).
• If you have a suggestion or want to point out some special cases that need to be considered, please leave a comment, so we are aware about them.

We would also like to hear about other community members' use cases for the feature to give us a better understanding of their potential implicit or explicit requirements.

We will start the implementation based on:

• the number of votes (:+1:) and comments
• the relevance for the ecosystem
• availability of alternatives and workarounds
• and the complexity of the requested feature

We do this because:

• There are plenty of languages/countries out there and we would like to ensure that every method can cover all or almost all of them.
• Every feature we add to faker has "costs" associated to it:
  • initial costs: design, implementation, reviews, documentation
  • running costs: awareness of the feature itself, more complex module structure, increased bundle size, more work during refactors

---

View more issues which are waiting for user interest