UNPKG

@sugarcube/test

Version:

Test helpers and strategies for SugarCube.

github.com/critocrito/sugarcube/tree/master

critocrito/sugarcube

98 lines (54 loc) • 3.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# `@sugarcube/test` Test helpers for SugarCube. ## Installation ``` npm install --save @sugarcube/test ``` ## API ### generators.listArb An arbitrary that can be used in `jsverify` based property tests. It produces a single object that resembles a list. ### generators.listsArb An arbitrary that can be used in `jsverify` based property tests. It produces an array of objects, where each object is a list. ### generators.lists Randonly generate a list of lists. **Parameters** - `size` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The number of lists to generate. Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A list of list objects. ### generators.queryArb An arbitrary that can be used in `jsverify` based property tests. It produces a single object that resembles a query. ### generators.queriesArb An arbitrary that can be used in `jsverify` based property tests. It produces an array of objects, where each object is a list. ### generators.queries Randonly generate a list of queries. **Parameters** - `size` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The number of queries to generate. Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A list of queries. ### generators.unitArb An arbitrary that can be used in `jsverify` based property tests. It produces a single object that resembles a unit of data. ### generators.unit Randomly generate a single unit of data. Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** A unit of data. ### generators.dataArb An arbitrary that can be used in `jsverify` based property tests. It produces an array of objects, where each object is a unit of data. ### generators.data Randonly generate units of data.. **Parameters** - `size` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The number of data units to generate. Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** A list of data units. ### generators.envelopeArb An arbitrary that can be used in `jsverify` based property tests. It produces an object that is an envelope.. ### generators.envelope Randomly generate a envelope with data and queries. **Parameters** - `sizeData` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The number of data units in the envelope. - `sizeQueries` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The number of queries in the envelope. Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** A unit of data. ## License [GPL3](./LICENSE) @ [Christo](christo@cryptodrunks.net)