Package Exports

piral-fetch

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (piral-fetch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Piral Fetch ·

This is an extension library that only has a peer dependency to piral-core. What piral-fetch brings to the table is a single API extension called fetch that is used by piral.

Documentation

For details on the provided API check out the documentation at the Piral website or on GitHub.

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 { createFetchApi } from 'piral-fetch';

The integration looks like:

const instance = createInstance({
  // important part
  extendApi: [createFetchApi()],
  // ...
});

Via the options the default settings and the base URL can be defined.

For example:

const instance = createInstance({
  // important part
  extendApi: [createFetchApi({
    base: 'https://example.com/api/v1',
    default: {
      headers: {
        authorization: 'Bearer ...',
      },
    },
  })],
  // ...
});

License

Piral is released using the MIT license. For more information see the license file.