# @alpakaio/alpaka-native-request

> Request facade used by Alpaka React Native apps

Latest version **1.0.2** (published 2019-10-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @alpakaio/alpaka-native-request
pnpm add @alpakaio/alpaka-native-request
yarn add @alpakaio/alpaka-native-request
bun add @alpakaio/alpaka-native-request
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-10-14 |
| First published | 2019-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.4 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Victoria French |
| Maintainers | phillrodgers, thomastuts, victoriafrench |
| Keywords | alpaka, network |

## Links

- npm: https://www.npmjs.com/package/@alpakaio/alpaka-native-request
- Repository: https://github.com/alpakaio/alpaka-native-request
- Homepage: https://github.com/alpakaio/alpaka-native-request#readme
- Issues: https://github.com/alpakaio/alpaka-native-request/issues
- npm.io page: https://npm.io/package/@alpakaio/alpaka-native-request

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.19.0
- [@alpakaio/alpaka-native-useragent](https://npm.io/package/@alpakaio/alpaka-native-useragent.md) ^1

## Recent versions

- 1.0.2 (latest) — 2019-10-14
- 1.0.1 — 2019-06-04
- 1.0.0 — 2019-05-24

## README

# alpaka-native-request

[![npm version](https://badge.fury.io/js/%40alpakaio%2Falpaka-native-request.svg)](https://badge.fury.io/js/%40alpakaio%2Falpaka-native-request)

Request facade used by [Alpaka](https://www.alpaka.io) [React Native](https://github.com/facebook/react-native) apps.

## TOC

* [Installation](#installation)
* [Usage](#usage)
* [API](#api)
* [Release Notes](#release-notes)

## Installation

Using npm:

```shell
npm install --save @alpakaio/alpaka-native-request
```

## Usage

```js
import UserAgent from '@alpakaio/alpaka-native-request';
```

## API

| Method                                                            | Return Type         |  iOS | Android | Windows | Since  |
| ----------------------------------------------------------------- | ------------------- | :--: | :-----: | :-----: | ------ |
| [createRequest(tenant, [token])](#createrequest)                  | `Promise<Request>`  |  ✅  |   ✅    |   ✅    | 1.0.0 |
| [createInstance()](#createinstance)                               | `Promise<Request>`  |  ✅  |   ✅    |   ✅    | 1.0.0 |

### createRequest()

Creates or gets a current axios instance configured to communicate with the Alpaka API

**Examples**

```js
const request = await createRequest('test');
const response = request.get('version');
console.log(response.data.version);
```

```js
createRequest((request) => (request.get('version'))).then((response) => {
    console.log(response.data.version);
});
```

### createInstance()

Creates an axios instance with an Alpaka user agent assigned

**Examples**

```js
const axios = await createInstance();
const response = axios.get('https://alpaka.alpaka.io/api/v3/version');
console.log(response.data.version);
```

```js
createInstance((axios) => (axios.get('https://alpaka.alpaka.io/api/v3/version'))).then((response) => {
    console.log(response.data.version);
});
```

## Release Notes

See the [CHANGELOG.md](https://github.com/alpakaio/alpaka-native-request/blob/master/CHANGELOG.md).

---
_Source: https://npm.io/package/@alpakaio/alpaka-native-request · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._