Skip to content

Introduction

The whole ecosystem is based on various building blocks. This section aims on giving an introduction into them.

Fabrication Pipeline

Fabrication Pipeline represents the whole flow of the falsa generation - from loading and compiling of a given schema to generation of falsum objects.

Fabricator

Fabricator is a base entrypoint to the whole fabrication ecosystem. This component is responsible for managing and maintaining of the whole falsa generation - fabrication pipeline.

Schema

Schema is an internal representation of what the client described in his Schema Input provided to Fabricator and what is he expected to have at the end of the fabrication pipeline.

Schema Input

Schema Input represents client given declaration of how should the generated falsa look like.

This input is then compiled inside in the Fabricator into the actual Schema that is being used in the Fabrication Pipeline.

Value Generator

Value generator is a component being able to generate a specific type of values. There are many kinds of them defined in the ecosystem; each using a different strategy and providing a different kind of value generation.

Each Value Generator has its name assigned, so you can always refer to it by its name. You can also generate your own generators when you find yourself in situation of not finding any suitable solution. You can also register them to access your specifics whenever you need:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { registerValueGenerator, get } from '@falbricate/base';

// Registration of your custom Value Generator
registerValueGenerator(
  'my-custom-generator',
  (config: MyGeneratorConfig) => new MyGenerator(config),
);

// Accessing your Value Generator in code
const generator = getValueGenerator('my-custom-generator', {
  requiredParam1: 'my-parameter',
  requiredParam2: 123,
});