使用类型脚本泛型检查对象是否为空

我是打字新手,还处于学习阶段。我正在尝试创建泛型以强制执行以下条件

假设我有一个空对象

const data = {}

我需要创建将检查以下条件的泛型

如果是,则检查是否为对象,然后检查其中是否有数据,否则返回FALSE

提前谢谢


解决方案

您可以使用此实用程序检查对象类型是否为空:

// credits goes to https://github.com/microsoft/TypeScript/issues/23182#issuecomment-379091887
type IsEmptyObject<Obj extends Record<PropertyKey, unknown>> =
    [keyof Obj] extends [never] ? true : false

type Test = IsEmptyObject<{}> // true

type Test2 = IsEmptyObject<{ age: 42 }> // false

如果Obj没有任何密钥,则keyof Obj返回never

我们的目标是检查它是否返回never

为了检查它,我们需要停止distributivity。

如果keyof Obj返回never,则条件类型IsEmptyObject返回true

如果要在函数中使用它,请考虑以下示例:


type IsEmptyObject<Obj extends Record<PropertyKey, unknown>> =
    [keyof Obj] extends [never] ? true : false

function isEmpty<Obj extends Record<PropertyKey, unknown>>(obj: Obj): IsEmptyObject<Obj>
function isEmpty<Obj extends Record<PropertyKey, unknown>>(obj: Obj) {
    return Object.keys(obj).length === 0
}

const result = isEmpty({}) // true
const result2 = isEmpty({ age: 42 }) // false

Playground

您还需要注意,它只适用于文本类型。

如果你想让它与高阶函数一起工作,我打赌你也想要,请考虑这个例子:

type IsEmptyObject<Obj extends Record<PropertyKey, unknown>, Keys = keyof Obj> =
    PropertyKey extends Keys ? boolean : [keyof Obj] extends [never] ? true : false

function isEmpty<Obj extends Record<PropertyKey, unknown>>(obj: Obj): IsEmptyObject<Obj>
function isEmpty<Obj extends Record<PropertyKey, unknown>>(obj: Obj) {
    return Object.keys(obj).length === 0
}

const higherOrderFunction = (obj: Record<PropertyKey, unknown>) => {
    const test = isEmpty(obj) // boolean

    return test
}

const result3 = higherOrderFunction({ age: 2 }) // boolean

如果isEmpty无法推断文字类型,则默认情况下将返回boolean,因为您永远不知道在高阶函数中可以得到什么。

如果您推断higherOrderFunction中的obj参数,isEmpty也将能够推断参数。

const higherOrderFunction = <T extends Record<PropertyKey, unknown>>(obj: T) => {
    const test = isEmpty(obj) // IsEmptyObject<T, keyof T>

    return test
}

const result3 = higherOrderFunction({ age: 2 }) // false
const result4 = higherOrderFunction({ }) // true

Playground

我不明白您的意思: then check if there is any data inside it

问题:

假设我们有这个对象:{age: undefined}。你有没有考虑过有数据?

相关文章