Class: BaseStep

Defined in: src/types/logging/step.types.ts:107

Extended by

Constructors

Constructor

new BaseStep(type: StepType, data: BaseStepOptions): BaseStep;
Defined in: src/types/logging/step.types.ts:125

Parameters

type
StepType
data
BaseStepOptions

Returns

BaseStep

Properties

createdAt

createdAt: Date;
Defined in: src/types/logging/step.types.ts:114

datasetInput?

optional datasetInput: string;
Defined in: src/types/logging/step.types.ts:121

datasetMetadata?

optional datasetMetadata: Record<string, string> = {};
Defined in: src/types/logging/step.types.ts:123

datasetOutput?

optional datasetOutput: string;
Defined in: src/types/logging/step.types.ts:122

externalId?

optional externalId: string;
Defined in: src/types/logging/step.types.ts:119

input?

optional input: StepAllowedInputType;
Defined in: src/types/logging/step.types.ts:109

metrics

metrics: Metrics;
Defined in: src/types/logging/step.types.ts:118

name

name: string = "";
Defined in: src/types/logging/step.types.ts:113

output?

optional output: StepAllowedOutputType;
Defined in: src/types/logging/step.types.ts:111

redactedInput?

optional redactedInput: StepAllowedInputType;
Defined in: src/types/logging/step.types.ts:110

redactedOutput?

optional redactedOutput: StepAllowedOutputType;
Defined in: src/types/logging/step.types.ts:112

statusCode?

optional statusCode: number;
Defined in: src/types/logging/step.types.ts:117

stepNumber?

optional stepNumber: number;
Defined in: src/types/logging/step.types.ts:120

tags?

optional tags: string[];
Defined in: src/types/logging/step.types.ts:116

type

type: StepType;
Defined in: src/types/logging/step.types.ts:108

userMetadata

userMetadata: Record<string, string> = {};
Defined in: src/types/logging/step.types.ts:115

Methods

toJSON()

toJSON(): Record<string, any>;
Defined in: src/types/logging/step.types.ts:164

Returns

Record<string, any>

validateInputOutputSerializable()

validateInputOutputSerializable<T>(val: T): T;
Defined in: src/types/logging/step.types.ts:150

Type Parameters

T
T = | string | string[] | Document | Message | Record<string, string> | Message[] | Record<string, string>[] | Record<string, string>[] | Document[]

Parameters

val
T

Returns

T