Swap allowLeadingZeros default value to true

[Shinigami92]

Clear and concise description of the problem

Often we have a call like faker.number.int(9) and then convert it to a string

Suggested solution

Implement a new method faker.string.digit() which returns a digit between [0, 9] and directly returns it as string

Alternative

No response

Additional context

Found in

• feat(number): move methods to new module #1122

[ejcheng]

I can take this one

[Shinigami92]

I can take this one

Please wait until #1122 was merged

[ST-DDT]

I would rather change the spec for string.numeric to allow returning '0' when length is 1.

[Shinigami92]

Maybe lets make a benchmark of using string.numeric({ allowLeadingZeros: true }) compared to string.digit() which just uses number.int under the hood

faker/src/modules/string/index.ts

Lines 333 to 388 in 6e1009a

	numeric(
	options:
	| number
	| {
	length?: number | { min: number; max: number };
	allowLeadingZeros?: boolean;
	exclude?: readonly LiteralUnion<NumericChar>[] | string;
	} = {}
	): string {
	if (typeof options === 'number') {
	options = {
	length: options,
	};
	}
	const length = this.faker.helpers.rangeToNumber(options.length ?? 1);
	if (length <= 0) {
	return '';
	}
	const { allowLeadingZeros = false } = options;
	let { exclude = [] } = options;
	if (typeof exclude === 'string') {
	exclude = exclude.split('');
	}
	const allowedDigits = DIGIT_CHARS.filter(
	(digit) => !exclude.includes(digit)
	);
	if (
	allowedDigits.length === 0 ||
	(allowedDigits.length === 1 &&
	!allowLeadingZeros &&
	allowedDigits[0] === '0')
	) {
	throw new FakerError(
	'Unable to generate numeric string, because all possible digits are excluded.'
	);
	}
	let result = '';
	if (!allowLeadingZeros && !exclude.includes('0')) {
	result += this.faker.helpers.arrayElement(
	allowedDigits.filter((digit) => digit !== '0')
	);
	}
	while (result.length < length) {
	result += this.faker.helpers.arrayElement(allowedDigits);
	}
	return result;
	}

[ST-DDT]

IMO we dont have to us a benchmark as long as it good enough. Otherwise we have to measure all our methods and reimplement them accordingly.

[Shinigami92]

I would rather change the spec for string.numeric to allow returning '0' when length is 1.

Why do you want to confuse users with another behavior if the length input differs from one case to another case?
IMO it is a bit hard for the user to exactly know that they need to read the docs to find out that the behavior differs based of the used number passed into one and the same input parameter.

[ST-DDT]

0001 isnt a real world number, but 0 is.
IMO this doesnt even need to be mentioned in the jsdocs.

[Shinigami92]

Team Decision:

• Do not introduce new method digit
• Swap allowLeadingZeros parameter of string.numeric to default: true
• _clean up all out internal calls as they don't need allowLeadingZeros anymore
• After release, lets see if feedback from community comes back that this affected them