randSequence with charsType pattern

[pumano]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/ngneat/falso/blob/master/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[X] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[X] Other... Please describe:

fix flaky test check for random-float

What is the current behavior?

Issue Number: N/A

What is the new behavior?

randSequence can generate sequence via predefined char patterns:

• alpha [Aa-Zz]
• numeric [0-9]
• alphaNumeric [Aa-Zz0-9]

Does this PR introduce a breaking change?

[ ] Yes
[X] No

Other information

[NetanelBasal]

We can remove (can't be used with 'chars' parameter ) and enforce by using type overloading.

[pumano]

Ok, I can remove comment, but charType only works if chars not specified. If chars specified, chars got highest priority.

[NetanelBasal]

If using both doesn't make sense we can enforce it using typescript

[pumano]

If using both doesn't make sense we can enforce it using typescript

OK, if I understand you right, I can create another charType with name custom and enforce user to specify chars, otherwise throw error, when chars specified without charType custom but it's breaking change I think

[NetanelBasal]

type RandomSequenceOptions = {
  size?: number;
  chars?: string;
}

type RandomSequenceOptions2 = {
  size?: number;
  charType?: 'numeric' | 'alpha' | 'alphaNumeric';
}

function foo(options: RandomSequenceOptions): any;
function foo(options: RandomSequenceOptions2): any;
function foo(options: any) {}

foo({charType: 'alphaNumeric', chars: ''}) // error

[pumano]

@NetanelBasal OK, I prepare commit soon

[pumano]

@NetanelBasal looks like if I use that code, I really get typescript error, when trying to use wrong method signature, but I lost types because types returned using internal Return<string, Options>, can I expose that Return type via export?