docs: added enumName property (typeorm#5731)

Related to typeorm#5729
zaro · Jan 12, 2021 · b955cd3 · b955cd3
1 parent 7db84d8
commit b955cd3
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/docs/decorator-reference.md b/docs/decorator-reference.md
@@ -193,6 +193,7 @@ If `true`, MySQL automatically adds the `UNSIGNED` attribute to this column.
 * `collation: string` - Defines a column collation.
 * `enum: string[]|AnyEnum` - Used in `enum` column type to specify list of allowed enum values.
 You can specify array of values or specify a enum class.
+* `enumName: string` - A name for generated enum type. If not specified, TypeORM will generate a enum type from entity and column names - so it's neccessary if you intend to use the same enum type in different tables.
 * `asExpression: string` - Generated column expression. Used only in [MySQL](https://dev.mysql.com/doc/refman/5.7/en/create-table-generated-columns.html).
 * `generatedType: "VIRTUAL"|"STORED"` - Generated column type. Used only in [MySQL](https://dev.mysql.com/doc/refman/5.7/en/create-table-generated-columns.html).
 * `hstoreType: "object"|"string"` - Return type of `HSTORE` column. Returns value as string or as object. Used only in [Postgres](https://www.postgresql.org/docs/9.6/static/hstore.html).