package
PostHTML plugin for fetching and displaying remote or local content.
npm install posthtml-fetchGitHub-flavored package documentation.
Across all versions, last 30 days.
170,355 in 30 days
Runtime metadata.
Tagged topics.
This plugin allows you to fetch remote or local content and display it in your HTML.
Input:
<fetch url="https://jsonplaceholder.typicode.com/users/1">
{{ response.name }}'s username is {{ response.username }}
</fetch>Output:
Leanne Graham's username is Bretnpm i posthtml posthtml-fetchconst posthtml = require('posthtml')
const posthtmlFetch = require('posthtml-fetch')
posthtml()
.use(posthtmlFetch())
.process('<fetch url="https://example.test">{{ response }}</fetch>')
.then(result => console.log(result.html))
// => interpolated response bodyThe response body will be available under the response local variable.
The plugin supports json and text responses.
Only the response body is returned.
The plugin uses posthtml-expressions, so you can use any of its tags to work with the response.
For example, you can iterate over items in a JSON response:
<fetch url="https://jsonplaceholder.typicode.com/users">
<each loop="user in response">
{{ user.name }}
</each>
</fetch>You may configure the plugin with the following options.
tagsType: String[]
Default: ['fetch', 'remote']
Array of supported tag names.
Only tags from this array will be processed by the plugin.
Example:
const posthtml = require('posthtml')
const posthtmlFetch = require('posthtml-fetch')
posthtml()
.use(posthtmlFetch({
tags: ['get']
}))
.process('<get url="https://example.test">{{ response }}</get>')
.then(result => console.log(result.html))attributeType: String
Default: 'url'
String representing attribute name containing the URL to fetch.
Example:
const posthtml = require('posthtml')
const posthtmlFetch = require('posthtml-fetch')
posthtml()
.use(posthtmlFetch({
attribute: 'from'
}))
.process('<fetch from="https://example.test">{{ response }}</fetch>')
.then(result => {
console.log(result.html) // interpolated response body
})ofetchThe plugin uses ofetch to fetch data. You can pass options directly to it, inside the ofetch object.
Example:
const posthtml = require('posthtml')
const posthtmlFetch = require('posthtml-fetch')
posthtml()
.use(posthtmlFetch({
ofetch: {
// pass options to ofetch...
}
}))
.process('<fetch url="https://example.test">{{ response }}</fetch>')
.then(result => {
console.log(result.html) // interpolated response body
})preserveTagType: Boolean
Default: false
When set to true, this option will preserve the tag around the response body.
Example:
const posthtml = require('posthtml')
const posthtmlFetch = require('posthtml-fetch')
posthtml()
.use(posthtmlFetch({
preserveTag: true
}))
.process('<fetch url="https://example.test">{{ response }}</fetch>')
.then(result => {
console.log(result.html)
// => <fetch url="https://example.test">interpolated response body</fetch>
})expressionsType: Object
Default: {}
You can pass options to posthtml-expressions.
Example:
const posthtml = require('posthtml')
const posthtmlFetch = require('posthtml-fetch')
posthtml()
.use(posthtmlFetch({
expressions: {
delimiters: ['[[', ']]'],
}
}))
.process('<fetch url="https://example.test">[[ response ]]</fetch>')
.then(result => {
console.log(result.html) // interpolated response body
})after/beforeList of plugins that will be called after/before receiving and processing locals
Example:
const posthtml = require('posthtml')
const posthtmlFetch = require('posthtml-fetch')
posthtml()
.use(posthtmlFetch({
plugins: {
before: [
tree => {
// Your plugin implementation
},
tree => {
// Your plugin implementation
}
],
after: [
tree => {
// Your plugin implementation
},
tree => {
// Your plugin implementation
}
]
cossssmin
hellocosmin@gmail.com
Estimated unpacked size across 15 packages.
1.3 MB
Includes dependencies.
6 direct · 1 outdated
^6.1.4
6.1.7
^1.2.4
1.2.4
^1.3.4
1.5.1
^0.16.6
0.16.7
^1.11.3
1.11.4
^1.0.1
2.0.3