Go to file
William Oldham 0477b876ec
Merge pull request #44 from lonelil/dev
Correct function name for runEmbedScraper
2023-12-21 09:08:34 +00:00
.docs Correct function name for runEmbedScraper 2023-12-21 17:01:14 +08:00
.github Merge branch 'dev' into better-int-testing 2023-09-28 18:54:12 +01:00
.vscode repo setup 2023-06-21 14:50:06 +02:00
examples add support for full url merging 2023-09-06 14:30:21 +02:00
src Merge branch 'dev' of https://github.com/JorrinKievit/providers into dev 2023-12-18 21:24:00 +01:00
tests Add very basic integration tests 2023-09-28 19:45:41 +02:00
.editorconfig repo setup 2023-06-21 14:50:06 +02:00
.eslintrc.js Add very basic integration tests 2023-09-28 19:45:41 +02:00
.gitattributes repo setup 2023-06-21 14:50:06 +02:00
.gitignore Added source testing script 2023-09-25 18:50:56 -04:00
.npmrc repo setup 2023-06-21 14:50:06 +02:00
.prettierrc repo setup 2023-06-21 14:50:06 +02:00
README.md version 1.0.0 of the lib! 2023-09-29 21:57:58 +02:00
package-lock.json add smashystream 2023-12-17 16:22:42 +01:00
package.json Version bump 2023-12-15 19:23:28 +01:00
tsconfig.json changed script import path to skip compilation step 2023-09-26 15:34:29 -04:00
vite.config.js bump version and fix package types 2023-09-10 19:45:20 +02:00

README.md

@movie-web/providers

package that holds all providers of movie-web. Feel free to use for your own projects.

features:

  • scrape popular streaming websites
  • works in both browser and server-side

Visit documentation here: https://providers.docs.movie-web.app/

Development

To make testing scrapers easier during development a CLI tool is available to run specific sources. To run the CLI testing tool, use npm run test:dev. The script supports 2 execution modes

  • CLI Mode, for passing in arguments directly to the script
  • Question Mode, where the script asks you questions about which source you wish to test

The following CLI Mode arguments are available

Argument Alias Description Default
--fetcher -f Fetcher type. Either node-fetch or native node-fetch
--source-id -sid Source ID for the source to be tested
--tmdb-id -tid TMDB ID for the media to scrape. Only used if source is a provider
--type -t Media type. Either movie or show. Only used if source is a provider movie
--season -s Season number. Only used if type is show 0
--episode -e Episode number. Only used if type is show 0
--url -u URL to a video embed. Only used if source is an embed
--help -h Shows help for the command arguments

Example testing the FlixHQ source on the movie "Spirited Away"

npm run test:dev -- -sid flixhq -tid 129 -t movie