Link resolver service for FrankerFaceZ.
- Supports site-specific modules for refining responses
- Falls back to
<meta>tags and HTML scraping if necessary - Keeps track of page redirects
- Support for safety checking individual URLs, including via Google SafeBrowsing if configured.
- Support for caching, integrated with redirect handling
$ npm install @ffz/link-service --saveThere's a built-in tool that both provides an interactive shell and that runs an HTTPS server the client can communicate with for testing. To start it, just run:
$ npm startBy default, this will start the HTTPS server listening on port 8002 with a self-signed certificate. In order to use this server for developing with FrankerFaceZ, you'll need to ensure your browser will accept self-signed certificates for localhost. That may involve visiting https://localhost:8002 in your browser and making an exception for the certificate.
Once you've done that, you can go to Debugging > Data Sources in
the FrankerFaceZ client and change the Link Resolver to localhost
to start making requests to the local server.
At that point, you just pick a URL for testing or enter a custom URL and you go to work implementing your custom resolver.
If you create a file named config.json, that file will be used to
configure the LinkService instance from the shell script. You should
use this file to install API keys for local testing, if necessary.
- Finish Documentation
- Write Tests
Run tests using npm test.
Please submit all issues and pull requests to the FrankerFaceZ/link-service repository.