---
title: "Swarm Edges hooks"
description: "Hand-written shim. Implementation is generated; see ./swarm-edges.gen."
section: "Libraries"
group: "React hooks"
order: 451
---

## Hooks

### `useAddSwarmEdge` `mutation`

Add a swarm edge.

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

**Types:** [SwarmEdge](/types/swarm-edge) · [AddSwarmEdgeParams](/types/add-swarm-edge-params)

### `useListSwarmEdges` `query`

List swarm edges for a swarm version.

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

**Types:** [ListSwarmEdgesParams](/types/list-swarm-edges-params) · [SwarmEdgeFilter](/types/swarm-edge-filter) · [SwarmEdgeOrderBy](/types/swarm-edge-order-by) · [SwarmEdgeShorthands](/types/swarm-edge-shorthands) · [SwarmEdge](/types/swarm-edge)

### `useRemoveSwarmEdge` `mutation`

Delete a swarm edge.

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

**Types:** [SuccessResponse](/types/success-response) · [DeleteSwarmEdgeParams](/types/delete-swarm-edge-params)

### `useRetrieveSwarmEdge` `query`

Get a swarm edge by ID.

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

**Types:** [SwarmEdge](/types/swarm-edge)