flixhq-core
Advanced tools
Comparing version 1.0.1 to 1.0.6
{ | ||
"name": "flixhq-core", | ||
"version": "1.0.1", | ||
"version": "1.0.6", | ||
"description": "Nodejs library that provides an Api for obtaining the movies information from FlixHQ website.", | ||
"main": "build/index.js", | ||
"main": "dist/index.js", | ||
"scripts": { | ||
@@ -7,0 +7,0 @@ "dev": "nodemon src/index.ts", |
@@ -29,3 +29,3 @@ | ||
- [fetchMovieInfo](#fetchmovieinfo) | ||
- [fetchEpisodeServers](#fetchepisodeserver) | ||
- [fetchEpisodeServers](#fetchepisodeservers) | ||
- [fetchEpisodeSources](#fetchepisodesources) | ||
@@ -49,3 +49,3 @@ - [search](#search) | ||
``` | ||
returns a promise which resolves into an object. (*[`Promise<IHomeResult>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L54-L65)*). | ||
returns a promise which resolves into an object. (*[`Promise<IHomeResult>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L49-L60)*). | ||
@@ -63,3 +63,3 @@ ### fetchGenresList | ||
``` | ||
returns a promise which resolves into an array of genres. (*[`Promise<IGenre[]>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L67-L71)*). | ||
returns a promise which resolves into an array of genres. (*[`Promise<IGenre[]>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L62-L67)*). | ||
@@ -77,10 +77,10 @@ ### fetchCountriesList | ||
``` | ||
returns a promise which resolves into an array of countries. (*[`Promise<ICountry[]>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L73-L77)*). | ||
returns a promise which resolves into an array of countries. (*[`Promise<ICountry[]>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L68-L72)*). | ||
### fetchMovieByCountryOrGenre | ||
| Parameter | Type | Description | | ||
| --------- | ------------- | ----------- | | ||
| filterBy | [`FilterStrings`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L15-L20) | Accept: "GENRE" or "COUNTRY". | | ||
| query | string | query that depend on the `filterBy` parameter. (*genre or country that can be found in the genres or countries list*). | | ||
| page (optional) | number | page number (*default: 1*). | | ||
| Parameter | Type | Description | | ||
| --------- |------------------------------------------------------------------------------------------| ----------- | | ||
| filterBy | [`Filters`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L14-L17) | Accept: "GENRE" or "COUNTRY". | | ||
| query | string | query that depend on the `filterBy` parameter. (*genre or country that can be found in the genres or countries list*). | | ||
| page (optional) | number | page number (*default: 1*). | | ||
@@ -97,9 +97,9 @@ ```ts | ||
``` | ||
returns a promise which resolves into an array of movies/tvseries. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L79-L85)*). | ||
returns a promise which resolves into an array of movies/tvseries. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*). | ||
### fetchMovieByType | ||
| Parameter | Type | Description | | ||
| --------- | ---- | ----------- | | ||
| type | [`MovieTypeStrings`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L1-L6) | Accept: "MOVIE" or "TVSERIES". | | ||
| page (optional) | number | page number (default: 1). | | ||
| Parameter | Type | Description | | ||
| --------- |------------------------------------------------------------------------------------------| ----------- | | ||
| type | [`MovieType`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L1-L5) | Accept: "MOVIE" or "TVSERIES". | | ||
| page (optional) | number | page number (default: 1). | | ||
@@ -116,9 +116,9 @@ ```ts | ||
``` | ||
returns a promise which resolves into an array of movies. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L79-L85)*). | ||
returns a promise which resolves into an array of movies. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*). | ||
### fetchMovieByTopIMDB | ||
| Parameter | Type | Description | | ||
| --------- | ---- | ----------- | | ||
| type (optional) | [`MovieTypeStrings`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L1-L6) | Accept: "MOVIE" or "TVSERIES" (default: "ALL"). | | ||
| page (optional) | number | page number (default: 1). | | ||
| Parameter | Type | Description | | ||
| --------- |------------------------------------------------------------------------------------------| ----------- | | ||
| type (optional) | [`MovieType`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L1-L5) | Accept: "MOVIE" or "TVSERIES" (default: "ALL"). | | ||
| page (optional) | number | page number (default: 1). | | ||
@@ -135,3 +135,3 @@ ```ts | ||
``` | ||
returns a promise which resolves into an array of movies/tvseries. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L79-L85)*). | ||
returns a promise which resolves into an array of movies/tvseries. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*). | ||
@@ -153,3 +153,3 @@ ### fetchMovieInfo | ||
``` | ||
returns a promise which resolves into an object of movie info. (*[`Promise<IMovieInfo>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L96-L109)*). | ||
returns a promise which resolves into an object of movie info. (*[`Promise<IMovieInfo>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L91-L104)*). | ||
@@ -172,10 +172,10 @@ ### fetchEpisodeServers | ||
``` | ||
returns a promise which resolves into an array of the servers info. (*[`Promise<IEpisodeServer>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L111-L115)*). | ||
returns a promise which resolves into an array of the servers info. (*[`Promise<IEpisodeServer>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L106-L110)*). | ||
### fetchEpisodeSources | ||
| Parameter | Type | Description | | ||
| --------- | ---- | ----------- | | ||
| mediaId | string | (*can be found in the media search results.*). | | ||
| episodeId | string | (*can be found in the media info results as shown on the above method*). | | ||
| server (optional) | [`StreamingServerStrings`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L22-L28) | Accept: "UpCloud" or "VidCloud" or "MixDrop" (default: "UpCloud"). | | ||
| Parameter | Type | Description | | ||
| --------- |---------------------------------------------------------------------------------------------------| ----------- | | ||
| mediaId | string | (*can be found in the media search results.*). | | ||
| episodeId | string | (*can be found in the media info results as shown on the above method*). | | ||
| server (optional) | [`StreamingServers`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L19-L23) | Accept: "UpCloud" or "VidCloud" or "MixDrop" (default: "UpCloud"). | | ||
@@ -210,3 +210,3 @@ ```ts | ||
``` | ||
returns a promise which resolves into an array of movies/tvseries. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L79-L85)*). | ||
returns a promise which resolves into an array of movies/tvseries. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*). | ||
@@ -224,9 +224,9 @@ ### fetchFiltersList | ||
``` | ||
returns a promise which resolves into an object of filters info. (*[`Promise<IMovieFilter>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L147-L154)*). | ||
returns a promise which resolves into an object of filters info. (*[`Promise<IMovieFilter>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L142-L149)*). | ||
### filter | ||
| Parameter | Type | Description | | ||
| --------- | ---- | ----------- | | ||
| options | [`IMovieFilter`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L147-L154) | (*Includes: type, quality, released, genre, country. Can be found in the filters list as shown on the above method.*) | | ||
| page (optional) | number | page number (default: 1). | | ||
| Parameter | Type | Description | | ||
| --------- |-------------------------------------------------------------------------------------------------| ----------- | | ||
| options | [`IMovieFilter`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L142-L149) | (*Includes: type, quality, released, genre, country. Can be found in the filters list as shown on the above method.*) | | ||
| page (optional) | number | page number (default: 1). | | ||
@@ -245,2 +245,2 @@ ```ts | ||
``` | ||
returns a promise which resolves into an array of movies/tvseries. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L79-L85)*). | ||
returns a promise which resolves into an array of movies/tvseries. (*[`Promise<ISearch<IMovieResult>>`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*). |
@@ -52,3 +52,3 @@ { | ||
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ | ||
"outDir": "./build", /* Specify an output folder for all emitted files. */ | ||
"outDir": "./dist", /* Specify an output folder for all emitted files. */ | ||
// "removeComments": true, /* Disable emitting comments. */ | ||
@@ -55,0 +55,0 @@ // "noEmit": true, /* Disable emitting files from a compilation. */ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Unpublished package
Supply chain riskPackage version was not found on the registry. It may exist on a different registry and need to be configured to pull from that registry.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Unpopular package
QualityThis package is not very popular.
Found 1 instance in 1 package
0
95735
40
1041
1