jimp-dev / jimp-dev/jimp

Documentation error: flip params are wrong

Open
#1,389 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
14.7k
Forks
777
PR merge metrics
No merged PRs in 30d

Description

# Expected Behavior

documentation should be correct

# Current Behavior

Correct:
image.flip({horizontal: true, vertical: false});

# Failure Information (for bugs)

documentation states:

cloned.flip(true, false);

which throws

## Steps to Reproduce

try as suggested in docs:

cloned.flip(true, false);

=> throw

cloned.flip({horizontal: true, vertical: false}); // works

- Jimp Version: 1.6
- Node version: 20

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.