Skip to main content

Function: useClass()

function useClass(stack, className): object;

Defined in: react/src/hooks/class.ts:236

Hook to retrieve a single Class instance by name.

Parameters

ParameterTypeDescription
stackstringThe name of the stack.
classNamestringThe name of the class to retrieve.

Returns

object

Object containing the Class instance, loading state, and error.

NameTypeDefined in
classObjClass | undefinedreact/src/hooks/class.ts:288
errorundefinedreact/src/hooks/class.ts:288
loadingbooleanreact/src/hooks/class.ts:288

Example

const ClassDetails = () => {
const { classObj, loading } = useClass('my-stack', 'User');

if (loading) return <div>Loading...</div>;
if (!classObj) return <div>Class not found</div>;

return <div>Class Description: {classObj.description}</div>;
};