如何为Parse Server的Parse对象定义TypeScript字段类型？

为什么Post类型是any？ #

Parse JS SDK的Parse.Object.extend方法默认不会自动推断自定义对象的字段类型，不指定泛型参数时，TypeScript会将其推导为any类型，所以你拿到的Post构造函数类型就是any。

实现字段类型校验的方法 #

要实现对title这类字段的类型约束，需要通过TypeScript泛型为Parse Object指定字段接口，具体步骤如下：

1. 定义字段接口 #

先创建一个描述Post对象字段的接口，包含你需要的类型约束，同时可以继承Parse.ObjectData来包含Parse内置的默认字段（如objectId、createdAt等）：

interface PostFields extends Parse.ObjectData {
  title: string;
  // 可按需添加其他字段，比如：
  // content: string;
  // likes: number;
}

2. 用泛型扩展Parse Object #

使用带泛型参数的Parse.Object.extend，将上面定义的PostFields作为泛型传入，这样TypeScript就能识别Post实例的字段类型：

const Post = Parse.Object.extend<PostFields>("Post");

3. 类型校验生效 #

现在创建Post实例并调用set方法时，TypeScript会自动校验字段类型：

const post = new Post();
post.set("title", 123); // TypeScript会抛出错误：类型number不能赋值给类型string
post.set("title", "Hello World"); // 类型正确，无报错

额外：自定义实例方法（可选） #

如果需要给Post添加自定义方法，可以在extend的第二个参数中定义，同时要确保方法的类型和泛型接口兼容：

const Post = Parse.Object.extend<PostFields>("Post", {
  // 自定义方法
  getTitleUpperCase(): string {
    return this.get("title")?.toUpperCase() || "";
  }
});

// 使用自定义方法时会有类型提示
const post = new Post();
post.set("title", "test");
console.log(post.getTitleUpperCase()); // 输出"TEST"

关键说明 #

• 泛型参数PostFields会约束get和set方法的字段名称与类型，IDE会实时给出错误提示。
• 如果你不需要Parse的内置字段，可以不继承Parse.ObjectData，直接定义自定义字段即可。

内容的提问来源于stack exchange，提问作者Ali