README

syllables Build Status codecov GoDoc

Go port of the JavaScript syllable counter at https://github.com/wooorm/syllable

Install

go get "github.com/mtso/syllables"

Example

Example usage of syllables.In(string) int:

package main

import (
	"fmt"
	"github.com/mtso/syllables"
)

func main() {
	text := "The quick brown fox jumps over the lazy dog."
	syllableCount := syllables.In(text)
	fmt.Printf("There are %v syllables in %q\n", syllableCount, text)
	// Output: There are 11 syllables in "The quick brown fox jumps over the lazy dog."
}

Documentation

Overview

    Package syllables provides a Go implementation of the syllable counter from `github.com/wooorm/syllable`

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func In

    func In(text string) int

      Returns the integer count of syllables in the input string.

      func InBytes

      func InBytes(b []byte) int

        Returns the integer count of syllables in the input byte array.

        Types

        This section is empty.