wyzie-lib 2.0.4 → 2.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Wyzie Lib
|
|
2
2
|
|
|
3
3
|
Wyzie Lib is a package made for easily implementing [Wyzie Subs](https://subs.wyzie.ru) into your
|
|
4
|
-
project without all the fuss.
|
|
4
|
+
project without all the fuss. [Read our source code!](https://github.com/itzcozi/wyzie-lib)
|
|
5
5
|
|
|
6
6
|
<sup>2.0 Out Now!</sup>
|
|
7
7
|
|
|
@@ -13,36 +13,24 @@ project without all the fuss.
|
|
|
13
13
|
|
|
14
14
|
## Installation
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
**NPM**
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
19
|
npm install wyzie-lib
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
**PNPM**
|
|
23
23
|
|
|
24
24
|
```bash
|
|
25
25
|
pnpm install wyzie-lib
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
**Yarn**
|
|
29
29
|
|
|
30
30
|
```bash
|
|
31
31
|
yarn add wyzie-lib
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
## Parameters
|
|
35
|
-
|
|
36
|
-
- **tmdb_id**: The TMDB ID of the movie or TV show. _(tmdb_id or imdb_id is required)_
|
|
37
|
-
- **imdb_id**: The IMDB ID of the movie or TV show. _(imdb_id or tmdb_id is required)_
|
|
38
|
-
- **type**: The file format of the subtitles returned. _(srt, ass, vtt, txt, sub, mpl, webvtt,
|
|
39
|
-
dfxp)_
|
|
40
|
-
- **season**: Disired season of subtites _(this requires episode parameter aswell)_
|
|
41
|
-
- **episode**: The episode of the given season.
|
|
42
|
-
- **language**: The ISO 3166 code of the provided subtitles.
|
|
43
|
-
- **display**: The actual name of the language capitalized.
|
|
44
|
-
- **isHearingImpaired**: A boolean indicating if the subtitles are hearing impaired.
|
|
45
|
-
|
|
46
34
|
## Usage
|
|
47
35
|
|
|
48
36
|
```ts
|
|
@@ -53,11 +41,23 @@ const data: SubtitleData[] = await searchSubtitles({ tmdb_id: 286217 });
|
|
|
53
41
|
console.log(data[0]); // Prints the object of the first subtitle provided in the search
|
|
54
42
|
```
|
|
55
43
|
|
|
44
|
+
### Parameters
|
|
45
|
+
|
|
46
|
+
| Parameter | Name | Description |
|
|
47
|
+
| ----------------------- | ----------------- | ----------------------------------------------------------------------------------------- |
|
|
48
|
+
| **tmdb_id** - _number_ | TmdbId | The TMDB ID of the movie or TV show. _(tmdb_id or imdb_id is required)_ |
|
|
49
|
+
| **imdb_id** - _number_ | ImdbId | The IMDB ID of the movie or TV show. _(imdb_id or tmdb_id is required)_ |
|
|
50
|
+
| **format** - _string_ | format | The file format of the subtitles returned. _(srt, ass, vtt, txt, sub, mpl, webvtt, dfxp)_ |
|
|
51
|
+
| **season** - _number_ | season | Disired season of subtites _(this requires episode parameter aswell)_ |
|
|
52
|
+
| **episode** - _number_ | episode | The episode of the given season. |
|
|
53
|
+
| **language** - _string_ | language | The ISO 3166 code of the provided subtitles. |
|
|
54
|
+
| **hi** - _boolean_ | isHearingImpaired | A boolean indicating if the subtitles are hearing impaired. |
|
|
55
|
+
|
|
56
56
|
### Types
|
|
57
57
|
|
|
58
|
-
- **SubtitleData**: All returned values from the API with their respective types.
|
|
59
58
|
- **SearchSubtitlesParams**: All valid parameters recognized by the API.
|
|
60
59
|
- **QueryParams**: All parameters (optional and required) available for the wyzie-subs API.
|
|
60
|
+
- **SubtitleData**: All returned values from the API with their respective types.
|
|
61
61
|
|
|
62
62
|
```ts
|
|
63
63
|
interface SearchSubtitlesParams {
|