loneaggie / fastimage

Find the file size or file type of an image given the file path or uri respectively in elixir.

Fastimage

Description

Fastimage finds the dimensions/size or file type of a remote or local image file given the file path or uri 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 and gif files
• Supports remote files by using the uri of the image
• Follows up to three redirects for a given uri
• Supports local files by using the file path of the image
• Yields the file size as a map %{width: _w, height: _h}
• Yields the file type as a string "bmp", "jpeg", "gif" or "png"

Examples

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

Installation

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

def deps do
  [{:fastimage, "~> 0.0.7"}]
end

Ensure fastimage is started before your application:

def application do
  [applications: [:fastimage]]
end

Tests

mix test

Credit/Acknowledgements

• Based on Ruby Fastimage by Stephen Sykes
• Influenced by a PHP version of fastimage by Tom Moor

Licence

MIT Licence