Object UrlObject

Url processing object

Basic module. Provide url formatting, parsing and assembly

1
2
3
4
5
6
var url = new net.Url('http://www.xici.net/');
var url = new net.Url({
    protocol: 'http:',
    hostname: 'www.xici.net',
    pathname: '/'
});

Inheritance

Constructor

UrlObject

UrlObject object constructor, using parameter construction

1
new UrlObject(Object args);

Call parameters:

• args : Object, a dictionary object specifying construction parameters, supported fields are: protocol, slashes, username, password, hostname, port, pathname, query, hash

UrlObject object constructor, using url string construction

1
2
3
new UrlObject(String url = "",
    Boolean parseQueryString = false,
    Boolean slashesDenoteHost = false);

Call parameters:

• url : String, specifies the url string
• parseQueryString : Boolean, specify whether to parse the query
• slashesDenoteHost : Boolean, default is false, if set to true, the string from after the string'//' to the next'/' will be parsed as host, for example,'//foo/bar', the result should be {host:'foo', pathname:'/bar'} instead of {pathname:'//foo/bar'}

Member attributes

href

String, query and set the complete url address description in the current UrlObject object, this description is assembled from all other attributes

1
String UrlObject.href;

protocol

String, query and set the protocol name in the current UrlObject object

1
String UrlObject.protocol;

slashes

Boolean, query and set whether the current UrlObject object contains double slashes

1
Boolean UrlObject.slashes;

auth

String, query and set the complete verification string in the current UrlObject object, assembled by username and password attributes

1
String UrlObject.auth;

username

String, query and set the authenticated user in the current UrlObject object

1
String UrlObject.username;

password

String, query and set the authentication password in the current UrlObject object

1
String UrlObject.password;

host

String, query and set the complete host description in the current UrlObject object, assembled by hasname and port

1
String UrlObject.host;

hostname

String, query and set the host name in the current UrlObject object

1
String UrlObject.hostname;

port

String, query and set the port number in the current UrlObject object

1
String UrlObject.port;

path

String, query and set the full path of the request in the current UrlObject object (including the request), assembled by pathname and query

1
String UrlObject.path;

pathname

String, query and set the path in the current UrlObject object

1
String UrlObject.pathname;

search

String, query and set the request string (including "?") in the current UrlObject object, which is equivalent to "?"+query

1
String UrlObject.search;

query

Value, query and set the request string in the current UrlObject object (without "?")

1
Value UrlObject.query;

hash

String, query and set the request anchor point in the current UrlObject object (including "#")

1
String UrlObject.hash;

searchParams

HttpCollection , query the request string in the current UrlObject object (without "?")

1
readonly HttpCollection UrlObject.searchParams;

Member function

parse

Parse a url string

1
2
3
UrlObject.parse(String url,
    Boolean parseQueryString = false,
    Boolean slashesDenoteHost = false);

Call parameters:

• url : String, specify the url string to be parsed
• parseQueryString : Boolean, specify whether to parse the query
• slashesDenoteHost : Boolean, default is false, if set to true, the string from after the string'//' to the next'/' will be parsed as host, for example,'//foo/bar', the result should be {host:'foo', pathname:'/bar'} instead of {pathname:'//foo/bar'}

format

Construct UrlObject with specified parameters

1
UrlObject.format(Object args);

Call parameters:

• args : Object, a dictionary object specifying construction parameters, supported fields are: protocol, slashes, username, password, hostname, port, pathname, query, hash

resolve

url path, automatically recognize whether the new path is a relative path or an absolute path

1
UrlObject UrlObject.resolve(String url);

Call parameters:

• url : String, specify the new path

Return result:

• UrlObject , returns an object containing relocation data

normalize

Standardized path

1
UrlObject.normalize();

toString

Returns the string representation of the object, generally returns "[Native Object]", the object can be re-implemented according to its own characteristics

1
String UrlObject.toString();

Return result:

• String , returns the string representation of the object

toJSON

Returns the JSON format representation of the object, generally returns a collection of readable attributes defined by the object

1
Value UrlObject.toJSON(String key = "");

Call parameters:

• key : String, unused

Return result:

• Value , returns a value containing JSON serializable