# image_pipe_url v0.5.0 - Table of Contents

> Builds and signs ImagePipe image URLs without the image processing runtime.

## Pages

- [ImagePipe URL](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- URL builder
  - [ImagePipe.URL](ImagePipe.URL.md): Builds processing plans and generates signed ImagePipe URLs.
  - [ImagePipe.URL.Config](ImagePipe.URL.Config.md): URL settings shared by a builder and the server that serves its URLs.
  - [ImagePipe.URL.Helpers](ImagePipe.URL.Helpers.md): An `image_url/2` macro that builds image URLs in templates and checks their
options at compile time.

- Plan model
  - [ImagePipe.Plan](ImagePipe.Plan.md): An immutable processing plan built through the `ImagePipe` builder API.
  - [ImagePipe.Plan.Spec.Issue](ImagePipe.Plan.Spec.Issue.md): A problem with a plan's options or source, returned by
`ImagePipe.URL.validate/1`, `ImagePipe.URL.url/3`, and
`ImagePipe.URL.url_with_issues/3`, and by
`ImagePipe.validate/2` and `ImagePipe.run/4` in `image_pipe`.

- Sources
  - [ImagePipe.Plan.Source](ImagePipe.Plan.Source.md): Normalizes source strings the same way for the URL builder and the server.

- Encoder options
  - [ImagePipe.Plan.Output.AvifOptions](ImagePipe.Plan.Output.AvifOptions.md): AVIF encoder options, set with `avif_options:` in `ImagePipe.URL.output/2`
or [`avif-options`](https://hexdocs.pm/image_pipe/output.html#avif-options)
in a URL. A field left `nil` keeps the encoder's default.

  - [ImagePipe.Plan.Output.JpegOptions](ImagePipe.Plan.Output.JpegOptions.md): JPEG encoder options, set with `jpeg_options:` in `ImagePipe.URL.output/2`
or [`jpeg-options`](https://hexdocs.pm/image_pipe/output.html#jpeg-options)
in a URL. A field left `nil` keeps the encoder's default.

  - [ImagePipe.Plan.Output.PngOptions](ImagePipe.Plan.Output.PngOptions.md): PNG encoder options, set with `png_options:` in `ImagePipe.URL.output/2`
or [`png-options`](https://hexdocs.pm/image_pipe/output.html#png-options)
in a URL. A field left `nil` keeps the encoder's default.

  - [ImagePipe.Plan.Output.WebpOptions](ImagePipe.Plan.Output.WebpOptions.md): WebP encoder options, set with `webp_options:` in `ImagePipe.URL.output/2`
or [`webp-options`](https://hexdocs.pm/image_pipe/output.html#webp-options)
in a URL. A field left `nil` keeps the encoder's default.