AeontelAeontel Docs

Deploys hooks

Hand-written shim. Generated list+get via ./deploys.gen. useCancelDeploy stays hand-written.

Hooks

useCancelDeploy composite

TypeScript
useCancelDeploy(options?: MutationOpts<SuccessResponse, CancelDeployParams>)

Types: SuccessResponse · CancelDeployParams

useCreateDeploy mutation

Trigger a deploy.

TypeScript
useCreateDeploy(options?: MutationOpts<Deploy, CreateDeployParams>)

Types: Deploy · CreateDeployParams

useListDeploys query

List deploys.

TypeScript
useListDeploys(params?: Omit<ListDeploysParams, | > & { filter?: DeployFilter; orderBy?: DeployOrderBy[]; } & DeployShorthands, options?: QueryOpts<Page<Deploy>>)

Types: ListDeploysParams · DeployFilter · DeployOrderBy · DeployShorthands · Page · Deploy

useRetrieveDeploy query

Get a deploy by ID, including its step list.

TypeScript
useRetrieveDeploy(id: string, options?: QueryOpts<DeployWithSteps>)

Types: DeployWithSteps