url-assist v1.2.1

UrlAssist

Site | Docs |

Download

• Core build (~10KB)
• Dependency build (~65KB)

Using npm:

$ npm i url-assist

How to import the Library

In a browser :

<script src="structkit-full.iife.js"></script>
<script src="url-assist.js"></script>

Import on cjs

const {isUrlExtValid} = require('url-assist');

Import on ESM or TS

import {isUrlExtValid} from 'url-assist';

Example

In a browser

urs.isUrlExtValid('https://example.com/example.js', 'js')

keep in mind urs is used as global library at html

CJS, ESM and TS use this code below

isUrlExtValid('https://example.com/example.js', 'js')

List of method you can use to check your url

match pattern against extension in url

isUrlExtValid('https://example.com/example.js', 'js')// true
isUrlExtValid('https://example.com/example.js', 'css')// false

get the domain or url details

getHostDetails('https://www.example.com')
// => {
//            "domainDetails": {
//                "domain": "example",
//                "domainWithTld": "example.com",
//                "subdomain": "www",
//                "tld": "com"
//            },
//            "hash": "",
//            "hostname": 'www.example.com',
//            "href": 'https://www.example.com',
//            "password": "",
//            "pathname": "",
//            "port": "",
//            "protocol": "https",
//            "search": '',
//            "user": ''
//        }

check if url is valid https

isHttps('https://example.com')// true

Verify your pattern and url structure

data = urs.urlPattern("/:id", "/test")
data.isValid() // true
data.getParam() // {id: 'test'}

Verify your pattern and url structure only number as parameter

data = urs.urlPattern("/:id<number>", "/1")
data.isValid() // true
data.getParam() // {id: '1'}

Compose your url structure

data = urlComposer('https://example.com')
data.getToString() // 'https://example.com'
data.setDomainSubdomain("api")
data.getToString() // 'https://api.example.com'
data.setProtocol("http")
data.getToString() // http://api.example.com/

Query String parser

qsParse("test=1&test2=11") //{"test": 11,"test2": 11}

Query String to Stringify

qsStringify({"test": 11,"test2": 11}) //test=1&test2=11

To join the path

joinUrlPath('https://example.com','test') //https://example.com/test

Check url is valid format

isUrlValidFormat('https://example.com')// true
isUrlValidFormat('ftp://example.com')// false

Check https only

isHttps('https://example.com')// true
isHttps('http://example.com')// false

Check https/http is valid

isHttpProtocolValid('https://example.com')// true
isHttpProtocolValid('ftp://example.com')// false