基于非空字符串的条件类型

Question

有大量关于基于值的条件类型的问题。 但是我不确定是否可以实现以下场景。

我开始熟悉条件类型，我想知道是否可以创建一个依赖于非空字符串的条件类型。

让我们考虑下一个界面：

interface Animal {
    dogName: string;
    canBark: boolean;
}

和

interface AnimalToBeMapped {
    dogsNickname?: string;
    /// some other props
}

我正在使用这个接口来映射一个对象

function mapAnimal(animal: AnimalToBeMapped): Animal {
    return {
        dogName: animal.dogsNickname,
        canBark: !animal.dogsNickname
    }
}

仅当参数对象具有dogName 属性集时，我才将canBark 属性设置为true（也应适用于空字符串与非空字符串）。

我想要做的是为我的Animal 接口添加额外的类型安全（如果有人手动设置dogName 来定义，那么我想强制canBark 属性为true，反之亦然)。

示例：

const exmpl1: Animal = {
    dogName: 'Rex',
    canBark: false // I want an error here
}

和

const exmpl2: Animal = {
    dogName: '',
    canBark: true // An error here
}

Answer 1

如果它适合你，请告诉我

type NonEmptyString<T extends string> = T extends '' ? never : T;

type WithName = {
  dogName: string,
  canBark: true,
}

type WithoutName = {
  dogName?: '',
  canBark: false
};

type Animal = WithName | WithoutName;


type Overloadings =
  & ((arg: { canBark: false }) => Animal)
  & ((arg: { dogName: '', canBark: false }) => Animal)
  & (<S extends string>(arg: { dogName: NonEmptyString<S>, canBark: true }) => Animal)

const animal: Overloadings = (arg: Animal) => {
  return arg

}

const x = animal({ dogName: '', canBark: false }) // ok
const xx = animal({ dogName: 'a', canBark: true }) // ok
const xxx = animal({ dogName: 'a', canBark: false }) // error
const xxxx = animal({ dogName: '', canBark: true }) // error
const xxxxx = animal({ canBark: true }) // error
const xxxxxx = animal({ canBark: false }) // ok

Playground

TS 要区分空字符串和字符串并不是那么容易。类型 string 可分配给文字类型 ''（空字符串），这就是我使用 NonEmptyString 助手的原因

更新 如果您对不需要额外功能的更简单的解决方案感兴趣，请参阅以下示例：

type WithName = {
  dogName: string,
  canBark: true,
}

type WithoutName = {
  canBark: false
};

type Animal = WithName | WithoutName;

const x: Animal = {
  dogName: 'name',
  canBark: true
}; // ok

const xx:Animal={
  canBark:false
}; // ok

const xxx:Animal={
  canBark:true
} // expected error

const xxxx:Animal={
  dogName:''
} // expected error

Playground