| 1 | # haikuist [](https://travis-ci.com/vladimyr/haikuist) [](https://packagephobia.now.sh/result?p=haikuist) [](https://npm.im/haikuist) [](https://github.com/vladimyr/haikuist/blob/master/LICENSE) [](https://github.com/Flet/semistandard)
|
| 2 |
|
| 3 | > Fetch haikus from <https://haiku.ist> from your terminal
|
| 4 |
|
| 5 | ## Installation
|
| 6 |
|
| 7 | $ npm install -g haikuist
|
| 8 |
|
| 9 | Or for a one-time run:
|
| 10 |
|
| 11 | $ npx haikuist
|
| 12 |
|
| 13 | ## Usage
|
| 14 |
|
| 15 | $ haikuist --help
|
| 16 |
|
| 17 | haikuist v1.0.0
|
| 18 |
|
| 19 | Usage:
|
| 20 | $ haikuist [command]
|
| 21 | $ haikuist latest Fetch latest haiku
|
| 22 | $ haikuist about Display contents of about page
|
| 23 |
|
| 24 | Options:
|
| 25 | --info Display https://haiku.ist/about page [boolean]
|
| 26 | -h, --help Show help [boolean]
|
| 27 | -v, --version Show version number [boolean]
|
| 28 |
|
| 29 | Homepage: https://github.com/vladimyr/haikuist
|
| 30 | Report issue: https://github.com/vladimyr/haikuist/issues
|
| 31 |
|
| 32 | ## API
|
| 33 |
|
| 34 |
|
| 35 |
|
| 36 | #### Table of Contents
|
| 37 |
|
| 38 | - [about](#about)
|
| 39 | - [count](#count)
|
| 40 | - [fetchPosts](#fetchposts)
|
| 41 | - [Parameters](#parameters)
|
| 42 | - [fetchLatest](#fetchlatest)
|
| 43 | - [fetchRandom](#fetchrandom)
|
| 44 | - [Page](#page)
|
| 45 | - [Post](#post)
|
| 46 | - [Response](#response)
|
| 47 |
|
| 48 | ### about
|
| 49 |
|
| 50 | Retrieve contents of [haiku.ist/about](https://haiku.ist/about/) page.
|
| 51 |
|
| 52 | Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Page](#page)>** About page.
|
| 53 |
|
| 54 | ### count
|
| 55 |
|
| 56 | Get total number of haikus.
|
| 57 |
|
| 58 | Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>** Total number of haikus available.
|
| 59 |
|
| 60 | ### fetchPosts
|
| 61 |
|
| 62 | Retrieve multiple haikus from [haiku.ist](https://haiku.ist) archive.
|
| 63 |
|
| 64 | #### Parameters
|
| 65 |
|
| 66 | - `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** WordPress REST API `/posts` endpoint
|
| 67 | [arguments](https://developer.wordpress.org/rest-api/reference/posts/#arguments).
|
| 68 | - `options.pageSize` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of items to be returned in result set. (optional, default `10`)
|
| 69 |
|
| 70 | Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Response](#response)<[Post](#post)>>** Paginated listing of haiku posts.
|
| 71 |
|
| 72 | ### fetchLatest
|
| 73 |
|
| 74 | Fetch latest haiku.
|
| 75 |
|
| 76 | Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Post](#post)>** Latest post containing haiku.
|
| 77 |
|
| 78 | ### fetchRandom
|
| 79 |
|
| 80 | Fetch random haiku from [haiku.ist](https://haiku.ist) archive.
|
| 81 |
|
| 82 | Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Post](#post)>** Random post containing haiku.
|
| 83 |
|
| 84 | ### Page
|
| 85 |
|
| 86 | - **See: <https://www.npmjs.com/package/wp-api-client#page>**
|
| 87 |
|
| 88 | WordPress API client `Page` response type.
|
| 89 |
|
| 90 | Type: WordPressClient.Page
|
| 91 |
|
| 92 | ### Post
|
| 93 |
|
| 94 | - **See: <https://www.npmjs.com/package/wp-api-client#post>**
|
| 95 |
|
| 96 | WordPress API client `Post` response type.
|
| 97 |
|
| 98 | Type: WordPressClient.Post
|
| 99 |
|
| 100 | ### Response
|
| 101 |
|
| 102 | - **See: <https://www.npmjs.com/package/wp-api-client#response>**
|
| 103 |
|
| 104 | WordPress API client response type used for paginated responses.
|
| 105 |
|
| 106 | Type: WordPressClient.Response<T>
|