redirects

Documentation

Overview

Package redirects provides functions for parsing and rewriting URLs according to Netlify style _redirects syntax

Index

• Constants
• Variables
• func SetConfig(redirectsConfig config.Redirects)
• type Redirects
  • func ParseRedirects(ctx context.Context, root vfs.Root) *Redirects
  • func (r *Redirects) Rewrite(originalURL *url.URL) (*url.URL, int, error)
  • func (r *Redirects) Status() string

Constants

const (
	// ConfigFile is the default name of the file containing the redirect rules.
	// It follows Netlify's syntax but we don't support all of the special options yet
	//  - https://docs.netlify.com/routing/redirects/
	//  - https://docs.netlify.com/routing/redirects/redirect-options/
	ConfigFile = "_redirects"
)

Variables

var (

	// ErrNoRedirect is the error thrown when a no redirect rule matches while trying to Rewrite URL.
	// This means that no redirect applies to the URL and you can fallback to serving actual content instead.
	ErrNoRedirect = errors.New("no redirect found")
)

Functions

func SetConfig

func SetConfig(redirectsConfig config.Redirects)

Types

type Redirects

type Redirects struct {
	// contains filtered or unexported fields
}

func ParseRedirects

func ParseRedirects(ctx context.Context, root vfs.Root) *Redirects

ParseRedirects decodes Netlify style redirects from the projects `.../public/_redirects` https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file

func (*Redirects) Rewrite

func (r *Redirects) Rewrite(originalURL *url.URL) (*url.URL, int, error)

Rewrite takes in a URL and uses the parsed Netlify rules to rewrite the URL to the new location if it matches any rule

func (*Redirects) Status

func (r *Redirects) Status() string

Status maps over each redirect rule and returns any error message