Class TypeFieldProcessor

Generate values for fields according to the field type

Hierarchy

BaseFieldProcessor
- TypeFieldProcessor
  - CountFieldProcessor

Index

Constructors

constructor

Properties

generator

Methods

Constructors

constructor

new TypeFieldProcessor(generator: SchemaPayloadGenerator): TypeFieldProcessor

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

Properties

Protected generator

generator: SchemaPayloadGenerator

Methods

Protected executeCustomTypeProcessor

executeCustomTypeProcessor(processor: function, field: IFieldProcessingData): Promise<IFieldPossiblePayload[]>

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:40
Parameters
- processor: function
  - - (fieldSchema: JSONSchema6): Promise<any>
    - Parameters
      - fieldSchema: JSONSchema6
      Returns Promise<any>
- field: IFieldProcessingData
Returns Promise<IFieldPossiblePayload[]>

Protected flattenObjectPropertiesToPayloads

flattenObjectPropertiesToPayloads(field: IFieldProcessingData, propertiesPossiblePayloads: object): IFieldPossiblePayload[]

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:265
Turn an object field's possibilities tree into actual payloads

Parameters
- field: IFieldProcessingData
- propertiesPossiblePayloads: object
  - [key: string]: IFieldPossiblePayload[]
Returns IFieldPossiblePayload[]

generateFieldPayloads

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

Overrides BaseFieldProcessor.generateFieldPayloads
- Defined in schemaFieldProcessors/typeFieldProcessor.ts:24
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 processSchemaField_array

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:73
Generate values for an array field

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

Protected processSchemaField_boolean

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:48
Generate values for a boolean field

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

Protected processSchemaField_enum

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:139
Generate values for a field with an enum

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

Protected processSchemaField_integer

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:55
Generate values for an integer field

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

Protected processSchemaField_number

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:68
Generate values for a number field

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

Protected processSchemaField_object

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:230
Generate values for an object field

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

Protected processSchemaField_object_allOf

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:164
Parameters
- field: IFieldProcessingData
Returns Promise<IFieldPossiblePayload[]>

Protected processSchemaField_object_anyOf

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:184
Parameters
- field: IFieldProcessingData
Returns Promise<IFieldPossiblePayload[]>

Protected processSchemaField_object_oneOf

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:145
Parameters
- field: IFieldProcessingData
Returns Promise<IFieldPossiblePayload[]>

Protected processSchemaField_string

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

- Defined in schemaFieldProcessors/typeFieldProcessor.ts:123
Generate values for an object field

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

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