vue-ts-types/type-tests/prop-types/function.type.spec.ts at eb55b698e6f97ac8165be4078baafcdde90baca8 · FloEdelmann/vue-ts-types · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
import { describe, expect, test } from 'tstyche';
import type * as Vue2_6 from 'vue2-6/types/options';
import type * as Vue2_7 from 'vue2-7/types/options';
import type * as Vue3 from '@vue/runtime-core';
import { functionProp } from '../../src/prop-types/function';
import { createVue2Component } from '../utils';
import type { Vue2ComponentWithProp } from '../utils';

/* eslint-disable @typescript-eslint/no-unsafe-function-type */

type MyCustomCallback = (parameter: string) => Promise<boolean>;

describe('functionProp().optional', () => {
  test('Vue 2.6', () => {
    expect<Vue2_6.PropOptions<Function | undefined>>().type.toBeAssignableWith(
      functionProp().optional,
    );
    expect<
      Vue2_6.PropOptions<MyCustomCallback | undefined>
    >().type.toBeAssignableWith(functionProp<MyCustomCallback>().optional);
    expect<Vue2_6.PropOptions<Function>>().type.not.toBeAssignableWith(
      functionProp().optional,
    );
    expect<Vue2_6.PropOptions<MyCustomCallback>>().type.not.toBeAssignableWith(
      functionProp<MyCustomCallback>().optional,
    );

    expect(createVue2Component(functionProp().optional)).type.toBe<
      Vue2ComponentWithProp<Function | undefined>
    >();

    expect(
      createVue2Component(functionProp<MyCustomCallback>().optional),
    ).type.toBe<Vue2ComponentWithProp<MyCustomCallback | undefined>>();
  });

  test('Vue 2.7', () => {
    expect<Vue2_7.PropOptions<Function | undefined>>().type.toBeAssignableWith(
      functionProp().optional,
    );
    expect<
      Vue2_7.PropOptions<MyCustomCallback | undefined>
    >().type.toBeAssignableWith(functionProp<MyCustomCallback>().optional);
    expect<Vue2_7.PropOptions<Function>>().type.not.toBeAssignableWith(
      functionProp().optional,
    );
    expect<Vue2_7.PropOptions<MyCustomCallback>>().type.not.toBeAssignableWith(
      functionProp<MyCustomCallback>().optional,
    );
  });

  test('Vue 3', () => {
    expect<Vue3.Prop<Function | undefined>>().type.toBeAssignableWith(
      functionProp().optional,
    );
    expect<Vue3.Prop<MyCustomCallback | undefined>>().type.toBeAssignableWith(
      functionProp<MyCustomCallback>().optional,
    );
    expect<Vue3.Prop<Function>>().type.not.toBeAssignableWith(
      functionProp().optional,
    );
    expect<Vue3.Prop<MyCustomCallback>>().type.not.toBeAssignableWith(
      functionProp<MyCustomCallback>().optional,
    );
  });
});

describe('functionProp().nullable', () => {
  test('Vue 2.6', () => {
    expect<Vue2_6.PropOptions<Function | null>>().type.toBeAssignableWith(
      functionProp().nullable,
    );
    expect<
      Vue2_6.PropOptions<MyCustomCallback | null>
    >().type.toBeAssignableWith(functionProp<MyCustomCallback>().nullable);
    expect<Vue2_6.PropOptions<Function>>().type.not.toBeAssignableWith(
      functionProp().nullable,
    );
    expect<Vue2_6.PropOptions<MyCustomCallback>>().type.not.toBeAssignableWith(
      functionProp<MyCustomCallback>().nullable,
    );

    expect(createVue2Component(functionProp().nullable)).type.toBe<
      Vue2ComponentWithProp<Function | null>
    >();

    expect(
      createVue2Component(functionProp<MyCustomCallback>().nullable),
    ).type.toBe<Vue2ComponentWithProp<MyCustomCallback | null>>();
  });

  test('Vue 2.7', () => {
    expect<Vue2_7.PropOptions<Function | null>>().type.toBeAssignableWith(
      functionProp().nullable,
    );
    expect<
      Vue2_7.PropOptions<MyCustomCallback | null>
    >().type.toBeAssignableWith(functionProp<MyCustomCallback>().nullable);
    expect<Vue2_7.PropOptions<Function>>().type.not.toBeAssignableWith(
      functionProp().nullable,
    );
    expect<Vue2_7.PropOptions<MyCustomCallback>>().type.not.toBeAssignableWith(
      functionProp<MyCustomCallback>().nullable,
    );
  });

  test('Vue 3', () => {
    expect<Vue3.Prop<Function | null>>().type.toBeAssignableWith(
      functionProp().nullable,
    );
    expect<Vue3.Prop<MyCustomCallback | null>>().type.toBeAssignableWith(
      functionProp<MyCustomCallback>().nullable,
    );
    expect<Vue3.Prop<Function>>().type.not.toBeAssignableWith(
      functionProp().nullable,
    );
    expect<Vue3.Prop<MyCustomCallback>>().type.not.toBeAssignableWith(
      functionProp<MyCustomCallback>().nullable,
    );
  });
});

describe('functionProp().required', () => {
  test('Vue 2.6', () => {
    expect<Vue2_6.PropOptions<Function>>().type.toBeAssignableWith(
      functionProp().required,
    );
    expect<Vue2_6.PropOptions<MyCustomCallback>>().type.toBeAssignableWith(
      functionProp<MyCustomCallback>().required,
    );
    expect<Vue2_6.PropOptions<string>>().type.not.toBeAssignableWith(
      functionProp().required,
    );

    expect(createVue2Component(functionProp().required)).type.toBe<
      Vue2ComponentWithProp<Function>
    >();

    expect(
      createVue2Component(functionProp<MyCustomCallback>().required),
    ).type.toBe<Vue2ComponentWithProp<MyCustomCallback>>();
  });

  test('Vue 2.7', () => {
    expect<Vue2_7.PropOptions<Function>>().type.toBeAssignableWith(
      functionProp().required,
    );
    expect<Vue2_7.PropOptions<MyCustomCallback>>().type.toBeAssignableWith(
      functionProp<MyCustomCallback>().required,
    );
    expect<Vue2_7.PropOptions<string>>().type.not.toBeAssignableWith(
      functionProp().required,
    );
  });

  test('Vue 3', () => {
    expect<Vue3.Prop<Function>>().type.toBeAssignableWith(
      functionProp().required,
    );
    expect<Vue3.Prop<MyCustomCallback>>().type.toBeAssignableWith(
      functionProp<MyCustomCallback>().required,
    );
    expect<Vue3.Prop<string>>().type.not.toBeAssignableWith(
      functionProp().required,
    );
  });
});