# @flinj/client

> | :construction: This project is still in development. You should use it with caution. | | ------------------------------------------------------------------------------------ |

Latest version **1.1.0** (published 2022-10-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @flinj/client
pnpm add @flinj/client
yarn add @flinj/client
bun add @flinj/client
```

Provides the command `flinj`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-10-15 |
| First published | 2022-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | LacheRo` |
| Maintainers | lachero |
| Keywords | express, framework, sinatra, web, http, rest, restful, router, app, api, open, hapi, application, middleware |

## Links

- npm: https://www.npmjs.com/package/@flinj/client
- Repository: https://github.com/flinj/flinj
- Homepage: https://github.com/flinj/flinj#readme
- Issues: https://github.com/flinj/flinj/issues
- npm.io page: https://npm.io/package/@flinj/client

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.1.2
- [@flinj/utils](https://npm.io/package/@flinj/utils.md) ^1.0.4

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2022-10-15
- 1.0.17 — 2022-10-10
- 1.0.16 — 2022-10-08
- 1.0.15 — 2022-10-08
- 1.0.14 — 2022-10-08
- 1.0.13 — 2022-10-08
- 1.0.12 — 2022-10-08
- 1.0.11 — 2022-10-08
- 1.0.10 — 2022-10-08
- 1.0.9 — 2022-10-08
- 1.0.8 — 2022-10-08
- 1.0.7 — 2022-10-08
- 1.0.6 — 2022-10-08
- 1.0.5 — 2022-10-08
- 1.0.4 — 2022-10-08
- … 4 more at https://npm.io/package/@flinj/client/versions

## README

# @flinj/client

| :construction: This project is still in development. You should use it with caution. |
| ------------------------------------------------------------------------------------ |

The fasest way to build REST API

![Flinching](https://media.giphy.com/media/TpXiNmXLdpOaEENYci/giphy.gif)

## Prerequisite

Install [@flinj/server](https://www.npmjs.com/package/@flinj/server) on your server

## Installation

```bash
npm i @flinj/client
```

navigate to your client directory and run

```base
npx flinj ../relative/path/to/backend/controllers
```

**Remember**
Everytime you create new controller on your server you need to run the command above

## Usage

```js
import { createClient } from '@flinj/client';

export const client = createClient({
	baseURL: '/api',
	headers: {
		authorization: `Bearer ${process.env.API_KEY}`,
	},
});

const user = await client.users.POST({
	name: 'Israel',
	email: 'test@gmail.com',
	password: '123456',
});
```

## TODO

- [x] support multi request params
- [x] adjust to work with the new changes of @flinj/server

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