Skip to main content

Function: useDomainCreate()

function useDomainCreate(stack): (domainName, cardinality, sourceClass, targetClass, domainDesc?) => Promise<Domain | null>;

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

Hook to create a new Domain in a specific stack.

Parameters

ParameterTypeDescription
stackstringThe name of the stack to create the domain in.

Returns

A callback function to create the domain.

(
domainName,
cardinality,
sourceClass,
targetClass,
domainDesc?): Promise<Domain | null>;

Parameters

ParameterType
domainNamestring
cardinality"1:1" | "1:N" | "N:1" | "N:N"
sourceClassClass
targetClassClass
domainDesc?string

Returns

Promise<Domain | null>

Example

const CreateDomain = () => {
const createDomain = useDomainCreate('my-stack');
// Assume sourceClass and targetClass are available Class instances

const handleCreate = async () => {
const newDomain = await createDomain(
'UserProjects',
'1:N',
userClass,
projectClass,
'User has many projects'
);
};

return <button onClick={handleCreate}>Create Domain</button>;
};