Home > @uniformdev/canvas > CanvasClient > getComponentDefinitions

CanvasClient.getComponentDefinitions() method

Fetches all Canvas component definitions

Signature:

getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
        componentDefinitions: components$n["schemas"]["ComponentDefinition"][];
    }>;

Parameters

ParameterTypeDescription
optionsOmit<ComponentDefinitionGetParameters, 'projectId'>(Optional)

Returns:

Promise<{ componentDefinitions: components$n["schemas"]["ComponentDefinition"][]; }>