key

Documentation

Overview

Package key provides the key implementation of the document.

Index

• Variables
• type Key
  • func (k Key) String() string
  • func (k Key) Validate() error

Variables

var (
	// ErrInvalidKey is returned when the key is invalid.
	ErrInvalidKey = errors.New("invalid key, key must be a slug with 4-120 characters")
)

Types

type Key

type Key string

Key represents a document key.

func (Key) String

func (k Key) String() string

String returns the string representation of the key.

func (Key) Validate

func (k Key) Validate() error

Validate checks whether the key is valid or not.