如何在打字稿中定义返回字符串或对象的函数？

Question

I have a function that returns string, or an object.

For example:

myFunc(path: string): string | object

If I know the specific shape of the object I am expecting, how can I use this function so it matches MyObjectProps type instead of object ?

ie.

type MyObjectProps = {
  a: string;
  b: string;
}

Answer 1

This is easy! Just get rid of the 'object' and replace with 'MyObjectProps'

myFunc(path: string): string | MyObjectProps

Note that it's considered good practice to use an interface instead of a type where possible:

interface MyObjectProps {
  a: string;
  b: string;
}