Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mazeyqian/gurl
A Go library for URL manipulation and validation.
https://github.com/mazeyqian/gurl
go golang library manipulation package url
Last synced: 16 days ago
JSON representation
A Go library for URL manipulation and validation.
- Host: GitHub
- URL: https://github.com/mazeyqian/gurl
- Owner: mazeyqian
- License: mit
- Created: 2017-10-11T01:59:28.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-11-06T01:28:17.000Z (about 1 year ago)
- Last Synced: 2023-11-06T17:28:19.550Z (about 1 year ago)
- Topics: go, golang, library, manipulation, package, url
- Language: Go
- Homepage:
- Size: 226 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GURL: Go URL Manipulation Library
GURL is a Go library for URL manipulation and validation. It provides functions for getting and setting URL parameters, paths, hosts, and protocols, as well as checking URL validity and getting file types from URLs.
## Installation
To install GURL, execute the following command:
```bash
go get github.com/mazeyqian/gurl
```
## Usage
Here's a quick example of how to use GURL:
```go
package main
import (
"fmt"
"github.com/mazeyqian/gurl"
)
func main() {
result, err := gurl.GetQueryParam("http://example.com/?t1=1&t2=2", "t1")
if err != nil {
panic(err)
}
fmt.Println(result) // Output: "1"
}
```
## Functions
| Function | Parameter | Return Value | Description |
|----------|------------|--------------|-------------|
| `GetQueryParam` | `url, param string` | `string, error` | Get the value of a query parameter from a URL |
| `SetQueryParam` | `url, param, value string` | `string, error` | Set the value of a query parameter in a URL |
| `DelQueryParam` | `url, param string` | `string, error` | Delete a query parameter from a URL |
| `GetHashParam` | `url, param string` | `string, error` | Get the value of a query parameter from the URL fragment |
| `SetHashParam` | `url, param, value string` | `string, error` | Set the value of a query parameter in the URL fragment |
| `DelHashParam` | `url, param string` | `string, error` | Delete a query parameter from the URL fragment |
| `GetPath` | `url string` | `string, error` | Get the path from a URL |
| `SetPath` | `url, newPath string` | `string, error` | Set the path in a URL |
| `GetHost` | `url string` | `string, error` | Get the host from a URL |
| `SetHost` | `url, newHost string` | `string, error` | Set the host in a URL |
| `GetHostname` | `url string` | `string, error` | Get the hostname from a URL |
| `SetHostname` | `url, newHostname string` | `string, error` | Set the hostname in a URL |
| `GetProtocol` | `url string` | `string, error` | Get the protocol from a URL |
| `SetProtocol` | `url, newProtocol string` | `string, error` | Set the protocol in a URL |
| `CheckValid` | `url string` | `bool` | Check if a URL is valid |
| `CheckValidHttpUrl` | `url string` | `bool` | Check if a URL is valid and uses either the HTTP or HTTPS scheme |
| `GetUrlFileType` | `url string` | `string, error` | Get the file type of a URL |
## Examples
### Hash Parameters
The typical hash history mode URLs are like this: `https://example.com/path1#path2?p1=1&p2=2`.
```go
link := "https://example.com/path1#path2?p1=1&p2=2"
gurl.GetHashParam(link, "p1") // "1"
gurl.SetHashParam(link, "p1", "3") // "https://example.com/path1#path2?p1=3&p2=2"
gurl.DelHashParam(link, "p1") // "https://example.com/path1#path2?p2=2"
```
## Contributing
Contributions to GURL are welcome! Please submit a pull request or open an issue on [GitHub repository](https://github.com/mazeyqian/gurl).
## License
GURL is licensed under the MIT License. For more details, please refer to the LICENSE file in this repository.