Enums
Complete reference for all enumerations provided by NestJS CRUD Automator.
Route and Function Types
EApiRouteType
Available CRUD route types.
enum EApiRouteType {
CREATE = "create",
DELETE = "delete",
GET = "get",
GET_LIST = "getList",
PARTIAL_UPDATE = "partialUpdate",
UPDATE = "update",
}
Related:
EApiFunctionType
Available CRUD function types.
enum EApiFunctionType {
CREATE = "create",
DELETE = "delete",
GET = "get",
GET_LIST = "getList",
GET_MANY = "getMany",
UPDATE = "update",
}
Property Types
EApiPropertyDescribeType
Property types for entity fields.
enum EApiPropertyDescribeType {
UUID = "uuid",
STRING = "string",
NUMBER = "number",
BOOLEAN = "boolean",
DATE = "date",
ENUM = "enum",
OBJECT = "object",
RELATION = "relation",
}
Related:
EApiPropertyStringType
String format types.
enum EApiPropertyStringType {
STRING = "string",
EMAIL = "email",
URL = "url",
PASSWORD = "password",
}
EApiPropertyNumberType
Number format types.
enum EApiPropertyNumberType {
INTEGER = "integer",
FLOAT = "float",
}
EApiPropertyDateType
Date format types.
enum EApiPropertyDateType {
DATE = "date",
DATE_TIME = "date-time",
TIME = "time",
}
EApiPropertyDateIdentifier
Date field identifiers.
enum EApiPropertyDateIdentifier {
CREATED_AT = "createdAt",
UPDATED_AT = "updatedAt",
DELETED_AT = "deletedAt",
}
Filter Operations
EFilterOperation
All available filter operations.
enum EFilterOperation {
BETWEEN = "between",
CONT = "cont",
CONTL = "contl",
ENDS = "ends",
ENDSL = "endsl",
EQ = "eq",
EQL = "eql",
EXCL = "excl",
EXCLL = "excll",
GT = "gt",
GTE = "gte",
IN = "in",
INL = "inl",
ISNULL = "isnull",
LT = "lt",
LTE = "lte",
NE = "ne",
NEL = "nel",
NOTIN = "notin",
NOTINL = "notinl",
NOTNULL = "notnull",
STARTS = "starts",
STARTSL = "startsl",
}
Type-Specific Operations:
EFilterOperationString
enum EFilterOperationString {
CONT = "cont", // Contains
CONTL = "contl", // Contains (case-insensitive)
ENDS = "ends", // Ends with
ENDSL = "endsl", // Ends with (case-insensitive)
EQ = "eq", // Equals
EQL = "eql", // Equals (case-insensitive)
IN = "in", // In array
INL = "inl", // In array (case-insensitive)
ISNULL = "isnull", // Is null
NE = "ne", // Not equals
NEL = "nel", // Not equals (case-insensitive)
NOTIN = "notin", // Not in array
NOTINL = "notinl", // Not in array (case-insensitive)
NOTNULL = "notnull", // Is not null
STARTS = "starts", // Starts with
STARTSL = "startsl", // Starts with (case-insensitive)
}
EFilterOperationNumber
enum EFilterOperationNumber {
BETWEEN = "between", // Between two values
EQ = "eq", // Equals
GT = "gt", // Greater than
GTE = "gte", // Greater than or equal
IN = "in", // In array
ISNULL = "isnull", // Is null
LT = "lt", // Less than
LTE = "lte", // Less than or equal
NE = "ne", // Not equals
NOTIN = "notin", // Not in array
NOTNULL = "notnull", // Is not null
}
EFilterOperationDate
enum EFilterOperationDate {
BETWEEN = "between",
EQ = "eq",
GT = "gt",
GTE = "gte",
ISNULL = "isnull",
LT = "lt",
LTE = "lte",
NE = "ne",
NOTNULL = "notnull",
}
EFilterOperationBoolean
enum EFilterOperationBoolean {
EQ = "eq",
EXCL = "excl",
IN = "in",
ISNULL = "isnull",
NE = "ne",
NOTIN = "notin",
NOTNULL = "notnull",
}
EFilterOperationEnum
enum EFilterOperationEnum {
EQ = "eq",
IN = "in",
ISNULL = "isnull",
NE = "ne",
NOTIN = "notin",
NOTNULL = "notnull",
}
EFilterOperationUuid
enum EFilterOperationUuid {
EQ = "eq",
ISNULL = "isnull",
NE = "ne",
NOTNULL = "notnull",
}
Related:
EFilterOrderDirection
Sort order directions.
enum EFilterOrderDirection {
ASC = "ASC",
DESC = "DESC",
}
Controller Configuration Enums
EApiDtoType
DTO types for requests and responses.
enum EApiDtoType {
BODY = "body",
QUERY = "query",
PARAM = "param",
RESPONSE = "response",
}
EApiControllerRequestTransformerType
Request transformer types.
enum EApiControllerRequestTransformerType {
STATIC = "static",
DYNAMIC = "dynamic",
}
Related:
EApiControllerLoadRelationsStrategy
Relation loading strategies.
enum EApiControllerLoadRelationsStrategy {
AUTO = "auto",
MANUAL = "manual",
}
Related:
Subscriber Enums
EApiSubscriberOnType
Subscriber hook timing.
enum EApiSubscriberOnType {
BEFORE = "before",
AFTER = "after",
ERROR = "error",
}
Next Steps
- Decorators - Decorator usage with enums
- Guides - Filtering and Sorting - Filter operations usage
- Guides - Transformers - Transformer types usage
Last updated on