Mayson Monorepo Documentation
    Preparing search index...

    Interface IPortfolioAlert

    Portfolio Alert for monitoring overall portfolio value

    interface IPortfolioAlert {
        _id?: string;
        userId: string;
        thresholdPercent: number;
        direction: PortfolioAlertDirection;
        notificationType: AlertNotificationType;
        status: AlertStatus;
        baselineValue: number;
        triggerValue: number;
        triggeredAt?: Date;
        triggeredValue?: number;
        createdAt: Date;
        updatedAt: Date;
    }
    Index

    Properties

    _id? userId thresholdPercent direction notificationType status baselineValue triggerValue triggeredAt? triggeredValue? createdAt updatedAt

    Properties

    Optional_id

    _id?: string
    userId: string

    User ID

    thresholdPercent: number

    Threshold percentage (e.g., 10 for 10%)

    direction: PortfolioAlertDirection

    Direction: alert on gain or loss

    notificationType: AlertNotificationType

    How to notify the user

    status: AlertStatus

    Alert status

    baselineValue: number

    Portfolio value when alert was set

    triggerValue: number

    Calculated value that triggers the alert

    triggeredAt?: Date

    When the alert was triggered

    triggeredValue?: number

    Portfolio value when triggered

    createdAt: Date

    Created timestamp

    updatedAt: Date

    Updated timestamp

    Settings

    Member Visibility

    On This Page

    Properties