ユーティリティ API
Sharp は画像処理と形式変換を支援するためのさまざまなユーティリティ関数を提供します。
形式検出
サポートされている形式の検出
javascript
import sharp from 'sharp';
// サポートされている入力形式を取得
console.log('サポートされている入力形式:', sharp.format);
// サポートされている出力形式を取得
console.log('サポートされている出力形式:', sharp.format);ファイル形式のチェック
javascript
async function checkImageFormat(filePath) {
try {
const metadata = await sharp(filePath).metadata();
return {
format: metadata.format,
width: metadata.width,
height: metadata.height,
channels: metadata.channels
};
} catch (error) {
return { error: error.message };
}
}カラースペース
カラースペース定数
javascript
// 利用可能なカラースペース
sharp.colourspace.srgb // sRGB
sharp.colourspace.rgb // RGB
sharp.colourspace.cmyk // CMYK
sharp.colourspace.grey // グレースケール
sharp.colourspace.multiband // マルチバンド
sharp.colourspace.lab // Lab
sharp.colourspace.xyz // XYZ
sharp.colourspace.ycbcr // YCbCrカラースペース変換
javascript
// グレースケールに変換
sharp('input.jpg')
.grayscale()
.toFile('output.jpg');
// CMYK に変換
sharp('input.jpg')
.toColourspace(sharp.colourspace.cmyk)
.tiff()
.toFile('output.tiff');カーネルとフィルタ
リサイズカーネル
javascript
// 利用可能なリサイズカーネル
sharp.kernel.nearest // 最近傍
sharp.kernel.cubic // 三次補間
sharp.kernel.mitchell // Mitchell-Netravali
sharp.kernel.lanczos2 // Lanczos 2-lobed
sharp.kernel.lanczos3 // Lanczos 3-lobed (デフォルト)カスタムカーネルの使用
javascript
// カスタムリサイズカーネルを使用
sharp('input.jpg')
.resize(300, 200, { kernel: sharp.kernel.lanczos3 })
.toFile('output.jpg');位置定数
位置オプション
javascript
// 利用可能な位置オプション
sharp.position.top // 上部
sharp.position.right // 右側
sharp.position.bottom // 下部
sharp.position.left // 左側
sharp.position.center // 中央 (デフォルト)
sharp.position.centre // 中央 (イギリス式スペル)
sharp.position.north // 北 (上部)
sharp.position.east // 東 (右側)
sharp.position.south // 南 (下部)
sharp.position.west // 西 (左側)
sharp.position.northeast // 北東
sharp.position.southeast // 南東
sharp.position.southwest // 南西
sharp.position.northwest // 北西チャンネル操作
チャンネル定数
javascript
// チャンネル定数
sharp.channel.red // 赤チャンネル
sharp.channel.green // 緑チャンネル
sharp.channel.blue // 青チャンネル
sharp.channel.alpha // 透明度チャンネル
sharp.channel.grey // グレーチャンネルチャンネル操作
javascript
// 赤チャンネルを抽出
sharp('input.jpg')
.extractChannel(sharp.channel.red)
.toFile('red-channel.jpg');
// すべてのチャンネルを抽出
const channels = await sharp('input.jpg').separate();エラー処理
エラータイプ
javascript
// 一般的な Sharp エラー
sharp.errors.InputError // 入力エラー
sharp.errors.ProcessError // 処理エラー
sharp.errors.OutputError // 出力エラーエラー処理の例
javascript
try {
await sharp('input.jpg')
.resize(300, 200)
.toFile('output.jpg');
} catch (error) {
if (error instanceof sharp.errors.InputError) {
console.error('入力ファイルエラー:', error.message);
} else if (error instanceof sharp.errors.ProcessError) {
console.error('処理エラー:', error.message);
} else if (error instanceof sharp.errors.OutputError) {
console.error('出力エラー:', error.message);
} else {
console.error('未知のエラー:', error.message);
}
}パフォーマンス監視
メモリ使用
javascript
// Sharp のメモリ使用状況を取得
const stats = sharp.cache();
console.log('キャッシュ統計:', stats);
// キャッシュをクリア
sharp.cache(false);並行制御
javascript
// 並行制限を設定
sharp.concurrency(4); // 最大4つの並行操作
// 現在の並行数を取得
console.log('現在の並行数:', sharp.concurrency());ツール関数
テスト画像の作成
javascript
// 単色画像を作成
const redImage = sharp({
create: {
width: 300,
height: 200,
channels: 3,
background: { r: 255, g: 0, b: 0 }
}
});
// グラデーション画像を作成
const gradient = sharp({
create: {
width: 300,
height: 200,
channels: 3,
background: { r: 0, g: 0, b: 0 }
}
});画像合成
javascript
// 複数の画像を合成
const composite = await sharp('background.jpg')
.composite([
{
input: 'overlay.png',
top: 100,
left: 100
}
])
.jpeg()
.toBuffer();バッチ処理ツール
バッチリサイズ
javascript
const fs = require('fs').promises;
async function batchResize(inputDir, outputDir, width, height) {
const files = await fs.readdir(inputDir);
for (const file of files) {
if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
try {
await sharp(`${inputDir}/${file}`)
.resize(width, height)
.jpeg({ quality: 80 })
.toFile(`${outputDir}/${file}`);
console.log(`処理完了: ${file}`);
} catch (error) {
console.error(`${file} の処理失敗:`, error.message);
}
}
}
}バッチ形式変換
javascript
async function batchConvert(inputDir, outputDir, format) {
const files = await fs.readdir(inputDir);
for (const file of files) {
if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
const outputFile = file.replace(/\.[^.]+$/, `.${format}`);
try {
const image = sharp(`${inputDir}/${file}`);
switch (format) {
case 'jpg':
case 'jpeg':
await image.jpeg({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
break;
case 'png':
await image.png().toFile(`${outputDir}/${outputFile}`);
break;
case 'webp':
await image.webp({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
break;
case 'avif':
await image.avif({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
break;
}
console.log(`変換完了: ${file} -> ${outputFile}`);
} catch (error) {
console.error(`${file} の変換失敗:`, error.message);
}
}
}
}検証ツール
画像の整合性を検証
javascript
async function validateImage(filePath) {
try {
const metadata = await sharp(filePath).metadata();
// 基本属性をチェック
if (!metadata.width || !metadata.height) {
return { valid: false, error: 'サイズ情報が不足しています' };
}
if (metadata.width <= 0 || metadata.height <= 0) {
return { valid: false, error: '無効なサイズ' };
}
if (!metadata.format) {
return { valid: false, error: '形式情報が不足しています' };
}
// 画像処理を試行
await sharp(filePath).resize(1, 1).toBuffer();
return { valid: true, metadata };
} catch (error) {
return { valid: false, error: error.message };
}
}ファイルサイズのチェック
javascript
const fs = require('fs');
function checkFileSize(filePath, maxSize = 10 * 1024 * 1024) { // 10MB
const stats = fs.statSync(filePath);
const sizeInMB = stats.size / (1024 * 1024);
return {
size: stats.size,
sizeInMB,
isValid: stats.size <= maxSize,
maxSizeInMB: maxSize / (1024 * 1024)
};
}