Data type assignment TS+Vue3

Question

In my components, i want to use <script setup lang="ts"> . But I ran into a type problem. Example of a normal component <script lang="ts">:

props: {
    modelValue: {
      type: [Boolean, String, Number, Array as () => Array<string | number>],
      required: true,
    },
    value: {
      type: [Boolean, String, Number, Array as () => Array<string>],
      default: "",
    },
    label: {
      type: [String, Number],
      default: "",
    },
}

Component <script setup lang="ts">. How to correctly set such types in the interface ?

interface Props {
  modelValue: [Boolean, String, Number, Array as () => Array<string | number>]
  value: [Boolean, String, Number, Array as () => Array<string>]
  label: [String, Number]
}
const props = defineProps<Props>()

tony19 · Accepted Answer · 2022-05-17 03:28:06Z

1

To combine types in TypeScript, use union types. For instance, this constructor array:

[Boolean, String, Number, Array as () => Array<string | number>]

...becomes this in type in TypeScript:

boolean | string | number | (string | number)[]

So, the equivalent TypeScript interface of your original code would be:

interface Props {
  modelValue: boolean | string | number | (string | number)[]
  value: boolean | string | number | string[]
  label: string | number
}
const props = defineProps<Props>()

To set default values for the props, use withDefaults():

const props = withDefaults(defineProps<Props>(), {
  value: '',
  label: '',
})

...or use object destructuring with default values:

const {
  modelValue = '',
  value = '',
  label = '',
} = defineProps<Props>()

edited May 17, 2022 at 3:28

answered May 17, 2022 at 3:15

tony19

140k23 gold badges281 silver badges354 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Data type assignment TS+Vue3

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related