Class CustomFieldProcessor

Allows the use to load custom field-processing function and generate values by them

Hierarchy

BaseFieldProcessor
- CustomFieldProcessor

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CustomFieldProcessor(generator: SchemaPayloadGenerator): CustomFieldProcessor

Overrides BaseFieldProcessor.constructor
- Defined in schemaFieldProcessors/customFieldProcessor.ts:15
Parameters
- generator: SchemaPayloadGenerator
Returns CustomFieldProcessor

Properties

Protected generator

generator: SchemaPayloadGenerator

Protected processingFunctions

processingFunctions: CustomProcessorFunction[]

The user loaded processing functions

Methods

generateFieldPayloads

generateFieldPayloads(field: IFieldProcessingData): Promise<IFieldPossiblePayload[]>

Overrides BaseFieldProcessor.generateFieldPayloads
- Defined in schemaFieldProcessors/customFieldProcessor.ts:25
Actually generate values for the given fields

Parameters
- field: IFieldProcessingData
  
  The field to process
Returns Promise<IFieldPossiblePayload[]>

Protected generatePayloadID

generatePayloadID(field: IFieldProcessingData, payloadIndex: number): string

Inherited from BaseFieldProcessor.generatePayloadID
- Defined in schemaFieldProcessors/baseFieldProcessor.ts:37
Generate unique IDs for a payload possibility

Parameters
- field: IFieldProcessingData
  
  The field being processed
- payloadIndex: number
  
  The payload index from the available possibilities
Returns string

Protected rawValuesToPossiblePayloads

rawValuesToPossiblePayloads(rawValues: any[], field: IFieldProcessingData): IFieldPossiblePayload[]

Inherited from BaseFieldProcessor.rawValuesToPossiblePayloads
- Defined in schemaFieldProcessors/baseFieldProcessor.ts:28
Wraps raw generated values into possible payload objects that can be used further down the line

Parameters
- rawValues: any[]
  
  The generated values
- field: IFieldProcessingData
  
  The field being processed
Returns IFieldPossiblePayload[]

Generated using TypeDoc