Skip to content

egon-orm-workspace / egon-orm / BatchStep

Interface: BatchStep ​

Defined in: core/src/batch/batch.ts:133

One step of a batch, as Batch.toList lists it.

  • name: the step's name; undefined for merge and for an inspect without one.
  • input: what the step was given: a changeset, a row, a query, a value, or the function that computes it from the results before it (the callback of run, inspect and merge).
  • schema: the schema class of an insertAll; undefined otherwise.
  • args: the arguments after the input: the options, or a query's named parameters and options.

Example ​

ts
expect(Batch.toList(signUp).map((step) => step.name)).toEqual(["user", "profile", "welcome"]);

Properties ​

args ​

ts
readonly args: readonly unknown[];

Defined in: core/src/batch/batch.ts:138


input ​

ts
readonly input: unknown;

Defined in: core/src/batch/batch.ts:136


name ​

ts
readonly name: string | undefined;

Defined in: core/src/batch/batch.ts:134


operation ​

ts
readonly operation: BatchOperation;

Defined in: core/src/batch/batch.ts:135


schema ​

ts
readonly schema: AnySchema | undefined;

Defined in: core/src/batch/batch.ts:137