Hierarchy

  • Shift

Properties

Properties

$shift: {
    by: number;
    default?: any;
    output: any;
}

Returns the value from an expression applied to a document in a specified position relative to the current document in the $setWindowFields stage partition.

Type declaration

  • by: number

    Specifies an integer with a numeric document position relative to the current document in the output.

  • Optional default?: any

    Specifies an optional default expression to evaluate if the document position is outside of the implicit $setWindowFields stage window. The implicit window contains all the documents in the partition.

  • output: any

    Specifies an expression to evaluate and return in the output.

Generated using TypeDoc