AeontelAeontel Docs

Swarm Edges hooks

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

Hooks

useAddSwarmEdge mutation

Add a swarm edge.

TypeScript
useAddSwarmEdge(options?: MutationOpts<SwarmEdge, AddSwarmEdgeParams>)

Types: SwarmEdge · AddSwarmEdgeParams

useListSwarmEdges query

List swarm edges for a swarm version.

TypeScript
useListSwarmEdges(params?: Omit<ListSwarmEdgesParams, | > & { filter?: SwarmEdgeFilter; orderBy?: SwarmEdgeOrderBy[]; } & SwarmEdgeShorthands, options?: QueryOpts<SwarmEdge[]>)

Types: ListSwarmEdgesParams · SwarmEdgeFilter · SwarmEdgeOrderBy · SwarmEdgeShorthands · SwarmEdge

useRemoveSwarmEdge mutation

Delete a swarm edge.

TypeScript
useRemoveSwarmEdge(options?: MutationOpts<SuccessResponse, DeleteSwarmEdgeParams>)

Types: SuccessResponse · DeleteSwarmEdgeParams

useRetrieveSwarmEdge query

Get a swarm edge by ID.

TypeScript
useRetrieveSwarmEdge(id: string, options?: QueryOpts<SwarmEdge>)

Types: SwarmEdge