re
/
enumer
forked from mirror/enumer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #23 from dmarkham/doc 

Doc updates around <Type>String(s string) Case Insensitive
This commit is contained in:
Dan Markham 2019-05-05 15:24:55 -07:00 committed by GitHub
parent e080e58c1e 14261a8f07
commit 2440b832e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -52,7 +52,7 @@ When Enumer is applied to a type, it will generate:
- Function `<Type>String(s string)`: returns the enum value from its string representation. This is useful - Function `<Type>String(s string)`: returns the enum value from its string representation. This is useful
when you need to read enum values from command line arguments, from a configuration file, or when you need to read enum values from command line arguments, from a configuration file, or
from a REST API request... In short, from those places where using the real enum value (an integer) would from a REST API request... In short, from those places where using the real enum value (an integer) would
be almost meaningless or hard to trace or use by a human. be almost meaningless or hard to trace or use by a human. `s` string is Case Insensitive.
- Function `<Type>Values()`: returns a slice with all the values of the enum - Function `<Type>Values()`: returns a slice with all the values of the enum
- Function `<Type>Strings()`: returns a slice with all the Strings of the enum - Function `<Type>Strings()`: returns a slice with all the Strings of the enum
- Method `IsA<Type>()`: returns true only if the current value is among the values of the enum. Useful for validations. - Method `IsA<Type>()`: returns true only if the current value is among the values of the enum. Useful for validations.
@ -124,7 +124,7 @@ var aspirinString string = Aspirin.String()
fmt.Println("I need ", Paracetamol) // Will print "I need Paracetamol" fmt.Println("I need ", Paracetamol) // Will print "I need Paracetamol"
// Convert a string with the enum name to the corresponding enum value // Convert a string with the enum name to the corresponding enum value
pill, err := PillString("Ibuprofen") pill, err := PillString("Ibuprofen") // "ibuprofen" will also work.
if err != nil { if err != nil {
fmt.Println("Unrecognized pill: ", err) fmt.Println("Unrecognized pill: ", err)
return return