https://github.com/fdesjardins/wikiquote
Promise-based interface for Wikiquote (https://en.wikiquote.org/wiki/Main_Page)
https://github.com/fdesjardins/wikiquote
excerpts fortunes proverbs quotes sayings wikiquote
Last synced: about 2 months ago
JSON representation
Promise-based interface for Wikiquote (https://en.wikiquote.org/wiki/Main_Page)
- Host: GitHub
- URL: https://github.com/fdesjardins/wikiquote
- Owner: fdesjardins
- Created: 2017-03-24T07:54:10.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:14:05.000Z (over 2 years ago)
- Last Synced: 2024-04-14T22:12:50.204Z (about 1 year ago)
- Topics: excerpts, fortunes, proverbs, quotes, sayings, wikiquote
- Language: JavaScript
- Homepage:
- Size: 473 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Wikiquote
[![Build Status][travis-image]][travis-url]
[![NPM Version][npm-image]][npm-url]
[![Coverage][coveralls-image]][coveralls-url]
Some handy methods for Wikiquote
## Installation
```sh
npm install --save wikiquote
```
### Usage
```js
wikiquote
.searchPeople('steve jobs')
.then(page => wikiquote.getRandomQuote(page.title))
.then(quote => console.log(quote))
```
```
You always have to keep pushing to innovate. Dylan could have
sung protest songs forever and probably made a lot of money,
but he didn’t. He had to move on, and when he did, by going
electric in 1965, he alienated a lot of people. His 1966 Europe
tour was his greatest…. The Beatles were the same way. They kept
evolving, moving, refining their art. That’s what I’ve always
tried to do — keep moving. Otherwise, as Dylan says, if you are
not busy being born, you’re busy dying.
As quoted in Steve Jobs (2011) by Walter Isaacson, p. 570
```
## API
### `search(query, options)`
#### `query`
The search terms used to query wikiquote
Type: `string`
Examples:
- Person Name
- Book Title
- Movie Title
### `searchByTitle(query, options)`
#### `query`
The search terms used to query page titles
Type: `string`
### `searchPeople(query, options)`
#### `query`
The search terms used to query people
Type: `string`
### `getPageSections(pageTitle, options)`
#### `pageTitle`
The title of the wikiquote page
Type: `string`
### `getSectionContent(pageTitle, sectionIndex, options)`
#### `pageTitle`
The title of the wikiquote page
Type: `string`
### `getRandomQuote(pageTitle, options)`
#### `pageTitle`
The title of the wikiquote page
Type: `string`
### `list(pageTitle, options)`
List all the quotes on a given page
Type: `string`
## `options`
You can also provide a set of options to each method to customize the query and results.
Type: `object`
Example:
```js
{
language: 'en'
}
```
### `options.language`
The language code to search with
Type: `string`
For a list of available language codes see https://meta.wikimedia.org/wiki/Wikiquote#List_of_Wikiquotes
## License
MIT © [Forrest Desjardins](https://github.com/fdesjardins)
[npm-url]: https://www.npmjs.com/package/wikiquote
[npm-image]: https://img.shields.io/npm/v/wikiquote.svg?style=flat
[travis-url]: https://travis-ci.org/fdesjardins/wikiquote
[travis-image]: https://img.shields.io/travis/fdesjardins/wikiquote.svg?style=flat
[coveralls-url]: https://coveralls.io/r/fdesjardins/wikiquote
[coveralls-image]: https://img.shields.io/coveralls/fdesjardins/wikiquote.svg?style=flat