aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 72667284d7b141926d407683dd1dd9392d3cd394 (plain) (blame)
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# holo-schedule

[![npm version](https://badge.fury.io/js/holo-schedule.svg)](https://badge.fury.io/js/holo-schedule)

> I love Haachama.

Hololive schedule crawler and parser.

## Install
```sh
yarn add holo-schedule

# or
npm install holo-schedule
```

## Usage

```ts
import parseScheduleHtml from 'holo-schedule'
// or:
// const parseScheduleHtml  = require('holo-schedule').default

import getScheduleHtml from 'holo-schedule/lib/getScheduleHtml'

// You can also get the html by yourself
const html = await getScheduleHtml()

// The dict stores steamers' icon data, you can save for using next time
const { lives, dict } = parseScheduleHtml(html)

console.log(lives)
```

Gets list like
```
[
  {
    time: 2020-07-31T11:02:00.000Z,
    streamer: 'アステル・レダ',
    guests: [ '鏡見キラ', '奏手イヅル' ],
    link: 'https://www.youtube.com/watch?v=WntgMec1Q6A',
    livePreviewImage: 'https://img.youtube.com/vi/WntgMec1Q6A/mqdefault.jpg'
  },
  {
    time: 2020-08-01T10:00:00.000Z,
    streamer: '赤井はあと',
    guests: [],
    link: 'https://www.youtube.com/watch?v=bYKeO_RKh6I',
    livePreviewImage: 'https://img.youtube.com/vi/bYKeO_RKh6I/mqdefault.jpg'
  },
  ...
]
```

For detail, see the TypeScript definition.

### Usage Example
- [Holo Data](https://github.com/holonow/holo-data)