This is a plugin that only has a peer dependency to piral-core
. What piral-feeds
brings to the table is a set of Pilet API extensions that can be used with piral
or piral-core
.
By default, these API extensions are not integrated in piral
, so you'd need to add them to your Piral instance.
Documentation
The following functions are brought to the Pilet API.
createConnector
Creates a new feed connector, which is an abstraction over a state container driven by the typical lifecycle of a data feed connection.
Returns a higher-order component for providing a data
prop that reflects the current feed data.
Setup and Bootstrapping
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import createFeedsApi
from the piral-feeds
package.
import { createFeedsApi } from 'piral-feeds';
The integration looks like:
const instance = createInstance({
extendApi: [createFeedsApi()],
});
There are no options available.
License
Piral is released using the MIT license. For more information see the license file.