Implement IsArray decorator recipe #17
Conversation
- Adds `IsArray` decorator recipe - Incorporates recipe into existing flavors - Normalizes some options parameters (breaking change)
| @@ -134,6 +154,20 @@ Object { | |||
| "nullable": true, | |||
| "type": "number", | |||
| }, | |||
| "nullableObjectArrayValue": Object { | |||
| "items": Object { | |||
There was a problem hiding this comment.
Notice that we are correctly producing JSON Schema types with items, both with a $ref (here) and a primitive (next).
| @@ -51,6 +52,16 @@ export function createFixtures( | |||
| class Example { | |||
| /* Create one property of each type that is required. */ | |||
|
|
|||
| @IsArray({ | |||
There was a problem hiding this comment.
It's important to have examples using primitive and object types because these are handled differently.
| requiredObjectArrayValue!: NestedRequiredExample[]; | ||
|
|
||
| @IsArray({ | ||
| type: Number, |
There was a problem hiding this comment.
There's no nice way to skip the type argument here and trying to compose @IsArray with IsNumber is an engineering challenge, especially since I didn't plan for it.
| @@ -69,7 +80,7 @@ export function createFixtures( | |||
| requiredIntegerValue!: number; | |||
|
|
|||
| @IsNested({ | |||
| nested: NestedRequiredExample, | |||
| type: NestedRequiredExample, | |||
There was a problem hiding this comment.
For consistency, I'm now using type instead of nested. This is a break change, but since there's very little usage so far, I think it's ok.
|
|
||
| export interface ArrayOptions { | ||
| type: Constructor, | ||
| maxItems?: number, |
There was a problem hiding this comment.
I added min/max for array size.
| @@ -1,4 +1,4 @@ | |||
| export interface IntegerOptions { | |||
| maximum?: number, | |||
| minimum?: number, | |||
| maxValue?: number, | |||
There was a problem hiding this comment.
I renamed these options to be consistent with minItems/minLength. I'm a little torn here because the minimum/maximum naming is what OpenAPI uses, but I actually got a bit confused during this PR and found that using minFoo was clearer.
minLength=> string lengthminItems=> array sizeminValue=> numeric magnitude
| optional?: boolean, | ||
| type?: string, | ||
| type?: string | Constructor | Constructor[], |
There was a problem hiding this comment.
I'm starting to realize the the mixin options should probably not be combined with the recipe options - we currently defined the recipes as accepting MixinOptions & RecipeOptions. I will probably revisit this soon that, for example, you can't pass maxLength (for strings) to the array decorator.
| import { Constructor } from '../constructor'; | ||
|
|
||
| export interface ArrayOptions { | ||
| type: Constructor, |
There was a problem hiding this comment.
I like that type is required.
IsArraydecorator recipe