Skip to main content

Function: useDomain()

function useDomain(stack, domainName): object;

Defined in: react/src/hooks/domain.ts:233

Hook to retrieve a single Domain instance by name.

Parameters​

ParameterTypeDescription
stackstringThe name of the stack.
domainNamestringThe name of the domain to retrieve.

Returns​

object

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

NameTypeDefined in
domainDomain | undefinedreact/src/hooks/domain.ts:285
errorundefinedreact/src/hooks/domain.ts:285
loadingbooleanreact/src/hooks/domain.ts:285

Example​

const DomainDetails = () => {
const { domain, loading } = useDomain('my-stack', 'UserProjects');

if (loading) return <div>Loading...</div>;
if (!domain) return <div>Domain not found</div>;

return <div>Relation Type: {domain.relation}</div>;
};