# fter

> Urls parameter handler

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

## Install

```sh
npm install fter
pnpm add fter
yarn add fter
bun add fter
```

## 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.1.0 |
| Published | 2021-10-26 |
| First published | 2021-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Erick |
| Maintainers | ertrii, bitzone |
| Keywords | typescript, javascript, query, path, url, request |

## Links

- npm: https://www.npmjs.com/package/fter
- Repository: https://github.com/Bitzone-lab/fter
- Homepage: https://github.com/Bitzone-lab
- Issues: https://github.com/Bitzone-lab/fter/issues
- npm.io page: https://npm.io/package/fter

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-10-26
- 1.0.0-beta.1 — 2021-01-14

## README

Fter
=========

> Urls parameter handler 

```
npm install fter
```
```js
import fter from 'fter'
```

## Started

```js
// Properties
const filter = {
    search: 'hello',
    limit: 10,
    sort: 'name',
    ids: [1, 5],
    enabled: false
}
// queries
fter(filter)`
    search
    limit?10
    sort
    order=asc
    page?
    ids
    enabled?
`
```
> query path:
> `/?search=&sort=name&order=asc&ids=1,5&enabled=false`

## Symbols

* `?` **OPTIONAL**, use when ownership is not required.
* `=` **DEFAULT**, use when you want to generate a default value.

### Optional (?)
It is a non-mandatory property. It can also be optional when a value is specified.
```js
fter({ search: 'hello' })`
    search
    limit?
`
```
> `?search=hello`
```js
fter({ search: 'hello', limit: 10 })`
    search
    limit?10
`
```
> `?search=hello`
```js
fter({ search: 'hello', limit: 15 })`
    search
    limit?10
`
```
> `?search=hello&limit=15`
```js
fter({ ids: [1, 2], limit: 10 })`
    ids?1,2
    limit
`
```
> `?limit=10`
```js
fter({ ids: [1, 2, 3], limit: 10 })`
    ids?1,2
    limit
`
```
> `?ids=1,2,3&limit=10`

### Default (=)

Is when a default value is needed when it is not received from the property.
```js
fter({ limit: 15 })`
    search=bye
    limit
`
```
> `?search=bye&limit=15`
```js
fter({ search: 'hello', limit: 15 })`
    search=bye
    limit
`
```
> `?search=hello&limit=15`
```js
fter({ limit: 15 })`
    search=
    limit
`
```
> `?search=&limit=15`

```js
fter({ limit: 10 })`
    ids=1,2
    limit
`
```
> `?ids=1,2&limit=10`

```js
fter({ limit: 10 })`
    ids=1,2
    limit
`
```
> `?ids=1,2&limit=10`

## Required

If no symbol is received, it will be required.
```js
fter({ search: 'hello' })`
    search
    limit
`
```
> `?search=hello&limit=undefined`

## Null

When it is required.
```js
fter({ search: null })`
    search
`
```
> `?search=`

When it's optional.
```js
fter({ search: 'hello', count: null })`
    search
    count?
`
```
> `?search=hello`

When it has a default value
```js
fter({ search: 'hello', count: null })`
    search
    count=2
`
```
> `?search=hello&count=`

```js
fter({ search: 'hello' })`
    search
    count=null
`
```
> `?search=hello&count=null`

## Parse

```js
import { parse } from 'fter'
```
```js
import fter from 'fter'

fter.parse({
    name: 'Juan'
})
```
> `?name=Juan`

Convert an object to link parameters

## Merge

```js
import { merge } from 'fter'
```
```js
import fter from 'fter'

fter.merge(
    'http://localhost:8000/users?limit=10',
    'https://my_page?search=hi&order=asc'
)
```
> `http://localhost:8000/users?limit=10&search=hi&order=asc`

```js
merge('localhost', '?search=hi')
```
> `localhost?search=hi`

```js
merge('https://localhost', 'param1=value1&param2=value2')
```
> `https://localhost?param1=value1&param2=value2`

Merge params

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