Core API Overview > @adpt/core > UseDeployedWhenOptions > trivial
UseDeployedWhenOptions.trivial property
This flag is a hint for user interfaces, such as the Adapt CLI. It tells the user interface that this component's deployedWhen
function is "trivial" and therefore its status should not typically be shown in user interfaces unless the user has requested more detailed status information on all components, or if there's an active action for the component.
trivial
should typically be set to true
if the deployedWhen
function **only** depends on the status of other components and does not have any additional conditions of its own.
Signature:
trivial?: boolean;
Example 1
A component's deployedWhen
function waits for its children to become deployed, but doesn't have any other meaningful information to share. In this case, the trivial
flag should likely be set to true
.
Example 2
A component's deployedWhen
function makes an HTTP connection to an external API endpoint, checking to see if the API is up and accepting queries. In this case, the trivial
flag should be false
(default value).