is-apng   [![Latest GitHub release][release-image]][release-url] [![Latest NPM version][npm-image]][npm-url] [![Build Status][ci-image]][ci-url]

> Checks if a Buffer/Uint8Array contains a Animated PNG / APNG image.

> [!IMPORTANT]
> This is _only_ a quick detect method and does not do full (A)PNG file validation.

> For security and file integrity sensitive operations, use a true (A)PNG validator (see also specs).

Install

``
$ npm install is-apng
`

Usage

$3

`js
import { readFile } from 'node:fs/promises'
import isApng from 'is-apng'

const buffer = await readFile('image.png')

isApng(buffer)
// => true
`
_Note: As of version 1.2, Node versions below 18 are not supported._

$3

#### As package through NPM

`js
import isApng from 'is-apng'

const response = await fetch('image.png')
const buffer = await response.arrayBuffer()

isApng(new Uint8Array(buffer))
// => true
`

#### As old-school global script tag

Url for latest version: https://unpkg.com/is-apng

Url for specific version: https://unpkg.com/is-apng@1.2.0/dist/index.js

`html



`

#### As module

Url for latest version: https://unpkg.com/is-apng/dist/index.mjs

Url for specific version: https://unpkg.com/is-apng@1.2.0/dist/index.mjs

`html

`

or

`html



`

API

$3

Accepts a Buffer (Node.js) or Uint8Array. Returns a boolean of whether buffer` is a APNG image.

#### buffer

The buffer to check.

Based on

- is-png - Check if a Buffer/Uint8Array is a PNG image

by Sindre Sorhus

License

MIT © Philip van Heemstra

[release-url]: https://github.com/vHeemstra/is-apng/releases
[release-image]: https://img.shields.io/github/v/release/vHeemstra/is-apng?sort=semver&logo=github&logoColor=959DA5&labelColor=444D56

[npm-url]: https://www.npmjs.com/package/is-apng
[npm-image]: https://img.shields.io/npm/v/is-apng.svg?color=cb0000&labelColor=444D56&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSIjOTU5REE1IiBkPSJNMS43NjMgMEMuNzg2IDAgMCAuNzg2IDAgMS43NjN2MjAuNDc0QzAgMjMuMjE0Ljc4NiAyNCAxLjc2MyAyNGgyMC40NzRjLjk3NyAwIDEuNzYzLS43ODYgMS43NjMtMS43NjNWMS43NjNDMjQgLjc4NiAyMy4yMTQgMCAyMi4yMzcgMHpNNS4xMyA1LjMyM2wxMy44MzcuMDE5LS4wMDkgMTMuODM2aC0zLjQ2NGwuMDEtMTAuMzgyaC0zLjQ1NkwxMi4wNCAxOS4xN0g1LjExM3oiPjwvcGF0aD48L3N2Zz4=

[ci-url]: https://github.com/vHeemstra/is-apng/actions/workflows/publish_on_release.yml
[ci-image]: https://img.shields.io/github/actions/workflow/status/vHeemstra/is-apng/publish_on_release.yml?label=lint%20%26%20test&logo=github&logoColor=959DA5&labelColor=444D56

[coverage-url]: https://coveralls.io/github/vHeemstra/is-apng?branch=main
[coverage-image]: https://img.shields.io/coveralls/github/vHeemstra/is-apng?logo=coveralls&logoColor=959DA5&labelColor=444D56
[coverage-image_]: https://coveralls.io/repos/github/vHeemstra/is-apng/badge.svg?branch=main

[coverage-url2]: https://codecov.io/gh/vHeemstra/is-apng
[coverage-image2]: https://codecov.io/gh/vHeemstra/is-apng/branch/main/graph/badge.svg?token=sZaKGStMXg

[deps-url]: https://libraries.io/npm/is-apng
[deps-image]: https://img.shields.io/librariesio/release/npm/is-apng?logo=libraries.io&logoColor=959DA5&labelColor=444D56
[deps-image2]: https://img.shields.io/librariesio/github/vHeemstra/is-apng?logo=libraries.io&logoColor=959DA5&labelColor=444D56

[downloads-image]: https://img.shields.io/npm/dm/is-apng.svg?labelColor=444D56&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSIjOTU5REE1IiBkPSJNMS43NjMgMEMuNzg2IDAgMCAuNzg2IDAgMS43NjN2MjAuNDc0QzAgMjMuMjE0Ljc4NiAyNCAxLjc2MyAyNGgyMC40NzRjLjk3NyAwIDEuNzYzLS43ODYgMS43NjMtMS43NjNWMS43NjNDMjQgLjc4NiAyMy4yMTQgMCAyMi4yMzcgMHpNNS4xMyA1LjMyM2wxMy44MzcuMDE5LS4wMDkgMTMuODM2aC0zLjQ2NGwuMDEtMTAuMzgyaC0zLjQ1NkwxMi4wNCAxOS4xN0g1LjExM3oiPjwvcGF0aD48L3N2Zz4=