Class: BaseSpan

Defined in: src/types/logging/span.types.ts:25

Extends

Extended by

Constructors

Constructor

new BaseSpan(type: StepType, data: BaseSpanOptions): BaseSpan;

Defined in: src/types/logging/span.types.ts:28

Parameters

type

StepType

data

BaseSpanOptions

Returns

BaseSpan

Overrides

BaseStep.constructor

Properties

createdAt

createdAt: Date;

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

Inherited from

BaseStep.createdAt


datasetInput?

optional datasetInput: string;

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

Inherited from

BaseStep.datasetInput


datasetMetadata?

optional datasetMetadata: Record<string, string> = {};

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

Inherited from

BaseStep.datasetMetadata


datasetOutput?

optional datasetOutput: string;

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

Inherited from

BaseStep.datasetOutput


externalId?

optional externalId: string;

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

Inherited from

BaseStep.externalId


input

input: StepAllowedInputType;

Defined in: src/types/logging/span.types.ts:26

Overrides

BaseStep.input


metrics

metrics: Metrics;

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

Inherited from

BaseStep.metrics


name

name: string = "";

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

Inherited from

BaseStep.name


output?

optional output: StepAllowedOutputType;

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

Inherited from

BaseStep.output


statusCode?

optional statusCode: number;

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

Inherited from

BaseStep.statusCode


stepNumber?

optional stepNumber: number;

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

Inherited from

BaseStep.stepNumber


tags?

optional tags: string[];

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

Inherited from

BaseStep.tags


type

type: StepType;

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

Inherited from

BaseStep.type


userMetadata

userMetadata: Record<string, string> = {};

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

Inherited from

BaseStep.userMetadata

Methods

toJSON()

toJSON(): Record<string, any>;

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

Returns

Record<string, any>

Inherited from

BaseStep.toJSON


validateInputOutputSerializable()

validateInputOutputSerializable<T>(val: T): T;

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

Type Parameters

T

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

Parameters

val

T

Returns

T

Inherited from

BaseStep.validateInputOutputSerializable