Question

我正在尝试编写一个函数，我想表明它返回某种纯JavaScript对象。对象的签名是未知的，现在没有意思，只是它是一个普通的对象。我的意思是一个普通的对象，它满足例如jQuery的isPlainObject函数。例如

{ a: 1, b: "b" }

是一个普通的对象，但是

var obj = new MyClass();

不是＆＃34;普通＆＃34;对象，因为constructor不是Object。 jQuery在$.isPlainObject中做了一些更精确的工作，但这不属于问题的范围。

如果我尝试使用Object类型，那么它也会与任何自定义对象兼容，因为它们会从Object继承。

有没有办法定位＆＃34;普通对象＆＃34;输入TypeScript？

我想要一个类型，例如，它会满足这个要求。

var obj: PlainObject = { a: 1 }; // perfect
var obj2: PlainObject = new MyClass(); // compile-error: not a plain object

用例

对于服务器端方法，我有一种强类型的存根，就像这样。这些存根是由我的一个代码生成器生成的，基于ASP.NET MVC控制器。

export class MyController {
  ...
  static GetResult(id: number): JQueryPromise<PlainObject> {
    return $.post("mycontroller/getresult", ...);
  }
  ...
}

现在，当我在消费者类中调用它时，我可以做这样的事情。

export class MyViewModelClass {
  ...
  LoadResult(id: number): JQueryPromise<MyControllerResult> { // note the MyControllerResult strong typing here
    return MyController.GetResult(id).then(plainResult => new MyControllerResult(plainResult));
  }
  ...
}

现在假设控制器方法返回JQueryPromise<any>或JQueryPromise<Object>。现在也想象我偶然写了done而不是then。现在我有一个隐藏错误，因为viewmodel方法不会返回正确的promise，但我不会遇到编译错误。

如果我有这种假想的PlainObject类型，我希望得到一个编译错误，指出PlainObject无法转换为MyControllerResult，或类似的东西。

Answer 1

在TypeScript 3.7.2中进行了测试：

对于平坦的对象，您可以执行以下操作：

type Primitive =
  | bigint
  | boolean
  | null
  | number
  | string
  | symbol
  | undefined;

type PlainObject = Record<string, Primitive>;

class MyClass {
  //
}

const obj1: PlainObject = { a: 1 }; // Works
const obj2: PlainObject = new MyClass(); // Error

对于嵌套的普通对象：

type Primitive =
  | bigint
  | boolean
  | null
  | number
  | string
  | symbol
  | undefined;

type JSONValue = Primitive | JSONObject | JSONArray;

interface JSONObject {
  [key: string]: JSONValue;
}

interface JSONArray extends Array<JSONValue> { }

const obj3: JSONObject = { a: 1 }; // Works
const obj4: JSONObject = new MyClass(); // Error

const obj5: JSONObject = { a: { b: 1 } }; // Works
const obj6: JSONObject = { a: { b: { c: 1 } } }; // Works
const obj7: JSONObject = { a: { b: { c: { d: 1 } } } }; // Works

代码是https://github.com/microsoft/TypeScript/issues/3496#issuecomment-128553540的改编

Answer 2

在我的代码中，我有类似于你所问的内容：

export type PlainObject = { [name: string]: any }
export type PlainObjectOf<T> = { [name: string]: T }

我也有一个类型守卫：

export function isPlainObject(obj: any): obj is PlainObject {
    return obj && obj.constructor === Object || false;
}

修改

好的，我明白你在寻找什么，但不幸的是，这是不可能的如果我理解正确，那么这就是你所追求的：

type PlainObject = {
    constructor: ObjectConstructor;
    [name: string]: any
}

问题在于'lib.d.ts'Object的定义如下：

interface Object {
    /** The initial value of Object.prototype.constructor is the standard built-in Object constructor. */
    constructor: Function;

    ...
}

然后这个：

let o: PlainObject = { key: "value" };

错误结果：

Type '{ key: string; }' is not assignable to type 'PlainObject'.
  Types of property 'constructor' are incompatible.
    Type 'Function' is not assignable to type 'ObjectConstructor'.
      Property 'getPrototypeOf' is missing in type 'Function'.

Answer 3

您可以尝试递归类型（天真的解决方案）

type SerializableObject = { [x: string]: SerializableObject | number | string | [] };

不好，不可怕：）

有没有办法在TypeScript中定位纯JavaScript对象类型？

3 个答案:

修改