AeontelAeontel Docs

Swarm Nodes hooks

Hand-written shim. Implementation is generated; see ./swarm-nodes.gen.

Hooks

useAddSwarmNode mutation

Add a swarm node.

TypeScript
useAddSwarmNode(options?: MutationOpts<SwarmNode, AddSwarmNodeParams>)

Types: SwarmNode · AddSwarmNodeParams

useListSwarmNodes query

List swarm nodes for a swarm version.

TypeScript
useListSwarmNodes(params?: Omit<ListSwarmNodesParams, | > & { filter?: SwarmNodeFilter; orderBy?: SwarmNodeOrderBy[]; } & SwarmNodeShorthands, options?: QueryOpts<SwarmNode[]>)

Types: ListSwarmNodesParams · SwarmNodeFilter · SwarmNodeOrderBy · SwarmNodeShorthands · SwarmNode

useRemoveSwarmNode mutation

Delete a swarm node.

TypeScript
useRemoveSwarmNode(options?: MutationOpts<SuccessResponse, DeleteSwarmNodeParams>)

Types: SuccessResponse · DeleteSwarmNodeParams

useRetrieveSwarmNode query

Get a swarm node by ID.

TypeScript
useRetrieveSwarmNode(id: string, options?: QueryOpts<SwarmNode>)

Types: SwarmNode