UNPKG

wiki-img

Version:

Easily search & download wikipedia images (Zero dependency lib)

41 lines (25 loc) • 904 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# How to use? ## Interfaces - [Page](interfaces/Page.md) - [Thumbnail](interfaces/Thumbnail.md) ## Functions ### getWikiImg ▸ **getWikiImg**(`query`, `dir?`): `Promise`<`Error` \| [`Page`](interfaces/Page.md)\> Query and download image from wikipedia **`Example`** ```ts // 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`](interfaces/Page.md)\> Promise with info about the search #### Defined in [index.ts:87](https://github.com/ShivamJoker/Wiki-Img/blob/3d15d17/src/index.ts#L87)