This package provides functions to help applications track and send [resource hints] for the assets they use. Resource hints enable developers to optimise the delivery of certain resources.
npm install @financial-times/dotcom-server-resource-hintsThis package provides functions to help applications track and send [resource hints] for the assets they use. Resource hints enable developers to optimise the delivery of certain resources.
[resource hints]: https://www.w3.org/TR/resource-hints/
This package is compatible with Node 8+ and is distributed on npm.
``bash`
npm install -S @financial-times/dotcom-server-resource-hints
This package provides a single class which can be configured using options.
`js`
import { ResourceHints } from '@financial-times/dotcom-server-resource-hints'
const resourceHints = new ResourceHints()
The resource hints instance provides methods to maintain a list of assets used for the lifecycle of a request and then format this list into a string suitable for use as a Link header:
`js
resourceHints.add('styles.css')
resourceHints.add('scripts.js')
resourceHints.toString() //
`
Below is an example demonstrating how this package may be used within an [Express] application to track any assets used during the lifecycle of a request and send a Link header along with the response:
`js
import { ResourceHints } from '@financial-times/dotcom-server-resource-hints'
app.use('/', (request, response) => {
const resourceHints = new ResourceHints()
resourceHints.add('styles.css')
resourceHints.add('scripts.js')
response.set('Link', resourceHints.toString())
response.send('
My awesome page
')[Express]: https://expressjs.com/
API
$3
Add a file (either a complete URL or a path) to the list of resources to create hints for.
$3
Returns a formatted string of resource hints for use as a
HTTP header.
Options
The
ResourceHints` class accepts the following parameters. All parameters are optional:_There are currently no options for this middleware package._