Quark v1.2.0 Documentation

quark/path
- Class: URL
- default

quark/path #

Class: URL #

URL #

URL Processing Tool Type

For example:

// cwd: file:///var/data
// Prints: file:///var/data/index.js
var uri = new URL('index.js');
console.log(uri.href);
// Prints: http://quarks.cc/index.html?args=0
var uri2 = new URL('[`http://quarks.cc/home/../index.html?args=0`](http://quarks.cc/home/../index.html?args=0)')
console.log(uri2.href);
// Prints: 
// Error: Parse uri error, Illegal URL
new URL('[`http://quarks.cc:`](http://quarks.cc:)').href

url.constructor(path?) #

@param path?: string

url.href #

Get the complete URL, including parameters
href: "http://xxxx.xxx:81/v1.1.0/quark/path.js?sasasas&asasasa#sdsdsd"

@get href: string

For example:

// Prints: http://quarks.cc/
console.log(new URL('[`http://quarks.cc/`](http://quarks.cc/)').href);

url.filename #

Get full path name
filename: "/D:/Documents/test.js"

@get filename: string

For example:

// Prints: /aaa/bbbb/ccc/test.js
console.log(new URL('[`http://quarks.cc/aaa/bbbb/ccc/test.js`](http://quarks.cc/aaa/bbbb/ccc/test.js)').filename);

url.path #

@get path: string /a/b/s/test.html?aaaaa=100

For example:

// Prints: /aaa/bbbb/ccc/test.js?asas=asas
console.log(new URL('[`http://quarks.cc/aaa/bbbb/ccc/test.js?asas=asas`](http://quarks.cc/aaa/bbbb/ccc/test.js?asas=asas)').path);

url.dirname #

Full path dir
dirname: "/D:/Documents"

@get dirname: string

For example:

// Prints: /aaa/bbbb/ccc
console.log(new URL('[`http://quarks.cc/aaa/bbbb/ccc/test.js`](http://quarks.cc/aaa/bbbb/ccc/test.js)').dirname);

url.search #

Get url query parameters
search: "?sasasas&asasasa"

@get search: string

For example:

// Prints: ?a=A&b=B
console.log(new URL('[`http://quarks.cc/?a=A&b=B`](http://quarks.cc/?a=A&b=B)').search);

url.hash #

hash: "#sdsdsd"
Get hash parameters

@get hash: string

For example:

// Prints: #c=C&d=D
console.log(new URL('[`http://quarks.cc/?a=A&b=B#c=C&d=D`](http://quarks.cc/?a=A&b=B#c=C&d=D)').hash);

url.host #

host: "quarks.cc:81"
Gets the host name and returns the host name with the port number

@get host: string

For example:

// Prints: quarks.cc:80
console.log(new URL('[`http://quarks.cc:81/`](http://quarks.cc:81/)').host);

url.hostname #

hostname: "quarks.cc"
Gets the host name, but does not return the port number

@get hostname: string

For example:

// Prints: quarks.cc
console.log(new URL('[`http://quarks.cc:81/`](http://quarks.cc:81/)').host);

url.origin #

origin: "http://quarks.cc:81"
Get the uri origin, protocol+host

@get origin: string

For example:

// Prints: http://quarks.cc:81
console.log(new URL('[`http://quarks.cc:81/host/index.html`](http://quarks.cc:81/host/index.html)').host);
// Prints: file://
console.log(new URL('file:///var/data/index.html').host);

url.basename #

Get path base name

@get basename: string

For example:

// Prints: index.html
console.log(new URL('file:///var/data/index.html').basename);

url.extname #

Get path extname

@get extname: string

For example:

// Prints: .html
console.log(new URL('file:///var/data/index.html').extname);

url.port #

port: "81"
Get the host port number.
If the port number is not defined in the URL, an empty string is returned.

@get port: string

For example:

// Prints: 81
console.log(new URL('[`http://quarks.cc:81`](http://quarks.cc:81)').port);
// Prints If there is no port number, an empty string will be returned: ""
console.log(new URL('[`http://quarks.cc`](http://quarks.cc)').port);

url.protocol #

Get the protocol type string of the URL, For: 'http:'|'https'|'ftp:'

@get protocol: string

url.params #

Returns a collection of query parameters as an object, or set

@get params: Dict<string>

For example:

// Prints:
// {
//   a: "100",
//   b: "test"
// }
console.log(new URL('[`http://quarks.cc/?a=100&b=test`](http://quarks.cc/?a=100&b=test)').params);

url.hashParams #

Returns a Hash parameter set as an object, or set

@get hashParams: Dict<string>

For example:

// Prints:
// {
//   a: "200",
//   b: "300"
// }
console.log(new URL('[`http://quarks.cc/#a=200&b=300`](http://quarks.cc/#a=200&b=300)').hashParams);

url.getParam(name) #

Get path param

For example:

// Prints: ok
console.log(new URL('[`http://quarks.cc/?args=ok`](http://quarks.cc/?args=ok)').getParam('args'));

@param name: string
@return string

url.setParam(name,value) #

Set the URL query parameter key-value pair and return self

@param name: string
@param value: string
@return this

url.deleteParam(name) #

Remove URL query parameters by name

@param name: string
@return this

url.clearParams() #

Delete all of params in the URL

@return this

url.getHash(name) #

Get hash param by name

@param name: string
@return string

url.setHash(name,value) #

Set hash param by the key/value

@param name: string
@param value: string
@return this

url.deleteHash(name) #

Delete hash param by the name

@param name: string
@return this

url.clearHashs() #

Delete all of hash params in the URL

@return this

url.relative(fromPath) #

Get relative path from the fromPath to self

For example:

// Prints: ../A/B/C/test.js
var url = new URL('[`http://quarks.cc/A/B/C/test.js`](http://quarks.cc/A/B/C/test.js)');
console.log(url.relative('[`http://quarks.cc/home/`](http://quarks.cc/home/)'));
// Prints: file:///var/data/A/B/C/test.js
var url2 = new URL('file:///var/data/A/B/C/test.js');
console.log(url2.relative('[`http://quarks.cc/home/`](http://quarks.cc/home/)'));

@param fromPath: string
@return string

url.toJSON() #

@return string

default #

default.executable()string #

Get the binary executable file path of the current application

For example:

// Prints:
// file:///var/containers/Bundle/Application/4F1BD659-601D-4932-8484-D0D1F978F0BE/test.app/test
console.log(path.executable());

@return string

default.documents(path?) #

Get the document storage path of the current application

@param path?: string Append to the document path

For example:

// Prints:
// file:///var/mobile/Containers/Data/Application/89A576FE-7BB9-4F26-A456-E9D7F8AD053D/Documents
console.log(path.documents());
// Prints Setting the result of appending path parameters:
// file:///var/mobile/Containers/Data/Application/89A576FE-7BB9-4F26-A456-E9D7F8AD053D/Documents/aa.jpeg
console.log(path.documents('aa.jpeg'));

@return string

default.temp(path?) #

Get the application temporary directory

@param path?: string
@return string

default.resources(path?) #

Get the application resource directory

@param path?: string
@return string

default.cwd()string #

Get the current working directory

@return string

default.chdir(path) #

Set the current working directory and return true if successful

@param path: string
@return boolean

default.normalizePath(path,retain_up?) #

Format part path to normalize path

@param path: string
@param retain_up?: boolean
@return string

default.classicPath(path) #

Restore the path to a path that the operating system can recognize.
Generally, you do not need to call this function unless you directly call
a Native/C/C++ function that is not provided by Quark

For example:

// Prints: /var/data/test.js
console.log(path.normalizePath('file:///var/data/test.js'));

@param path: string
@return string

default.resolve(path,partPath?string) #

Format path to standard absolute path

For example:

// Prints: http://quarks.cc/A/C/test.js
console.log(path.resolve('[`http://quarks.cc/home`](http://quarks.cc/home)', "..", "A", "B", "..", "C", "test.js"));
// Prints: 
// true
// file:///var/data/aaa/cc/ddd/kk.jpg
console.log(path.chdir('/var/data'));
console.log(path.resolve('aaa/bbb/../cc/.//!<ddd/kk.jpg'));

@param path: string
@param partPath?string:
@return string

default.isAbsolute(path) #

Test whether it is an absolute path

For example:

// Prints:
// true
// true
// false
console.log(path.isAbsolute('/var/kk'));
console.log(path.isAbsolute('[`http://quarks.cc/`](http://quarks.cc/)'));
console.log(path.isAbsolute('index.jsx'));

@param path: string
@return boolean

default.basename(path?) #

Get basename

@param path?: string
@return string

default.dirname(path?) #

Get dirname

@param path?: string
@return string

default.extname(path?) #

Get extname

@param path?: string
@return string

default.filename(path?) #

Get filename

@param path?: string
@return string

default.path(path?) #

Get path

@param path?: string
@return string

default.search(path?) #

Get search

@param path?: string
@return string

default.hash(path?) #

Get hash

@param path?: string
@return string

default.host(path?) #

Get host

@param path?: string
@return string

default.hostname(path?) #

Get hostname

@param path?: string
@return string

default.origin(path?) #

Get origin

@param path?: string
@return string

default.port(path?) #

Get port: "81"

@param path?: string
@return string

default.protocol(path?) #

Get protocol: "http:"

@param path?: string
@return string

default.params(path?) #

Get params

@param path?: string
@return Dict<string>

default.hashParams(path?) #

Get params

@param path?: string
@return Dict<string>

default.getParam(name,path?) #

Get path param

@param name: string
@param path?: string
@return string

default.setParam(name,value,path?) #

Set path param

@param name: string
@param value: string
@param path?: string
@return string

default.deleteParam(name,path?) #

Delete path param

@param name: string
@param path?: string
@return string

default.clearParams(path?) #

Delete all of hash params

@param path?: string
@return string

default.getHash(name,path?) #

Get hash param

@param name: string
@param path?: string
@return string

default.setHash(name,value,path?) #

Set hash param

@param name: string
@param value: string
@param path?: string
@return string

default.deleteHash(name,path?) #

Delete hash param

@param name: string
@param path?: string
@return string

default.clearHashs(path?) #

Delete all of hash params

@param path?: string
@return string

default.relative(from,target?) #

Get relative path

@param from: string
@param target?: string
@return string

Quark #

Modules #

Table of Contents

quark/path #

Class: URL #

URL #

url.constructor(path?) #

url.href #

url.filename #

url.path #

url.dirname #

url.search #

url.hash #

url.host #

url.hostname #

url.origin #

url.basename #

url.extname #

url.port #

url.protocol #

url.params #

url.hashParams #

url.getParam(name) #

url.setParam(name,value) #

url.deleteParam(name) #

url.clearParams() #

url.getHash(name) #

url.setHash(name,value) #

url.deleteHash(name) #

url.clearHashs() #

url.relative(fromPath) #

url.toJSON() #

default #

default.executable()string #

default.documents(path?) #

default.temp(path?) #

default.resources(path?) #

default.cwd()string #

default.chdir(path) #

default.normalizePath(path,retain_up?) #

default.classicPath(path) #

default.resolve(path,partPath?string) #

default.isAbsolute(path) #

default.basename(path?) #

default.dirname(path?) #

default.extname(path?) #

default.filename(path?) #

default.path(path?) #

default.search(path?) #

default.hash(path?) #

default.host(path?) #

default.hostname(path?) #

default.origin(path?) #

default.port(path?) #

default.protocol(path?) #

default.params(path?) #

default.hashParams(path?) #

default.getParam(name,path?) #

default.setParam(name,value,path?) #

default.deleteParam(name,path?) #

default.clearParams(path?) #

default.getHash(name,path?) #

default.setHash(name,value,path?) #

default.deleteHash(name,path?) #

default.clearHashs(path?) #

default.relative(from,target?) #

`Quark` #