Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
urlapi
Advanced tools
Readme
This module contains methods for working with url:
serialize({ })
);parse(' ')
).Good abilities for working with queries and authentication in object types.
In your cmd/terminal
npm install urlapi
then add module to your project
var urlapi = require('urlapi');
or for ES2015 use
import * as urlapi from 'urlapi';
Takes object with next attributes and return string
protocol
: protocol with or without colon-slash-slash, colon (example: http
, http://
, mailto:
) - string
;auth
: authentication data (example: user:password
, { login: 'user', password: 'password'}
) - string or object
;host
: hostname and port if exist (example: site_name.com:3333
, site_name.com
, localhost
) - string
;hostname
: hostname (example: site_name.com
) - string
;port
: port (example: 3333
) - string or number
;path
: full path with search and queries (with or without leading slash) (example: path/inner/page?ref=1&close=false
) - string
;pathname
: path without search and queries (with or without leading slash) (example: path/inner/page
) - string
;search
: part of path with leading question mark (with or without question mark) (example: ?ref=1&close=false
) - string
;query
: part of path with parameters (example: ref=1&close=false
, {ref: '1', close: 'false'}
) - string or object
;hash
: part of url with pound-sign (with or without pound-sign) (example: #g=where&a=find
, {g: 'where', a: 'find'}
) - string or object
;Additionaly:
protocol
and host
is good idea.host
exist hostname
and port
will not touch.path
exist pathname
, search
, query
will not touch.Example
import * as urlapi from 'urlapi';
let preparedObject = {
protocol: 'http',
auth: {
login : 'user',
password: 'password'
},
host: 'site_name.com:3333',
hostname: 'site_name.com',
port: 3333,
path: 'path/inner/page?ref=1&close=false',
pathname: 'path/inner/page',
search: '?ref=1&close=false',
query: {
ref: '1',
close: 'false'
},
hash: {
g: 'where',
a: 'find'
}
};
console.log(urlapi.serialize(preparedObject));
return -->
http://user:password@site_name.com:3333/path/inner/page?ref=1&close=false#g=where&a=find
Takes string and return object
Additionaly:
protocol
and host
is good idea.Example
import * as urlapi from 'urlapi';
let stringParse = 'http://user:password@site_name.com:3333/path/inner/page?ref=1&close=false#g=where&a=find';
console.log(urlapi.parse(stringParse));
return -->
{
protocol: 'http',
auth: {
login : 'user',
password: 'password'
},
host: 'site_name.com:3333',
hostname: 'site_name.com',
port: 3333,
path: 'path/inner/page?ref=1&close=false',
pathname: 'path/inner/page',
search: '?ref=1&close=false',
query: {
ref: '1',
close: 'false'
},
hash: {
g: 'where',
a: 'find'
}
}
You can find this documentation and a little bit more (example project with es2015 original code, tests and etc.) on GitHub.
FAQs
Url api for serialize from object to string and parse string to object
The npm package urlapi receives a total of 51 weekly downloads. As such, urlapi popularity was classified as not popular.
We found that urlapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.