diff --git a/docs/config.toml b/docs/config.toml index 6a858b3c..7af83ed7 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -14,6 +14,7 @@ ga = "UA-12613282-7" "/docs/objecttypes/", "/docs/mutations/", "/docs/basic-types/", + "/docs/enums/", "/docs/relay/", ] diff --git a/docs/pages/docs/enums.md b/docs/pages/docs/enums.md new file mode 100644 index 00000000..6878d610 --- /dev/null +++ b/docs/pages/docs/enums.md @@ -0,0 +1,33 @@ +--- +title: Enums +description: Walkthrough Enums +--- + +# Enums + +A `Enum` is a special `GraphQL` type that represents a set of symbolic names (members) bound to unique, constant values. + +## Enum definition + +You can create an `Enum` using classes: + +```python +import graphene + +class Episode(graphene.Enum): + NEWHOPE = 4 + EMPIRE = 5 + JEDI = 6 +``` + +But also using instances of Enum: + +```python +Episode = graphene.Enum('Episode', [('NEWHOPE', 4), ('EMPIRE', 5), ('JEDI', 6)]) +``` + +## Notes + +Internally, `graphene.Enum` uses [`enum.Enum`](https://docs.python.org/3/library/enum.html) Python implementation if available, or a backport if not. + +So you can use it in the same way as you would do with Python `enum.Enum`.