horiuchi / dtsgenerator / 391

391

Pull #239

travis-ci

web-flow 
feat: minItems, maxItems for array tuples

Using `any` and `Object`, allow enforcement of min- and maxItems in tuples.

E.g.,
```javascript
    array: {
        type: 'array',
        maxItems: 2,
        items: [
            { type: 'string' },
            { type: 'integer' },
            { type: 'boolean' },
        ],
    },
```
yields
```typescript
  [] | [string] | [string, number]
```
and
```javascript
{
    array: {
        type: 'array',
        minItems: 3,
        items: [
            { type: 'string' },
            { type: 'integer' },
            { type: 'boolean' },
        ],
    },
}
```
yields
```typescript
    array?: [string, number, boolean] | [string, number, boolean, any]
```
and
```javascript
    array: {
        type: 'array',
        minItems: 4,
        items: [
            { type: 'string' },
            { type: 'integer' },
            { type: 'boolean' },
        ],
    },
```
yields
```typescript
    [string, number, boolean, Object] | [string, number, boolean, Object, any]
```
and
```javascript
    array: {
        type: 'array',
        minItems: 2,
        maxItems: 4,
        items: [
            { type: 'string' },
            { type: 'integer' },
            { type: 'boolean' },
            { type: 'string' },
            { type: 'integer' },
            { type: 'boolean' },
        ],
    },
```
yields
```typescript
    [string, number] | [string, number, boolean] | [string, number, boolean, string]
```

If `minItems` is greater than `maxItems`, you may have complaints from other tools,
but just to add to them, the generator in such case will render the type:
```typescript
  never
```
Pull Request #239: feat: minItems, maxItems for array tuples

335 of 387 branches covered (86.56%)

31 of 31 new or added lines in 1 file covered. (100.0%)

661 of 717 relevant lines covered (92.19%)

183.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.78
/src/typeDefinition.ts


Build SHA Not Found

The commit SHA "57e779c5f5487124e96599e80191106d44b4d749" was not found in your repository, so the file cannot be loaded. This may be because you posted from a local development environment, or your CI created an ephemeral commit.