Images hooks

Hand-written shim. Generated CRUD via ./images.gen. useGetImageByFile stays hand-written.

Hooks

useDeleteImage mutation

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

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

Types: SuccessResponse

useGetImageByFile query

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

Types: Image

useListImages query

List images.

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

Types: ListImagesParams · Page · Image

useRetrieveImage query

Get an image by ID.

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

Types: Image