@trophyso/node/api/types/StreakResponseStreakHistoryItem.d.ts

NodeJS SDK for the Trophy API

/**
 * An object representing a past streak period.
 */
export interface StreakResponseStreakHistoryItem {
    /** The date this streak period started. */
    periodStart: string;
    /** The date this streak period ended. */
    periodEnd: string;
    /** The length of the user's streak during this period. */
    length: number;
    /** Whether the user used a streak freeze during this period. Only present if the organization has enabled streak freezes. */
    usedFreeze?: boolean;
    /** Whether the user's streak was paused during this period. */
    usedPause: boolean;
}