Skip to content

Array generators

Here is a list of predefined generators for generating array values.

Array Picker

Returns a value by randomly selecting an item from the specified array in the configuration.

The array field can be an array of any type; the only restriction is it needs to be at least one item long.

Examples

1
2
3
4
5
6
7
const config: ArrayPickerConfig = {
    array: ['a', 'b', 'c', 'd']
}

const generator = new ArrayPicker(config);

console.log(generator.generate());

Output

a

1
2
3
4
5
6
7
const config: ArrayPickerConfig = {
    array: ['a', 'b', 'c', 'd']
}

const generator = getValueGenerator('array-picker', config);

const value = generator.get({});

Output

a

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
const schema: SchemaInput = {
    fields: {
        value: {
            type: 'array-picker',
            config: {
                array: ['a', 'b', 'c', 'd']
            }
        }
    }
}

const fabricator = new Fabricator(schema);

console.log(fabricator.generate());

Output

{ value: 'a' }

Array Sample

This generator creates a deep copy of the specified array and returns a shuffled sample of it.

It takes array field as a non-empty array of items of any type and the sampleSize which is any integer number greater than 0.

When these requirements are not met, it throws an error; so it does when the sample size is greater than the length of the given array.

Examples

1
2
3
4
5
6
7
8
const config: ArraySampleConfig = {
    array: ['a', 'b', 'c', 'd'],
    sampleSize: 2
}

const generator = new ArraySampleGenerator(config);

console.log(generator.get({}));

Output

[ 'd', 'b' ]

1
2
3
4
5
6
7
8
const config: ArraySampleConfig = {
    array: ['a', 'b', 'c', 'd'],
    sampleSize: 2
}

const generator = getValueGenerator('array-sample', config);

console.log(generator.get({}));

Output

[ 'd', 'b' ]

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const schema: SchemaInput = {
    fields: {
        value: {
            type: 'array-sample',
            config: {
                array: ['a', 'b', 'c', 'd'],
                sampleSize: 2
            }
        }
    }
}

const fabricator = new Fabricator(schema);

console.log(fabricator.generate());

Output

{ value: [ 'd', 'b' ] }