UNPKG

url-params-helper

Version:

A helper for URL parameters/query strings.

github.com/alvinteh/url-params-helper

alvinteh/url-params-helper

55 lines (39 loc) • 2.06 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
url-params-helper ========= A JavaScript utility that allows for easy retrieval and manipulation of URL parameters. Usage ------- getParams( [pageURL] String indicating the URL to retrieve parameters from. Defaults to the current page URL. ) Returns an object dictionary with key value pairs of URL parameter names and values, or null if there are no URL parameters. getParam( param String indicating the URL parameter name. [, pageURL] String indicating the URL to retrieve parameters from. Defaults to the current page URL. ) Returns the value of the specified URL parameter, or null if it does not exist and/or is empty. buildQueryString( params Object with key value pairs of URL parameter names and values. ) Returns a query string with the specified URL parameters. Null-value parameters will be included in the returned query string, but undefined parameters will not. buildQueryStringURL( params Object with key value pairs of URL parameter names and values. [, pageURL] String indicating the URL to retrieve parameters from. Defaults to the current page URL. ) Returns a query string URL with the specified URL parameters. Null-value parameters will be included in the returned query string URL, but undefined parameters will not. removeParam( param String indicating the URL parameter name. [, pageURL] String indicating the URL to retrieve parameters from. Defaults to the current page URL. ) Returns a URL with the specified URL parameter removed. replaceParam( param, String indicating the URL parameter name. value Mixed value for the URL parameter. [, pageURL] String indicating the URL to retrieve parameters from. Defaults to the current page URL. ) Returns a URL with the specified URL parameter replaced. If the URL parameter does not already exist, it will be set. License ------- Copyright 2016 Alvin Teh. Licensed under the MIT license.