Home > @uniformdev/canvas > CanvasClient > getCompositionHistory

CanvasClient.getCompositionHistory() method

Fetches historical versions of a composition or pattern

Signature:

getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
        cursor?: string;
        truncated?: boolean;
        results?: components$m["schemas"]["HistoryEntry"][];
    }>;

Parameters

ParameterTypeDescription
optionsExceptProject<ComponentInstanceHistoryGetParameters>

Returns:

Promise<{ cursor?: string; truncated?: boolean; results?: components$m["schemas"]["HistoryEntry"][]; }>