Interface UseTakeHistoryResult

Return value of useTakeHistory.

interface UseTakeHistoryResult {
    clear: () => void;
    getStoredScore: (id: string) => Promise<StoredTakeScore | undefined>;
    results: SavedTakeResult[];
    save: (result: TakeResult) => void;
    update: (id: string, patch: Partial<SavedTakeResult>) => void;
}

Properties

clear: () => void

Forget every take

getStoredScore: (id: string) => Promise<StoredTakeScore | undefined>

A kept take's marked score, or undefined when it was not kept

The takes kept, newest first

save: (result: TakeResult) => void

Keep a graded take: its numbers in the list, its marked score alongside

update: (id: string, patch: Partial<SavedTakeResult>) => void

Change what is kept of one take