npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@jcayzac/image-information

v1.1.1

Published

Pure Javascript, lightweight local or remote image information detection

Downloads

44

Readme

@jcayzac/image-information

Lightweight detection of local or remote images' type, orientation & size in pure Javascript.

license npm version npm downloads bundle

This module detect informations about local or remote images. For remote images, it streams the data only until it finds information.

Images in the following formats are supported: GIF, HEIC, HEIF, AVIF, J2C, JP2, JPEG, PNG, SVG & WebP.

Usage

# pnpm
pnpm add @jcayzac/image-information

# bun
bunx add @jcayzac/image-information

# npm
npx add @jcayzac/image-information

# yarn
yarn add @jcayzac/image-information

# deno
deno add npm:@jcayzac/image-information

Getting information about an image from a URL

import { imageInformation } from '@jcayzac/image-information'

// Remote URL
const info = await imageInformation('https://example.com/image.jpg')
if (info !== undefined) {
  const {
    // intrinsic width.
    width,

    // intrinsic height.
    height,

    // inferred file extension (doesn't care about URL).
    extension,

    // inferred MIME type.
    type,

    // detected EXIF orientation, if any.
    orientation,
  } = info

  console.log(`Found information:`, info)
}

// File URL
const info2 = await imageInformation('file:///tmp/image.jpg')

[!NOTE]

The function accepts strings as a convenience, but those are expected to represent valid URLs. For local images, you must use the file:// URL scheme. Passing paths directly will not work.

Getting information about an image from a buffer

The probe() function can be used to get information about an image from a buffer (either an Uint8Array or a node Buffer).

import { readFile } from 'node:fs/promises'
import { probe } from '@jcayzac/image-information'

const buffer = await readFile('image.jpg')
const info = await probe(buffer)

Like it? Buy me a coffee!

If you like anything here, consider buying me a coffee using one of the following platforms:

GitHub Sponsors Revolut Wise Ko-Fi PayPal