# vue-endpoints

> A small wrapper for projects with multiple api endpoints in vue.

Latest version **1.1.0** (published 2021-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-endpoints
pnpm add vue-endpoints
yarn add vue-endpoints
bun add vue-endpoints
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-03-03 |
| First published | 2021-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Timothy Antonovics |
| Maintainers | coderigged |
| Keywords | vue, vue-endpoints, axios, api, endpoints |

## Links

- npm: https://www.npmjs.com/package/vue-endpoints
- Repository: https://github.com/CodeRigged/vue-endpoints
- Homepage: https://github.com/CodeRigged/vue-endpoints#readme
- Issues: https://github.com/CodeRigged/vue-endpoints/issues
- npm.io page: https://npm.io/package/vue-endpoints

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-03-03
- 1.0.0 — 2021-02-11

## README

# vue-endpoints

vue-endpoints is a small wrapper for projects which require multiple API endpoints.

It uses [axios](https://github.com/axios/axios#axios) and is inspired by [vue-axios](https://github.com/imcvampire/vue-axios#vue-axios). Please go check them both out.

## Installing

Using npm:

```bash
$ npm install vue-endpoints
```

Using yarn:

```bash
$ yarn add vue-endpoints
```

## Usage in Vue 3

With typescript:

```ts
import { createApp } from "vue";
import { AxiosRequestConfig } from "axios";
import VueEndpoints, { createVueEndpoints } from "vue-endpoints";

const configurationsFirstInstance: AxiosRequestConfig = {
  baseURL: "/firstEndpoint",
};
const configurationsSecondInstance: AxiosRequestConfig = { baseURL: "/secondEndpoint" };

const onSuccess = (config: AxiosRequestConfig) => {
  const { method, baseURL = "", url } = config;
  console.log(`%c Made ${method} request to ${baseURL + url}`, 'color:green; font-weight:800');
  return config;
};

const apiInstances = [
  {
    name: "firstInstance",
    configs: configurationsFirstInstance,
    interceptors: {
      request: { onSuccess },
    },
  },
  { name: "secondInstance", configs: configurationsSecondInstance },
];

const vueEndpoints: VueEndpoints = createVueEndpoints({
  baseApi: "firstInstance",
  apiInstances,
});

createApp(App)
  .use(vueEndpoints)
  .mount("#app");
```

Without typescript:

```js
import { createApp } from "vue";
import { AxiosRequestConfig } from "axios";
import VueEndpoints from "vue-endpoints";

const configurationsFirstInstance = {
  baseURL: "/firstEndpoint",
};
const configurationsSecondInstance = { baseURL: "/secondEndpoint" };

const onSuccess = (config) => {
  const { method, baseURL = "", url } = config;
  console.log(`%c Made ${method} request to ${baseURL + url}`, 'color:green; font-weight:800');
  return config;
};

const apiInstances = [
  {
    name: "firstInstance",
    configs: configurationsFirstInstance,
    interceptors: {
      request: { onSuccess },
    },
  },
  { name: "secondInstance", configs: configurationsSecondInstance },
];

// alternative assignment
const vueEndpoints = new VueEndpoints({ apiInstances });

createApp(App)
  .use(vueEndpoints)
  .mount("#app");
```

In Vue component: 

```js
export default  {
  computed: {
    option1(){
        return this.$baseApi.get("/url/to/api");
    },
    //or
    option2(){
        return this.$apiEndpoints.getApi("nameOfApi").get("/url/to/api");
    },
  },
}
```

## API

##### createVueEndpoints(params?: PluginOptions): VueEndpoints

```js
const vueEndpoints = createVueEndpoints({
    /* Default base API will be the first API instance of instances-array */
    baseApi: "someName", 
  [{name:"someName", configs:{...axiosConfigurations}}],
});
```

##### setBaseApi(name: string): void

```js
const vueEndpoints = createVueEndpoints({
  [{name:"someName", configs:{...axiosConfigurations}}],
});
vueEndpoints.setBaseApi("someName")
```

#### getApi(name: string): AxiosInstance | undefined;

```js
const vueEndpoints = createVueEndpoints({
  [{name:"someName", configs:{...axiosConfigurations}}],
});

const someNameApi = vueEndpoints.getApi("someName");

```

#### apiInstances: ApiInstances[]

```html
<template>
    {{ myInstances[0].name }}
</template>
```
```js
<script>
export default {
  computed: {
    myInstances() {
      return this.$apiEndpoints.apiInstances;
    },
  },
};
</script>
```

## vue-2 compatibility

For now this tool is only compatible in [vue-3](https://v3.vuejs.org/).

## License

[MIT](/LICENSE)

---
_Source: https://npm.io/package/vue-endpoints · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._