types

README

Types

This library offers a collection of commonly used data types in API contexts, ensuring correct marshalling, unmarshalling, and validation. By standardizing these types across all our API libraries, we aim to reduce redundancy, increase consistency, and enhance type safety.

Features

• Standardized Types: Tailored for API data interchange
• Validation: Built-in validation rules to ensure data integrity before processing or transmission.
• JSON Marshalling/Unmarshalling: Custom JSON handling for each type to handle special cases (e.g., ensuring email addresses are formatted correctly).
• Used Across go-api-libs: These types are employed by all API libraries within the go-api-libs organization for consistency.

Installation

To install the library, use the following command:

go get github.com/go-api-libs/types

Usage

When using any of the API libraries from the go-api-libs organization, you can trust that types in successful API responses are valid.

Beyond that, here's how you can use some types from this library:

package main

import (
	"fmt"

	"github.com/go-api-libs/types"
)

func main() {
	// Using Email type
	email := types.Email("user@example.com")
	if err := email.Validate(); err != nil {
		fmt.Println(err)
	} else {
		fmt.Println("Valid email address")
	}
}

Contributing

If you have any contributions to make, please submit a pull request or open an issue on the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Documentation

Index

• Variables
• type Email
  • func (e *Email) UnmarshalJSONV2(dec *jsontext.Decoder, _ json.Options) error
  • func (e Email) Validate() error

Variables

var ErrInvalidEmail = errors.New("invalid email")

ErrInvalidEmail is returned when an email is invalid.

Types

type Email

type Email string

Email is a string that represents an email address.

func (*Email) UnmarshalJSONV2

func (e *Email) UnmarshalJSONV2(dec *jsontext.Decoder, _ json.Options) error

func (Email) Validate

func (e Email) Validate() error

Validate checks if the email is valid.