jimp-dev / jimp-dev/jimp

Documentation issue: usage with TypeScript is wrong

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

Description

The "[TypeScript Usage](https://www.npmjs.com/package/jimp/v/0.16.13#typescript-usage)" section on NPM says that the package needs to be imported as default import:

```ts
import Jimp from "jimp";
```

Image

But it's incorrect. The correct import is a named import like this:

```ts
import { Jimp } from "jimp";
```

Your website docs is correct but the README on NPM is wrong.

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.