Wiki-img

Easily download wikipedia images in NodeJS

Installation

pnpm install wiki-img

yarn add wiki-img

npm install wiki-img

Install globally

pnpm install -g wiki-img

CLI Usage

npx wiki-img zuckerberg --log

Outputs

{
  "id": 2844938,
  "key": "Mark_Zuckerberg",
  "title": "Mark Zuckerberg",
  "excerpt": "Zuckerberg",
  "matched_title": "Zuckerberg",
  "description": "American internet entrepreneur and founder of Facebook",
  "thumbnail": {
    "mimetype": "image/jpeg",
    "size": null,
    "width": 161,
    "height": 200,
    "duration": null,
    "url": "//upload.wikimedia.org/wikipedia/commons/thumb/1/18/Mark_Zuckerberg_F8_2019_Keynote_%2832830578717%29_%28cropped%29.jpg/161px-Mark_Zuckerberg_F8_2019_Keynote_%2832830578717%29_%28cropped%29.jpg"
  }
}

Without --log you won't see any output in the terminal, the image will be saved to your current directory

How to use?

Interfaces

• Page
• Thumbnail

Functions

getWikiImg

▸ getWikiImg(query, dir?): Promise<Error | Page>

Query and download image from wikipedia

Example

// get lady gaga image in celebs directory
 getWikiImg("Lady gaga", "./celebs")
   .then((res) => console.log(res))
   .catch((err) => console.log("failed to get img", err));

Parameters

Name	Type	Default value	Description
query	string	undefined	Search term for wikipedia
dir	string	"./"	Relative path of image to be saved

Returns

Promise<Error | Page>

Promise with info about the search

Defined in

index.ts:87

Interface: Page

Properties

description

• description: string

Defined in

index.ts:19

---

excerpt

• excerpt: string

Defined in

index.ts:18

---

id

• id: number

Defined in

index.ts:15

---

key

• key: string

Defined in

index.ts:16

---

thumbnail

• Optional thumbnail: Thumbnail

Defined in

index.ts:20

---

title

• title: string

Defined in

index.ts:17

Interface: Thumbnail

Properties

duration

• duration: number

Defined in

index.ts:10

---

height

• height: number

Defined in

index.ts:9

---

mimetype

• mimetype: string

Defined in

index.ts:6

---

size

• size: number

Defined in

index.ts:7

---

url

• url: string

Defined in

index.ts:11

---

width

• width: number

Defined in

index.ts:8