Waiting for engine...
Skip to main content

useFetchEnvironmentStatus()

useFetchEnvironmentStatus(

__namedParameters: \\{ envId: string; \\}
):
{ status, name, fetchEnvironmentStatus, +2 more }

Fetches an environment's Atom attachments, resolves each Atom's status, and sets status to true only if all attached Atoms are ONLINE.

Throws

If the Boomi client or envId is missing when fetching.

Parameters

\_\_namedParameters

Fields: envId: string.

Returns

{ status: boolean; name: null | string; fetchEnvironmentStatus: () => Promise<void>; isLoading: boolean; error: null | string; }

Hook API with the online status, environment name, a refetch function, and state flags.

fetchEnvironmentStatus()

fetchEnvironmentStatus: () => Promise<void>

Returns

Promise<void>
On this Page