# @roberto0arruda/wikipedia-api

> a Wikipedia Api Wrapper with Node

Latest version **1.0.0** (published 2023-03-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @roberto0arruda/wikipedia-api
pnpm add @roberto0arruda/wikipedia-api
yarn add @roberto0arruda/wikipedia-api
bun add @roberto0arruda/wikipedia-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-03-23 |
| First published | 2023-03-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mayk Brito |
| Maintainers | roberto0arruda |

## Links

- npm: https://www.npmjs.com/package/@roberto0arruda/wikipedia-api
- Repository: https://github.com/roberto0arruda/wikipedia-api
- Homepage: https://github.com/roberto0arruda/wikipedia-api#readme
- Issues: https://github.com/roberto0arruda/wikipedia-api/issues
- npm.io page: https://npm.io/package/@roberto0arruda/wikipedia-api

## Dependencies (3)

- [unidecode](https://npm.io/package/unidecode.md) ^0.1.8
- [superagent](https://npm.io/package/superagent.md) ^4.1.0
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.9

## Recent versions

- 1.0.0 (latest) — 2023-03-23

## README

# A Node.js Bot that search for content with Wikipedia's Api

This bot will prompt you asking for a keyword, then it will search and fetch content from Wikipedia.

---

## How to start

1. Clone this repository, navigate do repo folder and Install it.

```sh
git clone https://github.com/maykbrito/wikipedia-api-node.git && cd wikipedia-api-node && npm install
```

2. Once it is installed, run with

```sh
npm run start
```

You will see an interactive prompt to help you search your content.

![Imgur](https://i.imgur.com/leSq4aT.gif)

---

## Language & Translations

By default language for search in Wikipedia is Portuguese. You can change it by opening `./language.json` and change `"lang":"pt"` to your own language.

**Note: If it's not English you will need to provide your own translation.**

For example: If your language is French,
Just copy this snippet bellow, and start your translation.

```json
"fr": {
    "askForSearchTerm": "Type your search term",
    "confirmOrSelectSearchTerm": "Confirm Your Term Search or Select One",
    "fetchingImages": "Fetching Images",
    "fetchingContent": "Fetching Content",
    "errorWaitingWikipediaContent": "Error waiting for content",
    "errorFetchingImage": "Could Not Fetch Image Url From Wikipedia",
    "errorFetchingContent": "Could Not Fetch Content From Wikipedia",
    "errorFetchingTerms": "Could Not Fetch Terms From Wikipedia",
    "exitWithDefault": "Exiting Program",
    "exitWithEmptyResults": "Your search term don't return any result",
    "exitWithKeyNotSelected": "You don't selected any key"
}
```

And change bot to your language 

```json
"lang":"fr"
```

If you want to, just change the language like above and Wikipedia will search in that language

FYI:

- In case of you don't provide any translation, this bot will be prompted in English

- To select a language follow this pattern* <http://www.lingoes.net/en/translator/langcode.htm>

- Wikipedia Api don't work with all avaiable languages

---

## How to use it in your project (without my interactive prompt)

You will need to clone and install it in your project folder.

Initiate it

```js
const wikipedia = require('./wikipedia');
``` 

Your `wikipedia` will require this object

```js
content = {
    searchTerm = "Your Search Term here"
}
```

Then you can await for search

```js
await wikipedia(content);
```

Your `content` object will return like this:

```js
content = {
    searchTerm = "",
    wikipediaContent = {
        pageid: '',
        title: '',
        url: '',
        raw: '',
        summary: '',
        references: [],
        images: [],
    }
}
```

*I still don't know how to make a npm package to helping us. (if you want to, we all will be thankful)*

## License & copyright

It's free (MIT license) © Mayk Brito

---
_Source: https://npm.io/package/@roberto0arruda/wikipedia-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._