url
The url module provides functionality for the parsing and retrieving of URLs.
API Reference
Classes
URL
Constructors
URL(source, base)
The URL constructor creates an object that represents a URL, verifying that
the provided string is a valid URL in the process. Any API in the SDK which
has a URL parameter will accept URL objects, not raw strings, unless
otherwise noted.
source : string
A string to be converted into a URL. If source is not a valid URI, this
constructor will throw an exception.
[ base : string ]
An optional string used to resolve relative source URLs into absolute ones.
Methods
toString()
Returns a string representation of the URL.
Returns: string
The URL as a string.
Properties
scheme : string
The name of the protocol in the URL.
userPass : string
The username:password part of the URL, null if not present.
host : string
The host of the URL, null if not present.
port : integer
The port number of the URL, null if none was specified.
path : string
The path component of the URL.
DataURL
Constructors
DataURL(uri)
The DataURL constructor creates an object that represents a data: URL, verifying that the provided string is a valid data: URL in the process.
uri : string
A string to be parsed as Data URL. If is not a valid URI, this constructor will throw an exception.
Methods
toString()
Returns a string representation of the Data URL.
If base64 is true, the data property is encoded using base-64 encoding.
Returns: string
The URL as a string.
Properties
mimeType : string
The MIME type of the data. By default is an empty string.
parameters : object
An hashmap that contains the parameters of the Data URL. By default is an empty object.
base64 : boolean
Defines the encoding for the value in data property.
data : string
The string that contains the data in the Data URL.
If the uri given to the constructor contains base64 parameter, this string is decoded.
Functions
toFilename(url)
Attempts to convert the given URL to a native file path. This function will
automatically attempt to resolve non-file protocols, such as the resource:
protocol, to their place on the file system. An exception is raised if the URL
can't be converted; otherwise, the native file path is returned as a string.
url : string
The URL, as a string, to be converted.
Returns: string
The converted native file path as a string.
fromFilename(path)
Converts the given native file path to a file: URL.
path : string
The native file path, as a string, to be converted.
Returns: string
The converted URL as a string.
