README.md

[![Hex Version](http://img.shields.io/hexpm/v/fastimage.svg?style=flat-square)](https://hex.pm/packages/fastimage) [![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat-square)](https://hexdocs.pm/fastimage) [![License](https://img.shields.io/hexpm/l/fastimage.svg?style=flat-square)](https://github.com/stephenmoloney/fastimage/blob/master/LICENSE.md) [![Build Status](https://travis-ci.org/stephenmoloney/fastimage.svg)](https://travis-ci.org/stephenmoloney/fastimage) [![Code coverage status](https://coveralls.io/repos/github/stephenmoloney/fastimage/badge.svg?branch=master)](https://coveralls.io/github/stephenmoloney/fastimage?branch=master) 
![Hex.pm](https://img.shields.io/hexpm/dt/fastimage.svg)

# Fastimage  

## Description

Fastimage finds the dimensions/size or file type of a remote or local image file given the file path or url respectively.
It streams the smallest amount of data necessary to ascertain the file size. This aspect is useful when getting the
file size for very large images.

## Features

- Supports `bmp`, `jpeg`, `png`, `webp` and `gif` files
- Supports local files by using the file path of the image
- Supports blobs/objects by using the binary of the image
- Supports remote files by using the url of the image
- Follows redirects for a given url
- `Fastimage.info/1` yields the image info as a struct `%Fastimage{}`
- `Fastimage.size/1` yields the image size as a struct `%Fastimage.Dimensions{width: _w, height: _h}`
- `Fastimage.type/1` yields the image type as an atom `:bmp, :jpeg, :gif, :webp or :png`

## Examples

```elixir
Fastimage.info("https://raw.githubusercontent.com/stephenmoloney/fastimage/master/priv/test.jpg")
# => {:ok,
#      %Fastimage{
#        dimensions: %Fastimage.Dimensions{height: 142, width: 283},
#        image_type: :jpeg,
#        source: "https://raw.githubusercontent.com/stephenmoloney/fastimage/master/priv/test.jpg",
#        source_type: :url
#      }}

Fastimage.type("https://raw.githubusercontent.com/stephenmoloney/fastimage/master/priv/test.jpg")
# => {:ok, :jpeg}

Fastimage.size("https://raw.githubusercontent.com/stephenmoloney/fastimage/master/priv/test.jpg")
# => {:ok, %Fastimage.Dimensions{height: 142, width: 283}}
```

See [docs](https://hex.pm/packages/fastimage) for further examples

## Installation

Add fastimage to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:fastimage, "~> 1.0.0-rc4"}
  ]
end
```

## Tests

```elixir
mix test
```

## Benchmarks

```elixir
mix bench
```

## Credit/Acknowledgements

- Based on [Ruby Fastimage](https://github.com/sdsykes/fastimage) by [Stephen Sykes](https://github.com/sdsykes)
- Influenced by a [PHP version of fastimage](https://github.com/tommoor/fastimage) by [Tom Moor](https://github.com/tommoor)
- Thanks to all [contributors](https://github.com/stephenmoloney/fastimage/graphs/contributors)

## Licence

[MIT Licence](LICENCE.md)