Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

piral-axios

0.12.1 • Public • Published

Piral Logo

Piral Axios · GitHub License npm version tested with jest Gitter Chat

This is a plugin that only has a peer dependency to piral-core. What piral-axios brings to the table is a single Pilet API extension called axios that is used by piral. Axios is a library for making HTTP requests.

Documentation

The following functions are brought to the Pilet API.

axios

Represents an Axios instance already configured for use in the app shell.

Usage

::: summary: For pilet authors

You can use the axios object from the Pilet API to communicate with your backend. This instance has advantages over creating a fresh instance from Axios.

For instance, it is already wired up with the authentication system and communicating to the right backend. As such relative URLs can be used when doing requests.

Example use:

import { PiletApi } from '<name-of-piral-instance>';
 
export function setup(piral: PiletApi) {
  const promise = piral.axios.get('/foo');
}

For details on using Axios, see the Axios documentation.

:::

::: summary: For Piral instance developers

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 createAxiosApi from the piral-axios package.

import { createAxiosApi } from 'piral-axios';

The integration looks like:

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

Via the options the default settings such as the baseURL can be defined. These options are taken directly from axios.

For example:

const instance = createInstance({
  // important part
  plugins: [createAxiosApi({
    baseURL: 'https://example.com/api/v1',
    headers: {
      authorization: 'Bearer ...',
    },
  })],
  // ...
});

Note: piral-axios plays nicely together with authentication providers such as piral-adal. As such authentication tokens are automatically inserted on requests to the base URL.

:::

License

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

Install

npm i piral-axios

DownloadsWeekly Downloads

718

Version

0.12.1

License

MIT

Unpacked Size

11.6 kB

Total Files

16

Homepage

piral.io

Last publish

Collaborators

  • avatar