Turn images into speechbubbled images!
src | ||
.gitignore | ||
eslint.config.json | ||
eslint.config.mjs | ||
package.json | ||
pnpm-lock.yaml | ||
README.md | ||
tsconfig.json |
Image Speech Bubble Transformer
A TypeScript library for applying speech bubble effects to images with various transformation options.
Installation
npm install image-speech-bubble-transformer
Usage
import {
createSpeechBubbleTransformer,
Orientation,
} from "image-speech-bubble-transformer";
import fs from "fs/promises";
async function example() {
// Create transformer instance
const transformer = createSpeechBubbleTransformer();
// Read image buffer
const inputBuffer = await fs.readFile("input.png");
// Process image with options
const processedBuffer = await transformer.processSpeechBubble(inputBuffer, {
mirror: true,
orientation: Orientation.LEFT,
});
// Save processed image
await transformer.processAndSave(inputBuffer, "output.png", {
mirror: true,
orientation: Orientation.LEFT,
});
}
API
createSpeechBubbleTransformer(assetsDir?: string)
- Creates a transformer instance
assetsDir
: Optional path to custom assets directory
processSpeechBubble(inputBuffer, options)
- Applies speech bubble effect to image
- Options:
mirror
: Flip horizontallyorientation
: Rotate speech bubblespeechBubblePath
: Custom speech bubble image
processAndSave(inputBuffer, outputPath, options)
- Processes and saves image in one step
Supported Formats
- .png, .jpg, .jpeg, .gif, .bmp, .webp, .tiff