Fter

Urls parameter handler

npm install fter

import fter from 'fter'

Started

// 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.

fter({ search: 'hello' })`
    search
    limit?
`

?search=hello

fter({ search: 'hello', limit: 10 })`
    search
    limit?10
`

?search=hello

fter({ search: 'hello', limit: 15 })`
    search
    limit?10
`

?search=hello&limit=15

fter({ ids: [1, 2], limit: 10 })`
    ids?1,2
    limit
`

?limit=10

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.

fter({ limit: 15 })`
    search=bye
    limit
`

?search=bye&limit=15

fter({ search: 'hello', limit: 15 })`
    search=bye
    limit
`

?search=hello&limit=15

fter({ limit: 15 })`
    search=
    limit
`

?search=&limit=15

fter({ limit: 10 })`
    ids=1,2
    limit
`

?ids=1,2&limit=10

fter({ limit: 10 })`
    ids=1,2
    limit
`

?ids=1,2&limit=10

Required

If no symbol is received, it will be required.

fter({ search: 'hello' })`
    search
    limit
`

?search=hello&limit=undefined

Null

When it is required.

fter({ search: null })`
    search
`

?search=

When it's optional.

fter({ search: 'hello', count: null })`
    search
    count?
`

?search=hello

When it has a default value

fter({ search: 'hello', count: null })`
    search
    count=2
`

?search=hello&count=

fter({ search: 'hello' })`
    search
    count=null
`

?search=hello&count=null

Parse

import { parse } from 'fter'

import fter from 'fter'

fter.parse({
    name: 'Juan'
})

?name=Juan

Convert an object to link parameters

Merge

import { merge } from 'fter'

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

merge('localhost', '?search=hi')

localhost?search=hi

merge('https://localhost', 'param1=value1&param2=value2')

https://localhost?param1=value1&param2=value2

Merge params