https://github.com/foxifyjs/rest-client

Client for "foxify-restify-odin" package
https://github.com/foxifyjs/rest-client

client foxify odin rest

Last synced: 4 months ago
JSON representation

Client for "foxify-restify-odin" package

• Host: GitHub
• URL: https://github.com/foxifyjs/rest-client
• Owner: foxifyjs
• License: mit
• Created: 2019-01-04T19:22:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T14:43:31.000Z (over 2 years ago)
• Last Synced: 2024-10-29T19:00:08.804Z (8 months ago)
• Topics: client, foxify, odin, rest
• Language: TypeScript
• Homepage: https://rest-client.js.org
• Size: 81.1 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rest-client 

Client for [`foxify-restify-odin`](https://github.com/foxifyjs/foxify-restify-odin) package

[![Npm Version](https://img.shields.io/npm/v/rest-client.svg)](https://www.npmjs.com/package/rest-client)

[![TypeScript Version](https://img.shields.io/npm/types/rest-client.svg)](https://www.typescriptlang.org)

[![Package Quality](https://npm.packagequality.com/shield/rest-client.svg)](https://packagequality.com/#?package=rest-client)

[![Npm Total Downloads](https://img.shields.io/npm/dt/rest-client.svg)](https://www.npmjs.com/package/rest-client)

[![Npm Monthly Downloads](https://img.shields.io/npm/dm/rest-client.svg)](https://www.npmjs.com/package/rest-client)

[![Open Issues](https://img.shields.io/github/issues-raw/foxifyjs/rest-client.svg)](https://github.com/foxifyjs/rest-client/issues?q=is%3Aopen+is%3Aissue)

[![Closed Issues](https://img.shields.io/github/issues-closed-raw/foxifyjs/rest-client.svg)](https://github.com/foxifyjs/rest-client/issues?q=is%3Aissue+is%3Aclosed)

[![Known Vulnerabilities](https://snyk.io/test/github/foxifyjs/rest-client/badge.svg?targetFile=package.json)](https://snyk.io/test/github/foxifyjs/rest-client?targetFile=package.json)

[![Dependencies Status](https://david-dm.org/foxifyjs/rest-client.svg)](https://david-dm.org/foxifyjs/rest-client)

[![Pull Requests](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](https://github.com/foxifyjs/rest-client/pulls)

[![License](https://img.shields.io/github/license/foxifyjs/rest-client.svg)](https://github.com/foxifyjs/rest-client/blob/master/LICENSE)

[![Build Status](https://api.travis-ci.com/foxifyjs/rest-client.svg?branch=master)](https://travis-ci.com/foxifyjs/rest-client)

[![Github Stars](https://img.shields.io/github/stars/foxifyjs/rest-client.svg?style=social&label=Stars)](https://github.com/foxifyjs/rest-client)

[![Github Forks](https://img.shields.io/github/forks/foxifyjs/rest-client.svg?style=social&label=Fork)](https://github.com/foxifyjs/rest-client)

## Table on Contents 

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Installation](#installation)

  - [Usage](#usage)

- [Versioning](#versioning)

- [Authors](#authors)

- [License](#license)

- [Support](#support)

## Getting Started

### Prerequisites

`npm i axios prototyped.js qs`

> if you're using typescript:

`npm i -D @types/axios @types/qs`

### Installation

`npm i @foxify/rest-client`

### Usage

```javascript

const Client = require("@foxify/rest-client");

```

> for full documentation see [here](https://rest-client.js.org)

## Versioning

We use [SemVer](http://semver.org) for versioning. For the versions available, see the [tags on this repository](https://github.com/foxifyjs/rest-client/tags).

## Authors

- **Ardalan Amini** - *Owner/Developer* - [@ardalanamini](https://github.com/ardalanamini)

See also the list of [contributors](https://github.com/foxifyjs/rest-client/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

## Support

If my work helps you, please consider

[![Become A Patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/ardalanamini)

[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/ardalanamini)