slug

README

slug

Support

Please consider donating at PayPal: https://www.paypal.me/jismithpp

Example

package main

import (
	"fmt"

	slug "github.com/theTardigrade/golang-slug"
)

func main() {
	s := slug.GetWithOptions("!=this is a test=!", &slug.Options{
		MaxLen:        12,
		Replacement:   "_",
		RunesToRemove: []rune{'=', '!'},
	})

	fmt.Println(s) // prints "this_is_a_te"
}

Documentation

Index

• Variables
• func Get(text string) (slug string)
• func GetWithOptions(text string, options *Options) (slug string)
• type Options

Variables

var (
	DefaultOptions = Options{
		MaxLen:        defaultOptionsMaxLen,
		Replacement:   defaultOptionsReplacement,
		RunesToRemove: defaultOptionsRunesToRemove(),
	}
)

Functions

func Get

func Get(text string) (slug string)

func GetWithOptions

func GetWithOptions(text string, options *Options) (slug string)

Types

type Options

type Options struct {
	MaxLen        int
	Replacement   string
	RunesToRemove []rune
}