Skip to main content

QFakerGenerateEngine

@quik/faker

@quik/faker / QFakerGenerateEngine

Class: QFakerGenerateEngine

Defined in: faker/src/engine/QFakerGenerateEngine.ts:18

Inserts batches of fake records into the database for one or more models.

Extends​

  • QObject

Constructors​

Constructor​

new QFakerGenerateEngine(): QFakerGenerateEngine

Returns​

QFakerGenerateEngine

Inherited from​

QObject.constructor

Accessors​

logger​

Get Signature​

get protected logger(): IQLogger

Defined in: core/src/QObject.ts:15

The logger getter for the object.

Returns​

IQLogger

Inherited from​

QObject.logger

name​

Get Signature​

get name(): string

Defined in: core/src/QObject.ts:8

Returns​

string

Inherited from​

QObject.name

Methods​

endSpan()​

protected endSpan(span): void

Defined in: core/src/QObject.ts:35

End a span returned by startSpan.

Parameters​

span​

TelemetrySpan

The span to end.

Returns​

void

Inherited from​

QObject.endSpan

recordSpanError()​

protected recordSpanError(span, err): void

Defined in: core/src/QObject.ts:45

Record an exception on an active span.

Parameters​

span​

TelemetrySpan

The span to record the error on.

err​

unknown

The error to record.

Returns​

void

Inherited from​

QObject.recordSpanError

run()​

run(spec, modelName): Promise<void>

Defined in: faker/src/engine/QFakerGenerateEngine.ts:41

Runs the generate engine for a single named model.

Parameters​

spec​

QFakerSpec

Faker spec document

modelName​

string

Key of the model inside spec.models

Returns​

Promise<void>

Throws​

When the model is not found in the spec or has the wrong mode

runAll()​

runAll(spec): Promise<void>

Defined in: faker/src/engine/QFakerGenerateEngine.ts:25

Runs the generate engine for every model in the spec that uses mode: "generate".

Parameters​

spec​

QFakerSpec

Faker spec document

Returns​

Promise<void>

Throws​

When a generator path cannot be resolved or unique retries are exhausted

runModel()​

protected runModel(faker, _spec, modelName, modelSpec): Promise<void>

Defined in: faker/src/engine/QFakerGenerateEngine.ts:54

Parameters​

faker​

Faker

_spec​

QFakerSpec

modelName​

string

modelSpec​

QFakerModelSpec

Returns​

Promise<void>

setSpanAttribute()​

protected setSpanAttribute(span, key, value): void

Defined in: core/src/QObject.ts:64

Set a single attribute on an active span.

Parameters​

span​

TelemetrySpan

The span to update.

key​

string

Attribute key.

value​

string | number | boolean

Attribute value.

Returns​

void

Inherited from​

QObject.setSpanAttribute

startSpan()​

protected startSpan(spanName, options?): TelemetrySpan

Defined in: core/src/QObject.ts:26

Start a telemetry span for the given operation name. Returns undefined when no telemetry provider is active.

Parameters​

spanName​

string

Name of the span.

options?​

TelemetrySpanOptions

Optional span attributes and kind.

Returns​

TelemetrySpan

Inherited from​

QObject.startSpan