AeontelAeontel Docs

Swarm Versions hooks

Hand-written shim. Generated CRUD hooks via ./swarm-versions.gen. useForkSwarmVersion + useSetDefaultSwarmVersion stay hand-written.

Hooks

useCreateSwarmVersion mutation

Create an ADDITIONAL version of an existing swarm. The initial v1 is created automatically by createSwarm — do NOT call this right after createSwarm. Use this only when you actually need a v2+, or use forkSwarmVersion to branch from a specific version.

TypeScript
useCreateSwarmVersion(options?: MutationOpts<SwarmVersion, CreateSwarmVersionParams>)

Types: SwarmVersion · CreateSwarmVersionParams

useDeleteSwarmVersion mutation

Soft-delete a swarm version.

TypeScript
useDeleteSwarmVersion(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useForkSwarmVersion composite

TypeScript
useForkSwarmVersion(options?: MutationOpts<SwarmVersion, ForkSwarmVersionParams>)

Types: SwarmVersion · ForkSwarmVersionParams

useListSwarmVersions query

List swarm versions.

TypeScript
useListSwarmVersions(params?: Omit<ListSwarmVersionsParams, | > & { filter?: SwarmVersionFilter; orderBy?: SwarmVersionOrderBy[]; } & SwarmVersionShorthands, options?: QueryOpts<Page<SwarmVersion>>)

Types: ListSwarmVersionsParams · SwarmVersionFilter · SwarmVersionOrderBy · SwarmVersionShorthands · Page · SwarmVersion

usePurgeSwarmVersion composite

Permanently delete a soft-deleted swarm version.

TypeScript
usePurgeSwarmVersion(options?: MutationOpts<SuccessResponse, PurgeSwarmVersionParams>)

Types: SuccessResponse · PurgeSwarmVersionParams

useRestoreSwarmVersion composite

Restore a soft-deleted swarm version.

TypeScript
useRestoreSwarmVersion(options?: MutationOpts<SwarmVersion, string>)

Types: SwarmVersion

useRetrieveSwarmVersion query

Get a swarm version by ID.

TypeScript
useRetrieveSwarmVersion(id: string, options?: QueryOpts<SwarmVersion>)

Types: SwarmVersion

useSetDefaultSwarmVersion composite

TypeScript
useSetDefaultSwarmVersion(options?: MutationOpts<Swarm, SetDefaultSwarmVersionParams>)

Types: Swarm · SetDefaultSwarmVersionParams

useUpdateSwarmVersion mutation

Update a swarm version.

TypeScript
useUpdateSwarmVersion(options?: MutationOpts<SwarmVersion, UpdateSwarmVersionParams>)

Types: SwarmVersion · UpdateSwarmVersionParams