1.0.6 • Published 2 years ago
wiki-img v1.0.6
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
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
Interface: Page
Properties
description
• description: string
Defined in
excerpt
• excerpt: string
Defined in
id
• id: number
Defined in
key
• key: string
Defined in
thumbnail
• Optional
thumbnail: Thumbnail
Defined in
title
• title: string
Defined in
Interface: Thumbnail
Properties
duration
• duration: number
Defined in
height
• height: number
Defined in
mimetype
• mimetype: string
Defined in
size
• size: number
Defined in
url
• url: string
Defined in
width
• width: number