@ 碳化物/图像大小

快速,轻量级的节点JS包可以得到任何图像文件或缓冲的维度.

驾驶员: 碳键

经过对我们的属地进行彻底的安全审计后,我们决定将这个项目叉开(EgitHub 上的图像大小 财务报告和审定财务报表 在 Codeberg 上的图像大小解决若干弱点,并在此过程中优化图书馆。 有关变动的详细清单,请参见 完整更改日志。 。 。 .

我们首先要确保测试套房的密码覆盖率达到100%,然后才做出任何修改。 我们还比较了我们的结果和 业绩 测试从 锐口,一个被广泛使用,更通用的图书馆.

我们热烈地感谢这个图书馆的原始开发者所做的出色工作。 我们之所以维持这一分叉,只是因为我们需要执行一些紧急的纠正和改进措施;一旦原始项目纳入这些改正措施,我们将非常高兴地去掉这一分叉并返回主要存放处.

关键特性

• 零依赖关系
• 支持所有主要图像格式
• 处理文件和缓冲器
• 最小内存脚印 - 只读图像头
• 无害环境管理和共同JS支助
• 包含类型脚本
• 通过GitHub Actions CI在节点18、20、22、24和26试验

支持的格式

• 银行
• 工会
• 数据交换系统
• 全球投资框架
• 赫克(希弗,阿维克,阿维夫)
• 国际天主教儿童理事会
• 哈里发国
• J2C 战车
• JPEG-2000(联合P2)
• JPEG 组合
• JPEG-XL 常规
• KTX(1和2)
• 巴布亚新几内亚
• PNM( PAM, PBM, PFM, PGM, PPM) :
• 私营部门司
• 特别工作组
• 东京
• TIFF 时长
• 网络P

安装

npm install @carboneio/image-size
# or
yarn add @carboneio/image-size
# or
pnpm add @carboneio/image-size

使用量

在缓冲/ Uint8 箭头中通过

最适合流,网络请求,或者当您已有内存中的图像数据时.

import { imageSize } from '@carboneio/image-size'
// or
const { imageSize } = require('@carboneio/image-size')

const dimensions = imageSize(buffer)
console.log(dimensions.width, dimensions.height)

从文件中读取

最适合本地文件 。 返回一个承诺.

import { imageSizeFromFile } from '@carboneio/image-size/fromFile'
// or
const { imageSizeFromFile } = require('@carboneio/image-size/fromFile')

const dimensions = await imageSizeFromFile('photos/image.jpg')
console.log(dimensions.width, dimensions.height)

注意: 从文件读取的默认货币限额为 100个 要改变这个限制,你可以打电话 setConcurrency 像这样的函数 :

import { setConcurrency } from '@carboneio/image-size/fromFile'
// or
const { setConcurrency } = require('@carboneio/image-size/fromFile')
setConcurrency(123456)

从文件同步读取( 不推荐) QQ

此库的 v1. x 有同步 API, 内部使用同步文件读取 .

之所以不推荐,是因为这样会阻断节点.js主线程,从而降低性能,并阻止这个库同时被使用.

然而,如果您仍然需要同步使用此软件包,您可以将文件同步读取为缓冲器,然后将缓冲器传递到此库.

import { readFileSync } from 'node:fs'
import { imageSize } from '@carboneio/image-size'

const buffer = readFileSync('photos/image.jpg')
const dimensions = imageSize(buffer)
console.log(dimensions.width, dimensions.height)

3. 指挥线

对快速检查有用.

npx @carboneio/image-size image1.jpg image2.png

多尺寸

如果目标文件/缓冲器是HEIF、ICO或CUR文件,则 width 财务报告和审定财务报表 height 将是一个最大的图像.

额外 images 可用数组并返回所有可用图像的尺寸

import { imageSizeFromFile } from '@carboneio/image-size/fromFile'
// or
const { imageSizeFromFile } = require('@carboneio/image-size/fromFile')

const { images } = await imageSizeFromFile('images/multi-size.ico')
for (const dimensions of images) {
  console.log(dimensions.width, dimensions.height)
}

使用一个 URL

import url from 'node:url'
import http from 'node:http'
import { imageSize } from '@carboneio/image-size'

const imgUrl = 'http://my-amazing-website.com/image.jpeg'
const options = url.parse(imgUrl)

http.get(options, function (response) {
  const chunks = []
  response
    .on('data', function (chunk) {
      chunks.push(chunk)
    })
    .on('end', function () {
      const buffer = Buffer.concat(chunks)
      console.log(imageSize(buffer))
    })
})

禁用某些图像类型

import { disableTypes } from '@carboneio/image-size'
// or
const { disableTypes } = require('@carboneio/image-size')

disableTypes(['tiff', 'ico'])

JPEG 图像取向

如果在 JPEG EXIF 元数据中存在取向,则会被函数返回. 方向值为 1至8之间的数字 代表一种取向.

import { imageSizeFromFile } from '@carboneio/image-size/fromFile'
// or
const { imageSizeFromFile } = require('@carboneio/image-size/fromFile')

const { width, height, orientation } = await imageSizeFromFile('images/photo.jpeg')
console.log(width, height, orientation)

业绩

image-size 读取页眉; 锐口 解码 一个图像。 这使得他们很难在除了这个问题以外的任何事情上进行比较: 学习图像的维度需要多长时间? 他们给的一样 回答:跨越锐利自己的501个测试装置,两个库都同意 496,两者都识字.

以尖口0.35.4 / libvips 8.18.6为单位测量,在节点24上为macOS arm64.

从已经存在记忆中的缓冲器中,自行分析成本:

从文件路径,一个应用程序的实际支付,I/O包括:

第二张桌子是计划好的 阅读文件 主导成本, 因此缓冲器上的两个数量级缩小到1.3x到 9.2x之间 一旦I/O被计算在内. image-size 也没有本地二进制可安装, 也没有 启动成本,其中尖锐支付约50ms 在它的首次呼叫.

libvips 的缓存为这些数字禁用, 因为基准重读 同样的固定在循环中, 否则会测量纪念而不是 工作时 文件在两侧的OS页面缓存中是温暖的. 运行 npm run bench 所有30个格式的吞吐量.

限制

1. 部分文件读取

   • 只读图像头, 不读完整文件
   • 一些被破坏的图像可能还会报告维度

2. SVG 限制

   • 只支持像素尺寸和视图框
   • 不支持的百分比值

3. 文件访问

   • 从文件读取的默认货币限额为 100
   • 可用 setConcurrency()

4. 缓冲所需经费

   • 一些格式( 如 TIFF) 需要缓冲中的完整页眉
   • 流出部分缓冲可能不会对所有格式有效

发展

npm ci          # install dependencies from package-lock.json
npm test        # unit tests, with a 100% coverage threshold
npm run bench   # detection throughput, per format, on small and large files

npm run bench 接受 --filter=<substring> 确定单一格式的基准, 譬如说. npm run bench -- --filter=webp。 。 。 .

许可证

麻省理工学院

贷项

不是直接的港口,而是试图有类似的东西 dabble 的图像化 作为节点模块.

贡献者