fast-check - npm Package Compare versions

Comparing version 1.2.1 to 1.2.2

documentation/Arbitraries.md

@@ -64,3 +64,3 @@ # [:house:](../README.md) Arbitraries
 - `fc.constant<T>(value: T): Arbitrary<T>` constant arbitrary only able to produce `value: T`
-- `fc.constantFrom<T>(...values: T[]): Arbitrary<T>` randomly chooses among the values provided. It considers the first value as the default value so that in case of failure it will shrink to it
+- `fc.constantFrom<T>(...values: T[]): Arbitrary<T>` randomly chooses among the values provided. It considers the first value as the default value so that in case of failure it will shrink to it. It expects a minimum of one value and throws whether it receives no value as parameters. It can easily be used on arrays with `fc.constantFrom(...myArray)` (or `fc.constantFrom.apply(null, myArray)` for older versions of TypeScript/JavaScript)
 - `fc.oneof<T>(...arbs: Arbitrary<T>[]): Arbitrary<T>` randomly chooses an arbitrary at each new generation. Should be provided with at least one arbitrary. All arbitraries are equally probable and shrink is still working for the selected arbitrary. `fc.oneof` is able to shrink inside the failing arbitrary but not accross arbitraries (contrary to `fc.constantFrom` when dealing with constant arbitraries)
@@ -67,0 +67,0 @@ - `fc.option<T>(arb: Arbitrary<T>): Arbitrary<T | null>` or `fc.option<T>(arb: Arbitrary<T>, freq: number): Arbitrary<T | null>` arbitrary able to nullify its generated value. When provided a custom `freq` value it changes the frequency of `null` values so that they occur one time over `freq` tries (eg.: `freq=5` means that 20% of generated values will be `null` and 80% would be produced through `arb`). By default: `freq=5`

lib/check/arbitrary/ArrayArbitrary.d.ts

@@ -0,0 +0,0 @@ import Random from '../../random/generator/Random';

lib/check/arbitrary/ArrayArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/BooleanArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/BooleanArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/CharacterArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/CharacterArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/ConstantArbitrary.d.ts

@@ -8,7 +8,9 @@ import Arbitrary from './definition/Arbitrary';
 /**
- * For one of `v0` or `...values` values - all equiprobable
- * @param v0 One of the value to produce (all values shrink to this one)
- * @param values Other possible values
+ * For one `...values` values - all equiprobable
+ *
+ * **WARNING**: It expects at least one value, otherwise it should throw
+ *
+ * @param values Constant values to be produced (all values shrink to the first one)
  */
-declare function constantFrom<T>(v0: T, ...values: T[]): Arbitrary<T>;
+declare function constantFrom<T>(...values: T[]): Arbitrary<T>;
 export { constant, constantFrom };

lib/check/arbitrary/ConstantArbitrary.js

@@ -101,14 +101,19 @@ "use strict";
 /**
- * For one of `v0` or `...values` values - all equiprobable
- * @param v0 One of the value to produce (all values shrink to this one)
- * @param values Other possible values
+ * For one `...values` values - all equiprobable
+ *
+ * **WARNING**: It expects at least one value, otherwise it should throw
+ *
+ * @param values Constant values to be produced (all values shrink to the first one)
  */
-function constantFrom(v0) {
+function constantFrom() {
     var values = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        values[_i - 1] = arguments[_i];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        values[_i] = arguments[_i];
     }
-    return new ConstantArbitrary(__spread([v0], values));
+    if (values.length === 0) {
+        throw new Error('fc.constantFrom expects at least one parameter');
+    }
+    return new ConstantArbitrary(__spread(values));
 }
 exports.constantFrom = constantFrom;
 //# sourceMappingURL=ConstantArbitrary.js.map

lib/check/arbitrary/definition/Arbitrary.d.ts

@@ -0,0 +0,0 @@ import Random from '../../../random/generator/Random';

lib/check/arbitrary/definition/Arbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/definition/ArbitraryWithShrink.d.ts

@@ -0,0 +0,0 @@ import Random from '../../../random/generator/Random';

lib/check/arbitrary/definition/ArbitraryWithShrink.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/definition/BiasedArbitraryWrapper.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './Arbitrary';

lib/check/arbitrary/definition/BiasedArbitraryWrapper.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/definition/Shrinkable.d.ts

@@ -0,0 +0,0 @@ import Stream from '../../../stream/Stream';

lib/check/arbitrary/definition/Shrinkable.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/DictionaryArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/DictionaryArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/FloatingPointArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/FloatingPointArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/FrequencyArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/FrequencyArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/IntegerArbitrary.d.ts

@@ -0,0 +0,0 @@ import { ArbitraryWithShrink } from './definition/ArbitraryWithShrink';

lib/check/arbitrary/IntegerArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/LoremArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/LoremArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/ObjectArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/ObjectArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/OneOfArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/OneOfArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/OptionArbitrary.d.ts

@@ -0,0 +0,0 @@ import { Arbitrary } from './definition/Arbitrary';

lib/check/arbitrary/OptionArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/RecordArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/RecordArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/SetArbitrary.d.ts

@@ -0,0 +0,0 @@ import { Arbitrary } from './definition/Arbitrary';

lib/check/arbitrary/SetArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/StringArbitrary.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/StringArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/TupleArbitrary.d.ts

 import { tuple } from './TupleArbitrary.generated';
 import { genericTuple } from './TupleArbitrary.generic';
 export { tuple, genericTuple };

lib/check/arbitrary/TupleArbitrary.generated.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from './definition/Arbitrary';

lib/check/arbitrary/TupleArbitrary.generated.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/TupleArbitrary.generic.d.ts

@@ -0,0 +0,0 @@ import Random from '../../random/generator/Random';

lib/check/arbitrary/TupleArbitrary.generic.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/arbitrary/TupleArbitrary.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/AsyncProperty.d.ts

 import { asyncProperty } from './AsyncProperty.generated';
 import { AsyncProperty } from './AsyncProperty.generic';
 export { asyncProperty, AsyncProperty };

lib/check/property/AsyncProperty.generated.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from '../arbitrary/definition/Arbitrary';

lib/check/property/AsyncProperty.generated.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/AsyncProperty.generic.d.ts

@@ -0,0 +0,0 @@ import Random from '../../random/generator/Random';

lib/check/property/AsyncProperty.generic.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/AsyncProperty.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/IProperty.d.ts

@@ -0,0 +0,0 @@ import Random from '../../random/generator/Random';

lib/check/property/IProperty.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/Property.d.ts

 import { property } from './Property.generated';
 import { Property } from './Property.generic';
 export { property, Property };

lib/check/property/Property.generated.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from '../arbitrary/definition/Arbitrary';

lib/check/property/Property.generated.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/Property.generic.d.ts

@@ -0,0 +0,0 @@ import Random from '../../random/generator/Random';

lib/check/property/Property.generic.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/Property.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/TimeoutProperty.d.ts

@@ -0,0 +0,0 @@ import Random from '../../random/generator/Random';

lib/check/property/TimeoutProperty.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/property/UnbiasedProperty.d.ts

@@ -0,0 +0,0 @@ import Random from '../../random/generator/Random';

lib/check/property/UnbiasedProperty.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/runner/configuration/Parameters.d.ts

@@ -0,0 +0,0 @@ /**

lib/check/runner/configuration/Parameters.js

 "use strict";
 exports.__esModule = true;
 //# sourceMappingURL=Parameters.js.map

lib/check/runner/configuration/QualifiedParameters.d.ts

@@ -0,0 +0,0 @@ import { Parameters } from './Parameters';

lib/check/runner/configuration/QualifiedParameters.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/runner/reporter/RunDetails.d.ts

@@ -0,0 +0,0 @@ /**

lib/check/runner/reporter/RunDetails.js

 "use strict";
 exports.__esModule = true;
 //# sourceMappingURL=RunDetails.js.map

lib/check/runner/reporter/RunExecution.d.ts

@@ -0,0 +0,0 @@ import { RunDetails } from './RunDetails';

lib/check/runner/reporter/RunExecution.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/runner/Runner.d.ts

@@ -0,0 +0,0 @@ import { AsyncProperty } from '../property/AsyncProperty';

lib/check/runner/Runner.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/runner/Sampler.d.ts

@@ -0,0 +0,0 @@ import Arbitrary from '../arbitrary/definition/Arbitrary';

lib/check/runner/Sampler.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/runner/Tosser.d.ts

@@ -0,0 +0,0 @@ import Shrinkable from '../arbitrary/definition/Shrinkable';

lib/check/runner/Tosser.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/runner/utils/PathWalker.d.ts

 import Shrinkable from '../../arbitrary/definition/Shrinkable';
 /** @hidden */
 export declare function pathWalk<Ts>(path: string, initialValues: IterableIterator<Shrinkable<Ts>>): IterableIterator<Shrinkable<Ts>>;

lib/check/runner/utils/PathWalker.js

@@ -0,0 +0,0 @@ "use strict";

lib/check/runner/utils/utils.d.ts

@@ -0,0 +0,0 @@ import { RunDetails } from '../reporter/RunDetails';

lib/check/runner/utils/utils.js

@@ -0,0 +0,0 @@ "use strict";

lib/fast-check-default.d.ts

@@ -0,0 +0,0 @@ import 'core-js';

lib/fast-check-default.js

@@ -0,0 +0,0 @@ "use strict";

lib/fast-check.d.ts

 import * as fc from './fast-check-default';
 export default fc;
 export * from './fast-check-default';

lib/fast-check.js

@@ -0,0 +0,0 @@ "use strict";

lib/random/generator/Random.d.ts

@@ -0,0 +0,0 @@ import * as prand from 'pure-rand';

lib/random/generator/Random.js

@@ -0,0 +0,0 @@ "use strict";

lib/stream/Stream.d.ts

@@ -0,0 +0,0 @@ export default class Stream<T> implements IterableIterator<T> {

lib/stream/Stream.js

@@ -0,0 +0,0 @@ "use strict";

package.json

 {
   "name": "fast-check",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Property based testing framework in TypeScript (like QuickCheck)",
@@ -5,0 +5,0 @@ "main": "lib/fast-check.js",

src/check/arbitrary/ConstantArbitrary.ts

@@ -34,10 +34,15 @@ import Random from '../../random/generator/Random';
 /**
- * For one of `v0` or `...values` values - all equiprobable
- * @param v0 One of the value to produce (all values shrink to this one)
- * @param values Other possible values
+ * For one `...values` values - all equiprobable
+ *
+ * **WARNING**: It expects at least one value, otherwise it should throw
+ *
+ * @param values Constant values to be produced (all values shrink to the first one)
  */
-function constantFrom<T>(v0: T, ...values: T[]): Arbitrary<T> {
-  return new ConstantArbitrary<T>([v0, ...values]);
+function constantFrom<T>(...values: T[]): Arbitrary<T> {
+  if (values.length === 0) {
+    throw new Error('fc.constantFrom expects at least one parameter');
+  }
+  return new ConstantArbitrary<T>([...values]);
 }
 
 export { constant, constantFrom };

No alert changes

Improved metrics

Total package byte prevSize

1295934

increased by0.91%

Lines of code

23504

increased by0.07%

No dependency changes