Member Junction
    Preparing search index...

    Class NoOpStage

    A registered unit of pipeline work: one working record in, one outcome out. Adding a stage is writing a class and registering it — never editing a list.

    Cold start is the normal case: in production a stage gets a record hydrated moments ago, with no other stage having run in the same call, so a missing optional field is a legitimate input.

    @RegisterClass(BasePipelineStage, 'Extract')
    export class ExtractStage extends BasePipelineStage {
        public readonly Name = 'Extract';
        public readonly Entity: WorkingRecordEntity = 'Content Item';
        public readonly StatusField = 'ExtractionStatus';
        public async Run(record: WorkingRecord, context: StageContext): Promise<StageOutcome> { ... }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    Entity Name StatusField

    Accessors

    CompleteStatus Declaration

    Methods

    Finalize? Run StatusForOutcome Resolve

    Constructors

    Properties

    Entity: WorkingRecordEntity = 'Content Item'

    The entity this stage runs over.

    Name: "NoOp" = NO_OP_STAGE

    The registered name; must match the @RegisterClass key.

    StatusField: "ExtractionStatus" = 'ExtractionStatus'

    The status column the committer advances and a Record Process's filter reads (e.g. ExtractionStatus). null for Discover, which walks every source selected by the Record Process filter rather than advancing a status.

    Accessors

    • get CompleteStatus(): string

      The value StatusField takes on success. The vocabulary belongs to the column (DeleteStatus uses 'Deleted').

      Returns string

    • get Declaration(): StageDeclaration

      Returns StageDeclaration

    Methods

    • Optional bulk step for work far cheaper in bulk (one embedding call for fifty texts). Run then only gathers; Finalize gets the page's records and returns one outcome each. Used only when the stage is last in the run's list.

      Parameters

      Returns Promise<FinalizeResult[]>

    • The value for a Skipped or finally Failed outcome, or null to leave the column alone.

      Parameters

      • outcome: "Failed" | "Skipped"

      Returns string

    • Resolve a registered stage, or null. Uses TryCreateInstance because CreateInstance falls back to a hollow base instance on an unknown key, which would make a typo in a Record Process silently do nothing.

      Parameters

      • name: string

      Returns BasePipelineStage

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods