From ef15896599fbfd6f91664ec827b1dfd6970b2baa Mon Sep 17 00:00:00 2001 From: Nicolas DUBIEN Date: Tue, 22 Sep 2026 22:01:35 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A5=20Drop=20useless=20`@internal`=20c?= =?UTF-8?q?omments=20(#7351)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Description These comments mostly instruct TypeScript and thus rolldown-plugin-dts, not to emit the type definition for the annotated line. That said in many cases it's purely useless. This PR only preserves the few legits cases while removing all others. They were making the code harder to think of in a way by adding unwanted clutter and comments. Initially opened as #7205. ## Checklist — _Don't delete this checklist and make sure you do the following before opening the PR_ - [ ] I have a full understanding of every line in this PR — whether the code was hand-written, AI-generated, copied from external sources or produced by any other tool - [ ] I flagged the impact of my change (minor / patch / major) either by running `pnpm run bump` or by following the instructions from the changeset bot - [ ] I kept this PR focused on a single concern and did not bundle unrelated changes - [ ] I followed the [gitmoji](https://gitmoji.dev/) specification for the name of the PR, including the package scope (e.g. `🐛(vitest) Something...`) when the change targets a package other than `fast-check` - [ ] I added relevant tests and they would have failed without my PR (when applicable) --------- Co-authored-by: github-actions[bot] --- .changeset/mighty-planes-film.md | 5 +++++ .../src/arbitrary/_internals/AdapterArbitrary.ts | 5 ----- .../_internals/AlwaysShrinkableArbitrary.ts | 1 - .../src/arbitrary/_internals/ArrayArbitrary.ts | 3 --- .../src/arbitrary/_internals/BigIntArbitrary.ts | 1 - .../src/arbitrary/_internals/CloneArbitrary.ts | 1 - .../src/arbitrary/_internals/CommandsArbitrary.ts | 1 - .../src/arbitrary/_internals/ConstantArbitrary.ts | 2 -- .../src/arbitrary/_internals/FrequencyArbitrary.ts | 5 ----- .../InitialPoolForEntityGraphArbitrary.ts | 1 - .../src/arbitrary/_internals/IntegerArbitrary.ts | 1 - .../src/arbitrary/_internals/IteratorArbitrary.ts | 2 -- .../src/arbitrary/_internals/LazyArbitrary.ts | 1 - .../arbitrary/_internals/LimitedShrinkArbitrary.ts | 3 --- .../src/arbitrary/_internals/MixedCaseArbitrary.ts | 2 -- .../OnTheFlyLinksForEntityGraphArbitrary.ts | 10 ---------- .../src/arbitrary/_internals/SchedulerArbitrary.ts | 2 -- .../arbitrary/_internals/StringUnitArbitrary.ts | 7 ------- .../src/arbitrary/_internals/SubarrayArbitrary.ts | 1 - .../src/arbitrary/_internals/TupleArbitrary.ts | 7 ------- .../_internals/UnlinkedEntitiesForEntityGraph.ts | 1 - .../_internals/WithShrinkFromOtherArbitrary.ts | 4 ---- .../_internals/builders/AnyArbitraryBuilder.ts | 3 --- .../_internals/builders/BoxedArbitraryBuilder.ts | 1 - .../builders/CharacterRangeArbitraryBuilder.ts | 10 ---------- .../builders/CompareFunctionArbitraryBuilder.ts | 1 - .../_internals/builders/GeneratorValueBuilder.ts | 3 --- .../builders/PaddedNumberArbitraryBuilder.ts | 1 - .../builders/PartialRecordArbitraryBuilder.ts | 1 - .../builders/RestrictedIntegerArbitraryBuilder.ts | 1 - .../builders/StringifiedNatArbitraryBuilder.ts | 1 - .../builders/TypedIntArrayArbitraryBuilder.ts | 2 -- .../_internals/builders/UriPathArbitraryBuilder.ts | 3 --- .../builders/UriQueryOrFragmentArbitraryBuilder.ts | 1 - .../arbitrary/_internals/data/GraphemeRanges.ts | 5 ----- .../_internals/helpers/BiasNumericRange.ts | 3 --- .../helpers/BuildInversedRelationsMapping.ts | 2 -- .../_internals/helpers/BuildSchedulerFor.ts | 2 -- .../_internals/helpers/BuildSlicedGenerator.ts | 2 -- .../arbitrary/_internals/helpers/ClampRegexAst.ts | 1 - .../arbitrary/_internals/helpers/CustomEqualSet.ts | 2 -- .../arbitrary/_internals/helpers/DepthContext.ts | 2 -- .../arbitrary/_internals/helpers/DoubleHelpers.ts | 10 ---------- .../_internals/helpers/EnumerableKeysExtractor.ts | 2 -- .../arbitrary/_internals/helpers/FloatHelpers.ts | 13 ------------- .../_internals/helpers/FloatingOnlyHelpers.ts | 1 - .../_internals/helpers/GraphemeRangesHelpers.ts | 3 --- .../helpers/InvalidSubdomainLabelFiIter.ts | 1 - .../_internals/helpers/JsonConstraintsBuilder.ts | 1 - .../_internals/helpers/MaxLengthFromMinLength.ts | 9 --------- .../_internals/helpers/NoUndefinedAsContext.ts | 2 -- .../helpers/QualifiedObjectConstraints.ts | 7 ------- .../src/arbitrary/_internals/helpers/ReadRegex.ts | 1 - .../arbitrary/_internals/helpers/SameValueSet.ts | 1 - .../_internals/helpers/SameValueZeroSet.ts | 1 - .../_internals/helpers/SanitizeRegexAst.ts | 2 -- .../arbitrary/_internals/helpers/ShrinkBigInt.ts | 2 -- .../arbitrary/_internals/helpers/ShrinkInteger.ts | 3 --- .../_internals/helpers/SlicesForStringBuilder.ts | 5 ----- .../_internals/helpers/StrictlyEqualSet.ts | 1 - .../arbitrary/_internals/helpers/TextEscaper.ts | 2 -- .../arbitrary/_internals/helpers/ToggleFlags.ts | 7 ------- .../arbitrary/_internals/helpers/TokenizeString.ts | 2 -- .../helpers/UnicodePropertyArbitraryHelper.ts | 6 ------ .../_internals/helpers/UnicodePropertyData.ts | 9 --------- .../_internals/helpers/ZipIterableIterators.ts | 6 ------ .../implementations/NoopSlicedGenerator.ts | 1 - .../_internals/implementations/SchedulerImplem.ts | 5 ----- .../implementations/SlicedBasedGenerator.ts | 1 - .../arbitrary/_internals/interfaces/CustomSet.ts | 2 -- .../_internals/interfaces/EntityGraphTypes.ts | 5 ----- .../_internals/interfaces/SlicedGenerator.ts | 3 --- .../src/arbitrary/_internals/mappers/ArrayToMap.ts | 2 -- .../src/arbitrary/_internals/mappers/ArrayToSet.ts | 2 -- .../arbitrary/_internals/mappers/CharsToString.ts | 2 -- .../_internals/mappers/CodePointsToString.ts | 3 +-- .../arbitrary/_internals/mappers/EntitiesToIPv6.ts | 14 -------------- .../_internals/mappers/IndexToMappedConstant.ts | 8 -------- .../_internals/mappers/KeyValuePairsToObject.ts | 3 --- .../_internals/mappers/NatToStringifiedNat.ts | 3 --- .../_internals/mappers/NumberToPaddedEight.ts | 2 -- .../_internals/mappers/PaddedEightsToUuid.ts | 3 --- .../src/arbitrary/_internals/mappers/PartsToUrl.ts | 4 +--- .../_internals/mappers/PatternsToString.ts | 6 +----- .../arbitrary/_internals/mappers/SegmentsToPath.ts | 2 -- .../arbitrary/_internals/mappers/StringToBase64.ts | 3 +-- .../src/arbitrary/_internals/mappers/TimeToDate.ts | 4 ---- .../_internals/mappers/UintToBase32String.ts | 8 -------- .../arbitrary/_internals/mappers/UnboxedToBoxed.ts | 2 -- .../_internals/mappers/UnlinkedToLinkedEntities.ts | 3 --- .../mappers/ValuesAndSeparateKeysToObject.ts | 2 -- .../_internals/mappers/VersionsApplierForUuid.ts | 2 -- .../arbitrary/_internals/mappers/WordsToLorem.ts | 6 ------ packages/fast-check/src/arbitrary/array.ts | 1 - packages/fast-check/src/arbitrary/base64String.ts | 3 --- packages/fast-check/src/arbitrary/bigInt.ts | 10 ++-------- packages/fast-check/src/arbitrary/boolean.ts | 2 -- packages/fast-check/src/arbitrary/chainUntil.ts | 3 --- packages/fast-check/src/arbitrary/constantFrom.ts | 2 -- packages/fast-check/src/arbitrary/context.ts | 1 - packages/fast-check/src/arbitrary/dictionary.ts | 1 - packages/fast-check/src/arbitrary/domain.ts | 6 ------ packages/fast-check/src/arbitrary/double.ts | 9 +-------- packages/fast-check/src/arbitrary/emailAddress.ts | 5 ----- packages/fast-check/src/arbitrary/float.ts | 8 +------- packages/fast-check/src/arbitrary/float32Array.ts | 2 -- packages/fast-check/src/arbitrary/float64Array.ts | 2 -- packages/fast-check/src/arbitrary/integer.ts | 1 - packages/fast-check/src/arbitrary/ipV4.ts | 2 -- packages/fast-check/src/arbitrary/ipV4Extended.ts | 2 -- packages/fast-check/src/arbitrary/ipV6.ts | 3 --- packages/fast-check/src/arbitrary/json.ts | 1 - packages/fast-check/src/arbitrary/letrec.ts | 1 - packages/fast-check/src/arbitrary/lorem.ts | 3 --- packages/fast-check/src/arbitrary/map.ts | 1 - packages/fast-check/src/arbitrary/mapToConstant.ts | 1 - packages/fast-check/src/arbitrary/memo.ts | 1 - packages/fast-check/src/arbitrary/mixedCase.ts | 1 - packages/fast-check/src/arbitrary/noBias.ts | 1 - packages/fast-check/src/arbitrary/noShrink.ts | 1 - packages/fast-check/src/arbitrary/object.ts | 1 - packages/fast-check/src/arbitrary/oneof.ts | 6 ------ packages/fast-check/src/arbitrary/sparseArray.ts | 2 -- packages/fast-check/src/arbitrary/string.ts | 1 - .../fast-check/src/arbitrary/stringMatching.ts | 1 - packages/fast-check/src/arbitrary/uniqueArray.ts | 1 - packages/fast-check/src/arbitrary/uuid.ts | 1 - packages/fast-check/src/arbitrary/webAuthority.ts | 5 ----- .../src/check/arbitrary/definition/Arbitrary.ts | 8 -------- packages/fast-check/src/check/model/ModelRunner.ts | 6 ------ packages/fast-check/src/check/model/ReplayPath.ts | 2 -- .../src/check/model/commands/ScheduledCommand.ts | 2 -- .../src/check/plugin/EqualValuesPlugins.ts | 4 ---- .../check/plugin/InterruptAfterTimeLimitPlugin.ts | 2 -- .../fast-check/src/check/plugin/TimeoutPlugin.ts | 6 +++--- .../src/check/precondition/PreconditionFailure.ts | 1 - .../check/property/_internals/PropertyImplem.ts | 4 ---- .../src/check/property/_internals/ToFrequency.ts | 2 -- .../check/property/plugins/SkipAfterProperty.ts | 2 -- .../src/check/property/plugins/TimeoutProperty.ts | 2 -- .../src/check/runner/DecorateProperty.ts | 2 -- packages/fast-check/src/check/runner/Runner.ts | 1 - .../fast-check/src/check/runner/RunnerIterator.ts | 2 -- packages/fast-check/src/check/runner/Sampler.ts | 3 --- .../src/check/runner/SourceValuesIterator.ts | 1 - packages/fast-check/src/check/runner/Tosser.ts | 4 ---- .../check/runner/configuration/GlobalParameters.ts | 1 - .../runner/configuration/QualifiedParameters.ts | 9 --------- .../src/check/runner/reporter/RunExecution.ts | 2 -- .../src/check/runner/utils/PathWalker.ts | 2 -- .../src/check/runner/utils/RunDetailsFormatter.ts | 11 ----------- .../src/random/generator/RandomGenerator.ts | 4 ---- packages/fast-check/src/utils/hash.ts | 1 - packages/fast-check/src/utils/stringify.ts | 12 ------------ 154 files changed, 16 insertions(+), 483 deletions(-) create mode 100644 .changeset/mighty-planes-film.md diff --git a/.changeset/mighty-planes-film.md b/.changeset/mighty-planes-film.md new file mode 100644 index 000000000..f427ff0df --- /dev/null +++ b/.changeset/mighty-planes-film.md @@ -0,0 +1,5 @@ +--- +"fast-check": patch +--- + +🔥 Drop useless `@internal` comments diff --git a/packages/fast-check/src/arbitrary/_internals/AdapterArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/AdapterArbitrary.ts index f93442943..b5eb6ae77 100644 --- a/packages/fast-check/src/arbitrary/_internals/AdapterArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/AdapterArbitrary.ts @@ -3,13 +3,10 @@ import { Value } from '../../check/arbitrary/definition/Value.js'; import type { Random } from '../../random/generator/Random.js'; import { nil } from '../../utils/iterator.js'; -/** @internal */ export type AdapterOutput = { adapted: boolean; value: T }; -/** @internal */ const AdaptedValue = Symbol('adapted-value'); -/** @internal */ function toAdapterValue(rawValue: Value, adapter: (value: T) => AdapterOutput): Value { const adapted = adapter(rawValue.value_); if (!adapted.adapted) { @@ -19,7 +16,6 @@ function toAdapterValue(rawValue: Value, adapter: (value: T) => AdapterOut } /** - * @internal * Adapt an existing Arbitrary by truncating its generating values * if they don't fit the requirements */ @@ -50,7 +46,6 @@ class AdapterArbitrary extends Arbitrary { } } -/** @internal */ export function adapter(sourceArb: Arbitrary, adapter: (value: T) => AdapterOutput): Arbitrary { return new AdapterArbitrary(sourceArb, adapter); } diff --git a/packages/fast-check/src/arbitrary/_internals/AlwaysShrinkableArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/AlwaysShrinkableArbitrary.ts index d53c7a91d..6a21766d1 100644 --- a/packages/fast-check/src/arbitrary/_internals/AlwaysShrinkableArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/AlwaysShrinkableArbitrary.ts @@ -8,7 +8,6 @@ import { noUndefinedAsContext, UndefinedContextPlaceholder } from './helpers/NoU * Arbitrary considering any value as shrinkable whatever the received context. * In case the context corresponds to nil, it will be checked when calling shrink: * valid would mean stream coming from shrink, otherwise empty stream - * @internal */ export class AlwaysShrinkableArbitrary extends Arbitrary { constructor(readonly arb: Arbitrary) { diff --git a/packages/fast-check/src/arbitrary/_internals/ArrayArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/ArrayArbitrary.ts index cac6c39a6..82635fd7d 100644 --- a/packages/fast-check/src/arbitrary/_internals/ArrayArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/ArrayArbitrary.ts @@ -10,7 +10,6 @@ import { getDepthContextFor } from './helpers/DepthContext.js'; import { buildSlicedGenerator } from './helpers/BuildSlicedGenerator.js'; import { joinAll, nil } from '../../utils/iterator.js'; -/** @internal */ type ArrayArbitraryContext = { shrunkOnce: boolean; lengthContext: unknown; @@ -18,7 +17,6 @@ type ArrayArbitraryContext = { startIndex: number; }; -/** @internal */ function biasedMaxLength(minLength: number, maxLength: number): number { if (minLength === maxLength) { return minLength; @@ -26,7 +24,6 @@ function biasedMaxLength(minLength: number, maxLength: number): number { return minLength + Math.floor(Math.log(maxLength - minLength) / Math.log(2)); } -/** @internal */ export class ArrayArbitrary extends Arbitrary { readonly lengthArb: Arbitrary; readonly depthContext: DepthContext; diff --git a/packages/fast-check/src/arbitrary/_internals/BigIntArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/BigIntArbitrary.ts index 19999ba1e..dba235bda 100644 --- a/packages/fast-check/src/arbitrary/_internals/BigIntArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/BigIntArbitrary.ts @@ -4,7 +4,6 @@ import { Value } from '../../check/arbitrary/definition/Value.js'; import { biasNumericRange, bigIntLogLike } from './helpers/BiasNumericRange.js'; import { shrinkBigInt } from './helpers/ShrinkBigInt.js'; -/** @internal */ export class BigIntArbitrary extends Arbitrary { constructor( readonly min: bigint, diff --git a/packages/fast-check/src/arbitrary/_internals/CloneArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/CloneArbitrary.ts index 4ff0c8b4c..ea3313cc1 100644 --- a/packages/fast-check/src/arbitrary/_internals/CloneArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/CloneArbitrary.ts @@ -4,7 +4,6 @@ import { cloneMethod } from '../../check/symbols.js'; import type { Random } from '../../random/generator/Random.js'; import { nil } from '../../utils/iterator.js'; -/** @internal */ export class CloneArbitrary extends Arbitrary { constructor( readonly arb: Arbitrary, diff --git a/packages/fast-check/src/arbitrary/_internals/CommandsArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/CommandsArbitrary.ts index d1971cde9..e0517f91d 100644 --- a/packages/fast-check/src/arbitrary/_internals/CommandsArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/CommandsArbitrary.ts @@ -14,7 +14,6 @@ type CommandsArbitraryContext>[]; }; -/** @internal */ export class CommandsArbitrary extends Arbitrary< CommandsIterable > { diff --git a/packages/fast-check/src/arbitrary/_internals/ConstantArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/ConstantArbitrary.ts index c4f158a92..015800be7 100644 --- a/packages/fast-check/src/arbitrary/_internals/ConstantArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/ConstantArbitrary.ts @@ -4,7 +4,6 @@ import { Arbitrary } from '../../check/arbitrary/definition/Arbitrary.js'; import { Value } from '../../check/arbitrary/definition/Value.js'; import { cloneMethod, hasCloneMethod } from '../../check/symbols.js'; -/** @internal */ class FastConstantValuesLookup { private readonly hasMinusZero: boolean; private readonly hasPlusZero: boolean; @@ -37,7 +36,6 @@ class FastConstantValuesLookup { } } -/** @internal */ export class ConstantArbitrary extends Arbitrary { private fastValues: FastConstantValuesLookup | undefined; diff --git a/packages/fast-check/src/arbitrary/_internals/FrequencyArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/FrequencyArbitrary.ts index 479737c51..f657b8099 100644 --- a/packages/fast-check/src/arbitrary/_internals/FrequencyArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/FrequencyArbitrary.ts @@ -7,7 +7,6 @@ import { getDepthContextFor } from './helpers/DepthContext.js'; import type { DepthSize } from './helpers/MaxLengthFromMinLength.js'; import { depthBiasFromSizeForArbitrary } from './helpers/MaxLengthFromMinLength.js'; -/** @internal */ export class FrequencyArbitrary extends Arbitrary { readonly cumulatedWeights: number[]; readonly totalWeight: number; @@ -192,7 +191,6 @@ export class FrequencyArbitrary extends Arbitrary { } } -/** @internal */ export type _Constraints = { withCrossShrink?: boolean; depthSize?: DepthSize; @@ -200,14 +198,12 @@ export type _Constraints = { depthIdentifier?: DepthIdentifier | string; }; -/** @internal */ type _SanitizedConstraints = { withCrossShrink: boolean; depthBias: number; maxDepth: number; }; -/** @internal */ interface _WeightedArbitrary { weight: number; arbitrary: Arbitrary; @@ -215,7 +211,6 @@ interface _WeightedArbitrary { fallbackValue?: { default: T }; } -/** @internal */ type _FrequencyArbitraryContext = { selectedIndex: number; originalBias: number | undefined; diff --git a/packages/fast-check/src/arbitrary/_internals/InitialPoolForEntityGraphArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/InitialPoolForEntityGraphArbitrary.ts index dfbff5e33..1530220f0 100644 --- a/packages/fast-check/src/arbitrary/_internals/InitialPoolForEntityGraphArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/InitialPoolForEntityGraphArbitrary.ts @@ -20,7 +20,6 @@ function canHaveAtLeastOneItem( return false; } -/** @internal */ export function initialPoolForEntityGraph( keys: TEntityNames[], constraints: InitialPoolForEntityGraphConstraints, diff --git a/packages/fast-check/src/arbitrary/_internals/IntegerArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/IntegerArbitrary.ts index d280edb0b..3b00c8b4a 100644 --- a/packages/fast-check/src/arbitrary/_internals/IntegerArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/IntegerArbitrary.ts @@ -4,7 +4,6 @@ import type { Random } from '../../random/generator/Random.js'; import { integerLogLike, biasNumericRange } from './helpers/BiasNumericRange.js'; import { shrinkInteger } from './helpers/ShrinkInteger.js'; -/** @internal */ export class IntegerArbitrary extends Arbitrary { private readonly ranges: { min: number; max: number }[]; constructor( diff --git a/packages/fast-check/src/arbitrary/_internals/IteratorArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/IteratorArbitrary.ts index 7ccd6de10..155be175e 100644 --- a/packages/fast-check/src/arbitrary/_internals/IteratorArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/IteratorArbitrary.ts @@ -5,7 +5,6 @@ import type { Random } from '../../random/generator/Random.js'; import { nil } from '../../utils/iterator.js'; import { asyncStringify, asyncToStringMethod, stringify, toStringMethod } from '../../utils/stringify.js'; -/** @internal */ function prettyPrint(numSeen: number, numTargetValues: number, seenValuesStrings?: string[]): string { const seenSegment = seenValuesStrings !== undefined @@ -16,7 +15,6 @@ function prettyPrint(numSeen: number, numTargetValues: number, seenValuesStrings return `Iterator.from(${seenSegment})`; } -/** @internal */ export class IteratorArbitrary extends Arbitrary> { constructor( readonly arb: Arbitrary, diff --git a/packages/fast-check/src/arbitrary/_internals/LazyArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/LazyArbitrary.ts index dcc364afb..1b82fd1e7 100644 --- a/packages/fast-check/src/arbitrary/_internals/LazyArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/LazyArbitrary.ts @@ -2,7 +2,6 @@ import { Arbitrary } from '../../check/arbitrary/definition/Arbitrary.js'; import type { Value } from '../../check/arbitrary/definition/Value.js'; import type { Random } from '../../random/generator/Random.js'; -/** @internal */ export class LazyArbitrary extends Arbitrary { underlying: Arbitrary | null = null; constructor(readonly name: string) { diff --git a/packages/fast-check/src/arbitrary/_internals/LimitedShrinkArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/LimitedShrinkArbitrary.ts index 838c0b7f2..db4242d13 100644 --- a/packages/fast-check/src/arbitrary/_internals/LimitedShrinkArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/LimitedShrinkArbitrary.ts @@ -4,7 +4,6 @@ import type { Random } from '../../random/generator/Random.js'; import { nil } from '../../utils/iterator.js'; import { zipIterableIterators } from './helpers/ZipIterableIterators.js'; -/** @internal */ function* iotaFrom(startValue: number) { let value = startValue; while (true) { @@ -13,7 +12,6 @@ function* iotaFrom(startValue: number) { } } -/** @internal */ export class LimitedShrinkArbitrary extends Arbitrary { constructor( readonly arb: Arbitrary, @@ -58,7 +56,6 @@ export class LimitedShrinkArbitrary extends Arbitrary { } } -/** @internal */ type LimitedShrinkArbitraryContext = { originalContext: unknown; length: number; diff --git a/packages/fast-check/src/arbitrary/_internals/MixedCaseArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/MixedCaseArbitrary.ts index afb831331..a10c5b2ab 100644 --- a/packages/fast-check/src/arbitrary/_internals/MixedCaseArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/MixedCaseArbitrary.ts @@ -10,7 +10,6 @@ import { computeTogglePositions, } from './helpers/ToggleFlags.js'; -/** @internal */ type MixedCaseArbitraryContext = { rawString: string; rawStringContext: unknown; @@ -18,7 +17,6 @@ type MixedCaseArbitraryContext = { flagsContext: unknown; }; -/** @internal */ export class MixedCaseArbitrary extends Arbitrary { constructor( private readonly stringArb: Arbitrary, diff --git a/packages/fast-check/src/arbitrary/_internals/OnTheFlyLinksForEntityGraphArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/OnTheFlyLinksForEntityGraphArbitrary.ts index 360f0ccbf..8bd93d651 100644 --- a/packages/fast-check/src/arbitrary/_internals/OnTheFlyLinksForEntityGraphArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/OnTheFlyLinksForEntityGraphArbitrary.ts @@ -18,7 +18,6 @@ import type { Strategy, } from './interfaces/EntityGraphTypes.js'; -/** @internal */ function produceLinkUnitaryIndexArbitrary( strategy: Strategy, currentIndexIfSameType: number | undefined, @@ -36,7 +35,6 @@ function produceLinkUnitaryIndexArbitrary( } } -/** @internal */ function buildLinkIndexArbitrary( arity: Exclude, strategy: Strategy, @@ -68,7 +66,6 @@ function buildLinkIndexArbitrary( } } -/** @internal */ function createEmptyLinksInstanceFor>( relations: TEntityRelations, targetType: keyof TEntityFields, @@ -84,7 +81,6 @@ function createEmptyLinksInstanceFor>( relations: TEntityRelations, ): void { @@ -119,17 +115,14 @@ function assertAcceptableRelations = { type: keyof TEntityFields; indexInType: number; depth: number }; -/** @internal */ type ProductionState> = { readonly producedLinks: ReadonlyProducedLinks; readonly toBeProducedEntities: ReadonlyArray>>; readonly nextIndex: number; }; -/** @internal */ function draftNextProductionState>( state: ProductionState, offset: number, @@ -216,7 +209,6 @@ function draftNextProductionState>( relations: TEntityRelations, defaultEntities: (keyof TEntityFields)[], @@ -235,7 +227,6 @@ function buildInitialProductionState>( relations: TEntityRelations, inversedRelations: ReturnType>, @@ -304,7 +295,6 @@ function buildEntityStepArbitrary>( relations: TEntityRelations, defaultEntities: (keyof TEntityFields)[], diff --git a/packages/fast-check/src/arbitrary/_internals/SchedulerArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/SchedulerArbitrary.ts index ac36cede3..6d32804f1 100644 --- a/packages/fast-check/src/arbitrary/_internals/SchedulerArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/SchedulerArbitrary.ts @@ -7,7 +7,6 @@ import type { ScheduledTask, TaskSelector } from './implementations/SchedulerImp import { SchedulerImplem } from './implementations/SchedulerImplem.js'; /** - * @internal * Passed instance of mrng should never be altered from the outside. * Passed instance will never be affected by current code but always cloned before usage. */ @@ -21,7 +20,6 @@ function buildNextTaskIndex(mrng: Random): TaskSelector { }; } -/** @internal */ export class SchedulerArbitrary extends Arbitrary> { constructor(readonly act: (f: () => Promise) => Promise) { super(); diff --git a/packages/fast-check/src/arbitrary/_internals/StringUnitArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/StringUnitArbitrary.ts index 09fb0a06c..5c14f541d 100644 --- a/packages/fast-check/src/arbitrary/_internals/StringUnitArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/StringUnitArbitrary.ts @@ -10,20 +10,15 @@ import { import type { GraphemeRangeEntry } from './helpers/GraphemeRangesHelpers.js'; import { convertGraphemeRangeToMapToConstantEntry, intersectGraphemeRanges } from './helpers/GraphemeRangesHelpers.js'; -/** @internal */ type StringUnitType = 'grapheme' | 'composite' | 'binary'; -/** @internal */ type StringUnitAlphabet = 'full' | 'ascii'; -/** @internal */ type StringUnitMapKey = `${StringUnitType}:${StringUnitAlphabet}`; /** * Caching all already instanciated variations of stringUnit - * @internal */ const registeredStringUnitInstancesMap: Partial>> = Object.create(null); -/** @internal */ function getAlphabetRanges(alphabet: StringUnitAlphabet): GraphemeRange[] { switch (alphabet) { case 'full': @@ -33,7 +28,6 @@ function getAlphabetRanges(alphabet: StringUnitAlphabet): GraphemeRange[] { } } -/** @internal */ function getOrCreateStringUnitInstance(type: StringUnitType, alphabet: StringUnitAlphabet): Arbitrary { const key: StringUnitMapKey = `${type}:${alphabet}`; const registered = registeredStringUnitInstancesMap[key]; @@ -61,7 +55,6 @@ function getOrCreateStringUnitInstance(type: StringUnitType, alphabet: StringUni return stringUnitInstance; } -/** @internal */ export function stringUnit(type: StringUnitType, alphabet: StringUnitAlphabet): Arbitrary { return getOrCreateStringUnitInstance(type, alphabet); } diff --git a/packages/fast-check/src/arbitrary/_internals/SubarrayArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/SubarrayArbitrary.ts index 985620018..54945c88f 100644 --- a/packages/fast-check/src/arbitrary/_internals/SubarrayArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/SubarrayArbitrary.ts @@ -5,7 +5,6 @@ import { makeLazy, joinAll, nil } from '../../utils/iterator.js'; import { isSubarrayOf } from './helpers/IsSubarrayOf.js'; import { IntegerArbitrary } from './IntegerArbitrary.js'; -/** @internal */ export class SubarrayArbitrary extends Arbitrary { readonly lengthArb: Arbitrary; readonly biasedLengthArb: Arbitrary; diff --git a/packages/fast-check/src/arbitrary/_internals/TupleArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/TupleArbitrary.ts index fbb366460..cf59ecfa3 100644 --- a/packages/fast-check/src/arbitrary/_internals/TupleArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/TupleArbitrary.ts @@ -5,12 +5,9 @@ import { Arbitrary } from '../../check/arbitrary/definition/Arbitrary.js'; import { Value } from '../../check/arbitrary/definition/Value.js'; import { makeLazy, joinAll } from '../../utils/iterator.js'; -/** @internal */ type TupleContext = unknown[]; -/** @internal */ type TupleExtendedValue = Value & { context: TupleContext }; -/** @internal */ function tupleMakeItCloneable( vs: TValue[], ctxs: TupleContext, @@ -32,7 +29,6 @@ function tupleMakeItCloneable( }) as unknown as WithCloneMethod; } -/** @internal */ export function tupleShrink( arbs: ArbsArray, value: Ts, @@ -70,12 +66,9 @@ export function tupleShrink( return joinAll(shrinks); } -/** @internal */ type ArbsArray = { [K in keyof Ts]: Arbitrary }; -/** @internal */ type ValuesArray = { [K in keyof Ts]?: Value }; -/** @internal */ export class TupleArbitrary extends Arbitrary { constructor(readonly arbs: ArbsArray) { super(); diff --git a/packages/fast-check/src/arbitrary/_internals/UnlinkedEntitiesForEntityGraph.ts b/packages/fast-check/src/arbitrary/_internals/UnlinkedEntitiesForEntityGraph.ts index f829b9ea4..6152908c5 100644 --- a/packages/fast-check/src/arbitrary/_internals/UnlinkedEntitiesForEntityGraph.ts +++ b/packages/fast-check/src/arbitrary/_internals/UnlinkedEntitiesForEntityGraph.ts @@ -6,7 +6,6 @@ import type { UniqueArrayConstraintsRecommended } from '../uniqueArray.js'; import { uniqueArray } from '../uniqueArray.js'; import type { Arbitraries, UnlinkedEntities } from './interfaces/EntityGraphTypes.js'; -/** @internal */ export function unlinkedEntitiesForEntityGraph( arbitraries: Arbitraries, countFor: (entityName: keyof TEntityFields) => number, diff --git a/packages/fast-check/src/arbitrary/_internals/WithShrinkFromOtherArbitrary.ts b/packages/fast-check/src/arbitrary/_internals/WithShrinkFromOtherArbitrary.ts index 3319093a2..afcc2b2c1 100644 --- a/packages/fast-check/src/arbitrary/_internals/WithShrinkFromOtherArbitrary.ts +++ b/packages/fast-check/src/arbitrary/_internals/WithShrinkFromOtherArbitrary.ts @@ -2,12 +2,10 @@ import { Arbitrary } from '../../check/arbitrary/definition/Arbitrary.js'; import { Value } from '../../check/arbitrary/definition/Value.js'; import type { Random } from '../../random/generator/Random.js'; -/** @internal */ function isSafeContext(context: unknown): context is { generatorContext: unknown } | { shrinkerContext: unknown } { return context !== undefined; } -/** @internal */ function toGeneratorValue(value: Value): Value { if (value.hasToBeCloned) { return new Value(value.value_, { generatorContext: value.context }, () => value.value); @@ -15,7 +13,6 @@ function toGeneratorValue(value: Value): Value { return new Value(value.value_, { generatorContext: value.context }); } -/** @internal */ function toShrinkerValue(value: Value): Value { if (value.hasToBeCloned) { return new Value(value.value_, { shrinkerContext: value.context }, () => value.value); @@ -23,7 +20,6 @@ function toShrinkerValue(value: Value): Value { return new Value(value.value_, { shrinkerContext: value.context }); } -/** @internal */ export class WithShrinkFromOtherArbitrary extends Arbitrary { constructor( private readonly generatorArbitrary: Arbitrary, diff --git a/packages/fast-check/src/arbitrary/_internals/builders/AnyArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/AnyArbitraryBuilder.ts index f6d36d442..280a337f2 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/AnyArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/AnyArbitraryBuilder.ts @@ -24,7 +24,6 @@ import { dictionary } from '../../dictionary.js'; import { set } from '../../set.js'; import { map } from '../../map.js'; -/** @internal */ function dictOf( ka: Arbitrary, va: Arbitrary, @@ -41,7 +40,6 @@ function dictOf( }); } -/** @internal */ function typedArray(constraints: { maxLength: number | undefined; size: SizeForArbitrary }) { return oneof( int8Array(constraints), @@ -56,7 +54,6 @@ function typedArray(constraints: { maxLength: number | undefined; size: SizeForA ); } -/** @internal */ export function anyArbitraryBuilder(constraints: QualifiedObjectConstraints): Arbitrary { const arbitrariesForBase = constraints.values; const depthSize = constraints.depthSize; diff --git a/packages/fast-check/src/arbitrary/_internals/builders/BoxedArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/BoxedArbitraryBuilder.ts index e96f53bb4..8f9766542 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/BoxedArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/BoxedArbitraryBuilder.ts @@ -1,7 +1,6 @@ import type { Arbitrary } from '../../../check/arbitrary/definition/Arbitrary.js'; import { unboxedToBoxedMapper, unboxedToBoxedUnmapper } from '../mappers/UnboxedToBoxed.js'; -/** @internal */ export function boxedArbitraryBuilder(arb: Arbitrary): Arbitrary { return arb.map(unboxedToBoxedMapper, unboxedToBoxedUnmapper); } diff --git a/packages/fast-check/src/arbitrary/_internals/builders/CharacterRangeArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/CharacterRangeArbitraryBuilder.ts index 8ae3d9b97..bf570a068 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/CharacterRangeArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/CharacterRangeArbitraryBuilder.ts @@ -3,21 +3,16 @@ import { oneof } from '../../oneof.js'; import { mapToConstant } from '../../mapToConstant.js'; import { string } from '../../string.js'; -/** @internal */ const lowerCaseMapper = { num: 26, build: (v: number) => String.fromCharCode(v + 0x61) }; -/** @internal */ const upperCaseMapper = { num: 26, build: (v: number) => String.fromCharCode(v + 0x41) }; -/** @internal */ const numericMapper = { num: 10, build: (v: number) => String.fromCharCode(v + 0x30) }; -/** @internal */ function percentCharArbMapper(c: string): string { const encoded = encodeURIComponent(c); return c !== encoded ? encoded : `%${c.charCodeAt(0).toString(16)}`; // always %xy / no %x or %xyz } -/** @internal */ function percentCharArbUnmapper(value: unknown): string { if (typeof value !== 'string') { throw new Error('Unsupported'); @@ -26,13 +21,11 @@ function percentCharArbUnmapper(value: unknown): string { return decoded; } -/** @internal */ const percentCharArb = () => string({ unit: 'binary', minLength: 1, maxLength: 1 }).map(percentCharArbMapper, percentCharArbUnmapper); let lowerAlphaArbitrary: Arbitrary | undefined = undefined; -/** @internal */ export function getOrCreateLowerAlphaArbitrary(): Arbitrary { if (lowerAlphaArbitrary === undefined) { lowerAlphaArbitrary = mapToConstant(lowerCaseMapper); @@ -42,7 +35,6 @@ export function getOrCreateLowerAlphaArbitrary(): Arbitrary { let lowerAlphaNumericArbitraries: Map> | undefined = undefined; -/** @internal */ export function getOrCreateLowerAlphaNumericArbitrary(others: string): Arbitrary { if (lowerAlphaNumericArbitraries === undefined) { lowerAlphaNumericArbitraries = new Map(); @@ -58,7 +50,6 @@ export function getOrCreateLowerAlphaNumericArbitrary(others: string): Arbitrary return match; } -/** @internal */ function buildAlphaNumericArbitrary(others: string): Arbitrary { return mapToConstant(lowerCaseMapper, upperCaseMapper, numericMapper, { num: others.length, @@ -68,7 +59,6 @@ function buildAlphaNumericArbitrary(others: string): Arbitrary { let alphaNumericPercentArbitraries: Map> | undefined = undefined; -/** @internal */ export function getOrCreateAlphaNumericPercentArbitrary(others: string): Arbitrary { if (alphaNumericPercentArbitraries === undefined) { alphaNumericPercentArbitraries = new Map(); diff --git a/packages/fast-check/src/arbitrary/_internals/builders/CompareFunctionArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/CompareFunctionArbitraryBuilder.ts index e6f54edd9..7d96283b9 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/CompareFunctionArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/CompareFunctionArbitraryBuilder.ts @@ -7,7 +7,6 @@ import { integer } from '../../integer.js'; import { noShrink } from '../../noShrink.js'; import { tuple } from '../../tuple.js'; -/** @internal */ export function buildCompareFunctionArbitrary( cmp: (hA: number, hB: number) => TOut, ): Arbitrary<(a: T, b: T) => TOut> { diff --git a/packages/fast-check/src/arbitrary/_internals/builders/GeneratorValueBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/GeneratorValueBuilder.ts index 724159238..3f052ebba 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/GeneratorValueBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/GeneratorValueBuilder.ts @@ -43,7 +43,6 @@ export type GeneratorValue = GeneratorValueFunction & GeneratorValueMethods; /** * Details related to pre-built values - * @internal */ export type PreBuiltValue = { /** The arbitrary used to generate the value */ @@ -58,7 +57,6 @@ export type PreBuiltValue = { /** * Context attached next to {@link GeneratorValue} - * @internal */ export type GeneratorContext = { /** Cloned version of the random number generator */ @@ -71,7 +69,6 @@ export type GeneratorContext = { /** * An internal builder of values of type {@link GeneratorValue} - * @internal */ export function buildGeneratorValue( mrng: Random, diff --git a/packages/fast-check/src/arbitrary/_internals/builders/PaddedNumberArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/PaddedNumberArbitraryBuilder.ts index 9e20175fc..48b263746 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/PaddedNumberArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/PaddedNumberArbitraryBuilder.ts @@ -2,7 +2,6 @@ import type { Arbitrary } from '../../../check/arbitrary/definition/Arbitrary.js import { integer } from '../../integer.js'; import { numberToPaddedEightMapper, numberToPaddedEightUnmapper } from '../mappers/NumberToPaddedEight.js'; -/** @internal */ export function buildPaddedNumberArbitrary(min: number, max: number): Arbitrary { return integer({ min, max }).map(numberToPaddedEightMapper, numberToPaddedEightUnmapper); } diff --git a/packages/fast-check/src/arbitrary/_internals/builders/PartialRecordArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/PartialRecordArbitraryBuilder.ts index 2cca31dce..fd4259f04 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/PartialRecordArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/PartialRecordArbitraryBuilder.ts @@ -13,7 +13,6 @@ import { const noKeyValue: unique symbol = Symbol('no-key'); type NoKeyType = typeof noKeyValue; -/** @internal */ export function buildPartialRecordArbitrary>( recordModel: { [K in keyof T]: Arbitrary }, requiredKeys: TKeys[] | undefined, diff --git a/packages/fast-check/src/arbitrary/_internals/builders/RestrictedIntegerArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/RestrictedIntegerArbitraryBuilder.ts index 1bc7eb8fa..c1205b45c 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/RestrictedIntegerArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/RestrictedIntegerArbitraryBuilder.ts @@ -2,7 +2,6 @@ import type { Arbitrary } from '../../../check/arbitrary/definition/Arbitrary.js import { integer } from '../../integer.js'; import { WithShrinkFromOtherArbitrary } from '../WithShrinkFromOtherArbitrary.js'; -/** @internal */ export function restrictedIntegerArbitraryBuilder(min: number, maxGenerated: number, max: number): Arbitrary { const generatorArbitrary = integer({ min, max: maxGenerated }); if (maxGenerated === max) { diff --git a/packages/fast-check/src/arbitrary/_internals/builders/StringifiedNatArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/StringifiedNatArbitraryBuilder.ts index 2112fdd3e..c3217cbc1 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/StringifiedNatArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/StringifiedNatArbitraryBuilder.ts @@ -4,7 +4,6 @@ import { nat } from '../../nat.js'; import { tuple } from '../../tuple.js'; import { natToStringifiedNatMapper, natToStringifiedNatUnmapper } from '../mappers/NatToStringifiedNat.js'; -/** @internal */ export function buildStringifiedNatArbitrary(maxValue: number): Arbitrary { return tuple(constantFrom('dec', 'oct', 'hex'), nat(maxValue)).map( natToStringifiedNatMapper, diff --git a/packages/fast-check/src/arbitrary/_internals/builders/TypedIntArrayArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/TypedIntArrayArbitraryBuilder.ts index 5076cce06..3b06e75a4 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/TypedIntArrayArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/TypedIntArrayArbitraryBuilder.ts @@ -2,7 +2,6 @@ import type { Arbitrary } from '../../../check/arbitrary/definition/Arbitrary.js import { array } from '../../array.js'; import type { SizeForArbitrary } from '../helpers/MaxLengthFromMinLength.js'; -/** @internal */ type TypedIntArrayBuilderConstraints = { minLength?: number; maxLength?: number; @@ -11,7 +10,6 @@ type TypedIntArrayBuilderConstraints = { size?: SizeForArbitrary; }; -/** @internal */ export function typedIntArrayArbitraryArbitraryBuilder, TValue>( constraints: TypedIntArrayBuilderConstraints, defaultMin: TValue, diff --git a/packages/fast-check/src/arbitrary/_internals/builders/UriPathArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/UriPathArbitraryBuilder.ts index b5c78a9dd..23fe023aa 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/UriPathArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/UriPathArbitraryBuilder.ts @@ -5,7 +5,6 @@ import { array } from '../../array.js'; import { segmentsToPathMapper, segmentsToPathUnmapper } from '../mappers/SegmentsToPath.js'; import { oneof } from '../../oneof.js'; -/** @internal */ function sqrtSize(size: Size): [Size, Size] { switch (size) { case 'xsmall': @@ -21,7 +20,6 @@ function sqrtSize(size: Size): [Size, Size] { } } -/** @internal */ function buildUriPathArbitraryInternal(segmentSize: Size, numSegmentSize: Size): Arbitrary { return array(webSegment({ size: segmentSize }), { size: numSegmentSize }).map( segmentsToPathMapper, @@ -29,7 +27,6 @@ function buildUriPathArbitraryInternal(segmentSize: Size, numSegmentSize: Size): ); } -/** @internal */ export function buildUriPathArbitrary(resolvedSize: Size): Arbitrary { const [segmentSize, numSegmentSize] = sqrtSize(resolvedSize); if (segmentSize === numSegmentSize) { diff --git a/packages/fast-check/src/arbitrary/_internals/builders/UriQueryOrFragmentArbitraryBuilder.ts b/packages/fast-check/src/arbitrary/_internals/builders/UriQueryOrFragmentArbitraryBuilder.ts index 7d208af02..f0535db8b 100644 --- a/packages/fast-check/src/arbitrary/_internals/builders/UriQueryOrFragmentArbitraryBuilder.ts +++ b/packages/fast-check/src/arbitrary/_internals/builders/UriQueryOrFragmentArbitraryBuilder.ts @@ -3,7 +3,6 @@ import { getOrCreateAlphaNumericPercentArbitrary } from './CharacterRangeArbitra import { string } from '../../string.js'; import type { SizeForArbitrary } from '../helpers/MaxLengthFromMinLength.js'; -/** @internal */ export function buildUriQueryOrFragmentArbitrary(size: Exclude): Arbitrary { // query = *( pchar / "/" / "?" ) // fragment = *( pchar / "/" / "?" ) diff --git a/packages/fast-check/src/arbitrary/_internals/data/GraphemeRanges.ts b/packages/fast-check/src/arbitrary/_internals/data/GraphemeRanges.ts index 609af3874..d87a6b3ac 100644 --- a/packages/fast-check/src/arbitrary/_internals/data/GraphemeRanges.ts +++ b/packages/fast-check/src/arbitrary/_internals/data/GraphemeRanges.ts @@ -1,10 +1,7 @@ -/** @internal */ export type GraphemeRange = [number] | [number, number]; -/** @internal */ export const asciiAlphabetRanges: GraphemeRange[] = [[0x00, 0x7f]]; -/** @internal */ export const fullAlphabetRanges: GraphemeRange[] = [ [0x0000, 0xd7ff], // d800-dfff being the range of surrogate pairs [0xe000, 0x10ffff], @@ -13,7 +10,6 @@ export const fullAlphabetRanges: GraphemeRange[] = [ /** * Ranges of Graphemes safe to be combined together without any risks to interract between each others. * 779 ranges, gathering 31828 code-points over the 34931 being declared by http://unicode.org/Public/UNIDATA/UnicodeData.txt on the 17th of August 2024 - * @internal */ export const autonomousGraphemeRanges: GraphemeRange[] = [ [0x20, 0x7e], @@ -802,7 +798,6 @@ export const autonomousGraphemeRanges: GraphemeRange[] = [ * We preserved only one version of each decomposition meaning that if c1.normalize('NFD') === c2.normalize('NFD') * we only preserved the first one to build our set of ranges. * As such we found 998 NFD decomposable graphemes and kept 980 of them spread into 197 ranges. - * @internal */ export const autonomousDecomposableGraphemeRanges: GraphemeRange[] = [ [0xc0, 0xc5], diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/BiasNumericRange.ts b/packages/fast-check/src/arbitrary/_internals/helpers/BiasNumericRange.ts index 8d5ad28fc..fffeb1f08 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/BiasNumericRange.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/BiasNumericRange.ts @@ -1,15 +1,12 @@ -/** @internal */ export function integerLogLike(v: number): number { return Math.floor(Math.log(v) / Math.log(2)); } -/** @internal */ export function bigIntLogLike(v: bigint): bigint { if (v === 0n) return 0n; return BigInt(String(v).length); } -/** @internal */ function biasNumericRange(min: number, max: number, logLike: (n: number) => number): { min: number; max: number }[]; function biasNumericRange(min: bigint, max: bigint, logLike: (n: bigint) => bigint): { min: bigint; max: bigint }[]; function biasNumericRange( diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/BuildInversedRelationsMapping.ts b/packages/fast-check/src/arbitrary/_internals/helpers/BuildInversedRelationsMapping.ts index 8e8036db1..bf4675f94 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/BuildInversedRelationsMapping.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/BuildInversedRelationsMapping.ts @@ -1,11 +1,9 @@ import type { EntityRelations, Relationship } from '../interfaces/EntityGraphTypes.js'; -/** @internal */ export type InversedRelationsEntry = { type: keyof TEntityFields; property: string }; /** * Build mapping from forward to inverse relationships - * @internal */ export function buildInversedRelationsMapping( relations: EntityRelations, diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/BuildSchedulerFor.ts b/packages/fast-check/src/arbitrary/_internals/helpers/BuildSchedulerFor.ts index 81d89a268..f514649e7 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/BuildSchedulerFor.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/BuildSchedulerFor.ts @@ -2,7 +2,6 @@ import type { Scheduler } from '../interfaces/Scheduler.js'; import type { ScheduledTask, TaskSelector } from '../implementations/SchedulerImplem.js'; import { SchedulerImplem } from '../implementations/SchedulerImplem.js'; -/** @internal */ function buildNextTaskIndex(ordering: number[]): TaskSelector { let numTasks = 0; return { @@ -21,7 +20,6 @@ function buildNextTaskIndex(ordering: number[]): TaskSelector( act: (f: () => Promise) => Promise, ordering: number[], diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/BuildSlicedGenerator.ts b/packages/fast-check/src/arbitrary/_internals/helpers/BuildSlicedGenerator.ts index d47923129..72a7746d3 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/BuildSlicedGenerator.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/BuildSlicedGenerator.ts @@ -11,8 +11,6 @@ import type { SlicedGenerator } from '../interfaces/SlicedGenerator.js'; * @param mrng - Random number generator * @param slices - Slices to be used (WARNING: while we accept no slices, slices themselves must never empty) * @param biasFactor - The current bias factor - * - * @internal */ export function buildSlicedGenerator( arb: Arbitrary, diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/ClampRegexAst.ts b/packages/fast-check/src/arbitrary/_internals/helpers/ClampRegexAst.ts index 0183bd4d7..f55af41ff 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/ClampRegexAst.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/ClampRegexAst.ts @@ -1,7 +1,6 @@ import { noSuchValue } from '../../../utils/noSuchValue.js'; import type { RegexToken } from './TokenizeRegex.js'; -/** @internal */ function clampRegexAstInternal(astNode: RegexToken, maxLength: number): { astNode: RegexToken; minLength: number } { switch (astNode.type) { case 'Char': { diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/CustomEqualSet.ts b/packages/fast-check/src/arbitrary/_internals/helpers/CustomEqualSet.ts index 99ae49f6a..13761dc1a 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/CustomEqualSet.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/CustomEqualSet.ts @@ -2,8 +2,6 @@ import type { CustomSet } from '../interfaces/CustomSet.js'; /** * CustomSet based on a fully custom equality function - * - * @internal */ export class CustomEqualSet implements CustomSet { private readonly data: T[]; diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/DepthContext.ts b/packages/fast-check/src/arbitrary/_internals/helpers/DepthContext.ts index 75ecc95b2..23cd0cd86 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/DepthContext.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/DepthContext.ts @@ -1,6 +1,5 @@ /** * Internal symbol used to declare an opaque type for DepthIdentifier - * @internal */ declare const depthIdentifierSymbol: unique symbol; @@ -38,7 +37,6 @@ export type DepthContext = { /** * Internal cache for depth contexts - * @internal */ const depthContextCache = new Map(); diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/DoubleHelpers.ts b/packages/fast-check/src/arbitrary/_internals/helpers/DoubleHelpers.ts index 0d55c4625..306536f81 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/DoubleHelpers.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/DoubleHelpers.ts @@ -1,6 +1,4 @@ -/** @internal */ const INDEX_POSITIVE_INFINITY = 9218868437227405312n; // doubleToIndex(Number.MAX_VALUE) + 1 = 2146435072 * 4294967296 -/** @internal */ const INDEX_NEGATIVE_INFINITY = -INDEX_POSITIVE_INFINITY - 1n; // doubleToIndex(-Number.MAX_VALUE) - 1 const num2Pow52 = 0x10000000000000; // Equivalent to 2 ** 52 @@ -9,7 +7,6 @@ const big2Pow53 = 9007199254740992n; // Equivalent to 2n ** 53n = 90071992547409 const f64 = new Float64Array(1); const u32 = new Uint32Array(f64.buffer, f64.byteOffset); -/** @internal */ function bitCastDoubleToUInt64(f: number): [number, number] { f64[0] = f; return [u32[1], u32[0]]; @@ -26,8 +23,6 @@ function bitCastDoubleToUInt64(f: number): [number, number] { * - Number.EPSILON = 2**(-52) * * @param d - 64-bit floating point number to be decomposed into (significand, exponent) - * - * @internal */ export function decomposeDouble(d: number): { exponent: number; significand: number } { const { 0: hi, 1: lo } = bitCastDoubleToUInt64(d); @@ -43,7 +38,6 @@ export function decomposeDouble(d: number): { exponent: number; significand: num return { exponent, significand }; } -/** @internal */ function indexInDoubleFromDecomp(exponent: number, significand: number): bigint { // WARNING: significand >= 0 @@ -71,8 +65,6 @@ function indexInDoubleFromDecomp(exponent: number, significand: number): bigint * Rq: Produces negative indexes for negative doubles * * @param d - 64-bit floating point number, anything except NaN - * - * @internal */ export function doubleToIndex(d: number): bigint { if (d === Number.POSITIVE_INFINITY) { @@ -95,8 +87,6 @@ export function doubleToIndex(d: number): bigint { * Compute the 64-bit floating point number corresponding to the provided indexes * * @param n - index of the double - * - * @internal */ export function indexToDouble(index: bigint): number { if (index < 0) { diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/EnumerableKeysExtractor.ts b/packages/fast-check/src/arbitrary/_internals/helpers/EnumerableKeysExtractor.ts index 0e7c10323..780105d2e 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/EnumerableKeysExtractor.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/EnumerableKeysExtractor.ts @@ -1,7 +1,5 @@ -/** @internal */ export type EnumerableKeyOf = Extract; -/** @internal */ export function extractEnumerableKeys(instance: T): EnumerableKeyOf[] { const keys = Object.keys(instance) as EnumerableKeyOf[]; // Only enumerable own properties const symbols = Object.getOwnPropertySymbols(instance) as EnumerableKeyOf[]; diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/FloatHelpers.ts b/packages/fast-check/src/arbitrary/_internals/helpers/FloatHelpers.ts index 519e24fe5..f6a0964cf 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/FloatHelpers.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/FloatHelpers.ts @@ -1,18 +1,12 @@ -/** @internal */ export const MIN_VALUE_32: number = 2 ** -126 * 2 ** -23; -/** @internal */ export const MAX_VALUE_32: number = 2 ** 127 * (1 + (2 ** 23 - 1) / 2 ** 23); -/** @internal */ export const EPSILON_32: number = 2 ** -23; -/** @internal */ const INDEX_POSITIVE_INFINITY = 2139095040; // floatToIndex(MAX_VALUE_32) + 1; -/** @internal */ const INDEX_NEGATIVE_INFINITY = -2139095041; // floatToIndex(-MAX_VALUE_32) - 1 const f32 = new Float32Array(1); const u32 = new Uint32Array(f32.buffer, f32.byteOffset); -/** @internal */ function bitCastFloatToUInt32(f: number): number { f32[0] = f; return u32[0]; @@ -31,8 +25,6 @@ function bitCastFloatToUInt32(f: number): number { * - Number.EPSILON = 2**(-52) * * @param f - 32-bit floating point number to be decomposed into (significand, exponent) - * - * @internal */ export function decomposeFloat(f: number): { exponent: number; significand: number } { const bits = bitCastFloatToUInt32(f); @@ -48,7 +40,6 @@ export function decomposeFloat(f: number): { exponent: number; significand: numb return { exponent, significand }; } -/** @internal */ function indexInFloatFromDecomp(exponent: number, significand: number) { // WARNING: significand >= 0 @@ -72,8 +63,6 @@ function indexInFloatFromDecomp(exponent: number, significand: number) { * Rq: Produces negative indexes for negative floats * * @param f - 32-bit floating point number - * - * @internal */ export function floatToIndex(f: number): number { if (f === Number.POSITIVE_INFINITY) { @@ -96,8 +85,6 @@ export function floatToIndex(f: number): number { * Compute the 32-bit floating point number corresponding to the provided indexes * * @param n - index of the float - * - * @internal */ export function indexToFloat(index: number): number { if (index < 0) { diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/FloatingOnlyHelpers.ts b/packages/fast-check/src/arbitrary/_internals/helpers/FloatingOnlyHelpers.ts index ed9f6d93d..dcb163f35 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/FloatingOnlyHelpers.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/FloatingOnlyHelpers.ts @@ -1,6 +1,5 @@ import type { DoubleConstraints } from '../../double.js'; -/** @internals */ export function refineConstraintsForFloatingOnly( constraints: Omit, maxValue: number, diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/GraphemeRangesHelpers.ts b/packages/fast-check/src/arbitrary/_internals/helpers/GraphemeRangesHelpers.ts index 936b24aee..1893ced6c 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/GraphemeRangesHelpers.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/GraphemeRangesHelpers.ts @@ -1,11 +1,9 @@ import type { GraphemeRange } from '../data/GraphemeRanges.js'; -/** @internal */ export type GraphemeRangeEntry = { num: number; build: (idInGroup: number) => string }; /** * Convert a range into an entry for mapToConstant - * @internal */ export function convertGraphemeRangeToMapToConstantEntry(range: GraphemeRange): GraphemeRangeEntry { if (range.length === 1) { @@ -18,7 +16,6 @@ export function convertGraphemeRangeToMapToConstantEntry(range: GraphemeRange): /** * Ranges have to be ordered and non-overlapping - * @internal */ export function intersectGraphemeRanges(rangesA: GraphemeRange[], rangesB: GraphemeRange[]): GraphemeRange[] { const mergedRanges: GraphemeRange[] = []; diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/InvalidSubdomainLabelFiIter.ts b/packages/fast-check/src/arbitrary/_internals/helpers/InvalidSubdomainLabelFiIter.ts index 8d7a6f5fc..78c71fff4 100644 --- a/packages/fast-check/src/arbitrary/_internals/helpers/InvalidSubdomainLabelFiIter.ts +++ b/packages/fast-check/src/arbitrary/_internals/helpers/InvalidSubdomainLabelFiIter.ts @@ -1,4 +1,3 @@ -/** @internal */ export function filterInvalidSubdomainLabel(subdomainLabel: string): boolean { // Here our definition of a subdomain is