hawqal

README

Hawqal-Go

The Golang package that contains the data of world's countries,states and their cities name.This package provide you to get the data of countries, cities & states

Functions

• Get Countries
• Get States
• Get Cities

Get Started

To install the Hawqal-go package, use the following command:

go get github.com/CapregSoft/Hawqal-go

Features/Example

For more information, additional examples and functionality, see the Hawqal Documentation.

Language

• Golang 1.18

Authors

• Capregsoft
• Ahmed Saleem

Additional Resources

• Changelog
• Code of Conduct
• Collaborator Guide
• Contribution Guidelines

I hope this will help you! Let me know if you have any further queries!

Documentation

Index

• func CheckError(err error)
• func GetCities(choice ...*models.CityFilter) ([]byte, error)
• func GetCity(CityName string, choice ...*models.CityFilter) ([]byte, error)
• func GetCountries(choice ...*models.CountryFilter) ([]byte, error)
• func GetCountry(country_name string, choice ...*models.CountryFilter) ([]byte, error)
• func GetState(state_name string, choice ...*models.StateFilter) ([]byte, error)
• func GetStates(choice ...*models.StateFilter) ([]byte, error)

Functions

func CheckError

func CheckError(err error)

Function to Check Error

func GetCities

func GetCities(choice ...*models.CityFilter) ([]byte, error)

func GetCity

func GetCity(CityName string, choice ...*models.CityFilter) ([]byte, error)

func GetCountries

func GetCountries(choice ...*models.CountryFilter) ([]byte, error)

GetCountriesData retreives the data from Database module and return as a []byte after marshling into a json format

func GetCountry

func GetCountry(country_name string, choice ...*models.CountryFilter) ([]byte, error)

func GetState

func GetState(state_name string, choice ...*models.StateFilter) ([]byte, error)

func GetStates

func GetStates(choice ...*models.StateFilter) ([]byte, error)