AeontelAeontel Docs

Builds hooks

Hand-written shim. Generated list+get via ./builds.gen. useCancelBuild stays hand-written.

Hooks

useCancelBuild composite

TypeScript
useCancelBuild(options?: MutationOpts<SuccessResponse, CancelBuildParams>)

Types: SuccessResponse · CancelBuildParams

useCreateBuild mutation

Trigger a build.

TypeScript
useCreateBuild(options?: MutationOpts<Build, CreateBuildParams>)

Types: Build · CreateBuildParams

useListBuilds query

List builds.

TypeScript
useListBuilds(params?: Omit<ListBuildsParams, | > & { filter?: BuildFilter; orderBy?: BuildOrderBy[]; } & BuildShorthands, options?: QueryOpts<Page<Build>>)

Types: ListBuildsParams · BuildFilter · BuildOrderBy · BuildShorthands · Page · Build

useRetrieveBuild query

Get a build by ID, including its step list.

TypeScript
useRetrieveBuild(id: string, options?: QueryOpts<BuildWithSteps>)

Types: BuildWithSteps