Skip to content

Commit 635788c

Browse files
authored
Update readme.md
1 parent 6087e8d commit 635788c

File tree

1 file changed

+60
-1
lines changed

1 file changed

+60
-1
lines changed

readme.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The `MakeDto` function receive an array of object with this schema:
2121
{
2222
name: String,
2323
serialize: String,
24-
type: 'Number' | 'String' | 'Date' | 'Boolean' | 'Enum' | 'Object',
24+
type: 'Number' | 'String' | 'Date' | 'Boolean' | 'Enum' | 'Object' | 'Array',
2525
required: Boolean
2626
}
2727
```
@@ -70,6 +70,65 @@ MakeDto([
7070
]
7171
```
7272
73+
74+
#### Array
75+
76+
For `Array` type you need to pass a `itemsType` prop. The `itemsType` specify what will be type of `array` that will be validated.
77+
78+
In case of using `Enum` or `Object` you need to pass as well the `enumOps` or `schema` prop too.
79+
80+
Eg-
81+
82+
```js
83+
MakeDto([
84+
{
85+
name: 'fields',
86+
serialize: 'fields',
87+
required: true,
88+
type: 'Array',
89+
itemsType: 'Number'
90+
}
91+
]
92+
```
93+
94+
or
95+
96+
97+
```js
98+
MakeDto([
99+
{
100+
name: 'fields',
101+
serialize: 'fields',
102+
required: true,
103+
type: 'Array',
104+
itemsType: 'Enum',
105+
enumOps: ['accepted', 'nullable']
106+
}
107+
]
108+
```
109+
110+
or
111+
112+
```js
113+
MakeDto([
114+
{
115+
name: 'fields',
116+
serialize: 'fields',
117+
required: true,
118+
type: 'Array',
119+
itemsType: 'Object',
120+
schema: [
121+
{
122+
name: 'StatusCode',
123+
serialize: 'status_code',
124+
required: true,
125+
type: 'Number'
126+
}
127+
]
128+
}
129+
]
130+
```
131+
73132
## Name
74133
75134
The `name` field is what key on object or array you will send. Eg. `{ fullName: 'Acidiney Dias' }`

0 commit comments

Comments
 (0)