Function jump

  • Returns a jump action object for an NgUndo reducer action with the specified index to jump to in the history.

    Function

    Name

    jump

    Example

    @Dispatch
    public jump() {
    // Jump 2 steps forward in the history
    return jump('test', 2);
    // Returns { type: '&_NG-UNDO', payload: { type: 'JUMP', propertyName: 'test', index: 2 } }
    }

    @Dispatch
    public jump() {
    // Jump -2 steps back in the history
    return jump('test', -2);
    // Returns { type: '&_NG-UNDO', payload: { type: 'JUMP', propertyName: 'test', index: -2 } }
    }

    Parameters

    • propertyName: string

      The propertyName used to identify actions related to the NgUndo reducer.

    • index: number

      The index of the history to jump to.

    Returns any

    An action object with a type and payload property for jumping to a specific property state change in the history.

Generated using TypeDoc