henchman v0.3.0 Henchman.String

Additional string functionalities.

Summary

Functions

Get the acronym from a string

Determine if string contains alphabets only

Determine if string contains alphabets and integers

Determine if string is blank

Convert string to camel case

Limit characters within a string

Determine if string contains lower case characters only

Determine if string contains integers only

Convert string to slug format

Convert string to snake case

Convert string to studly case

Capitalize the first letter in a string

Determine if string contains upper case characters only

Functions

acronym(value)

Get the acronym from a string.

Example

iex> Henchman.String.acronym("foo bar") //"FB"
alpha?(value)

Specs

alpha?(String.t) :: String.t

Determine if string contains alphabets only.

Example

iex> Henchman.String.alpha?("ABCdef")#true
alphanumeric?(value)

Specs

alphanumeric?(String.t) :: String.t

Determine if string contains alphabets and integers.

Example

iex> Henchman.String.alphanumeric?("ABCdef123")#true
blank?(value)

Specs

blank?(String.t) :: String.t

Determine if string is blank.

Example

iex> Henchman.String.blank?("")#true
camel_case(value)

Specs

camel_case(String.t) :: String.t

Convert string to camel case.

Example

iex> Henchman.String.camel_case("foo-bar")#fooBar
limit(value, length \\ 100, suffix \\ "...")

Specs

limit(String.t, pos_integer, String.t) :: String.t

Limit characters within a string.

Example

iex> Henchman.String.limit("Foo bar baz", 7)#Foo bar...
lowercased?(value)

Specs

lowercased?(String.t) :: String.t

Determine if string contains lower case characters only.

Example

iex> Henchman.String.lowercased?("def")#true
numeric?(value)

Specs

numeric?(String.t) :: String.t

Determine if string contains integers only.

Example

iex> Henchman.String.numeric?("123")#true
slug(value, delimiter \\ "-")

Specs

Convert string to slug format.

Example

iex>Henchman.String.slug("foo Bar")#foo-bar
snake_case(value, delimiter \\ "_")

Specs

snake_case(String.t, String.t) :: String.t

Convert string to snake case.

Example

iex> Henchman.String.snake_case("FooBar")#foo_bar
studly_case(value)

Specs

studly_case(String.t) :: String.t

Convert string to studly case.

Example

iex> Henchman.String.studly_case("foo-bar")#FooBar
title_case(value)

Specs

title_case(String.t) :: String.t

Capitalize the first letter in a string.

Example

iex> Henchman.String.title_case("Foo bar-baz")#Foo Bar-baz
uppercased?(value)

Specs

uppercased?(String.t) :: String.t

Determine if string contains upper case characters only.

Example

iex> Henchman.String.uppercased?("ABC")#true
word_limit(value, limit \\ 100, suffix \\ "...")

Specs

word_limit(String.t, pos_integer, String.t) :: String.t

Limit words within a string.

Example

iex> Henchman.String.word_limit("Foo bar baz", 1)#Foo...