---
title: "Images hooks"
description: "Hand-written shim. Generated CRUD via ./images.gen.
useGetImageByFile stays hand-written."
section: "Libraries"
group: "React hooks"
order: 428
---

## Hooks

### `useDeleteImage` `mutation`

Delete the image projection (the underlying file is unaffected).

```ts
useDeleteImage(options?: MutationOpts<SuccessResponse, string>)
```

**Types:** [SuccessResponse](/types/success-response)

### `useGetImageByFile` `query`

```ts
useGetImageByFile(fileId: string, options?: QueryOpts<Image>)
```

**Types:** [Image](/types/image)

### `useListImages` `query`

List images.

```ts
useListImages(params?: ListImagesParams, options?: QueryOpts<Page<Image>>)
```

**Types:** [ListImagesParams](/types/list-images-params) · [Page](/types/page) · [Image](/types/image)

### `useRetrieveImage` `query`

Get an image by ID.

```ts
useRetrieveImage(id: string, options?: QueryOpts<Image>)
```

**Types:** [Image](/types/image)