The object Type in TypeScript

Overview

TypeScript 2.2 introduced a new type called object. It represents any non-primitive type. The following types are considered to be primitive types in JavaScript:

• string
• boolean
• number
• bigint
• symbol
• null
• undefined

All other types are considered to be non-primitive types. The new object type represents exactly these:

1
2
3
4
5

// All primitive types
type Primitive = string | boolean | number | bigint | symbol | null | undefined;

// All non-primitive types
type NonPrimitive = object;

Let’s see how object lets us write more accurate type declarations.

Type Declarations Using the object Type

With the release of TypeScript 2.2, the type declarations for the standard library have been updated to make use of the new object type. For instance, the Object.create() and Object.setPrototypeOf() methods now specify the type object | null for their prototype parameters:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

interface ObjectConstructor {
  /**
   * Creates an object that has the specified prototype or that has null prototype.
   * @param o Object to use as a prototype. May be null.
   */
  create(o: object | null): any;

  /**
   * Sets the prototype of a specified object o to object proto or null. Returns the object o.
   * @param o The object to change its prototype.
   * @param proto The value of the new prototype or null.
   */
  setPrototypeOf(o: any, proto: object | null): any;

  // ...
}

Passing a primitive value except null as a prototype to either Object.setPrototypeOf() or Object.create() results in a TypeError being thrown at run-time. TypeScript now catches such mistakes and issues an error at compile-time:

1
2
3
4
5
6
7
8

const proto = {};

Object.create(proto); // OK
Object.create(null); // OK
Object.create(undefined); // Error
Object.create(1337); // Error
Object.create(true); // Error
Object.create("oops"); // Error

Another use case for the object type is the WeakMap data structure that was introduced as part of ES2015. Its keys must be objects and cannot be primitive values. This requirement is now reflected in the type definition:

1
2
3
4
5
6

interface WeakMap<K extends object, V> {
  delete(key: K): boolean;
  get(key: K): V | undefined;
  has(key: K): boolean;
  set(key: K, value: V): this;
}

object vs. Object vs. {}

Perhaps confusingly _{{ 令人迷惑不解地 }}, TypeScript defines several types that have a similar name but represent different concepts:

• object
• Object
• {}

We’ve already looked at the new object type above. Let’s now discuss what Object and {} represent.

The Object Type

TypeScript defines another type with almost the same name as the new object type, and that’s the Object type. While object (lowercased) represents all non-primitive types, Object (uppercased) describes functionality that is common to all JavaScript objects. That includes the toString() and the hasOwnProperty() methods, for example.

Within the lib.es6.d.ts file shipping with TypeScript, the Object type is defined as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

interface Object {
  // ...

  /** Returns a string representation of an object. */
  toString(): string;

  /** Returns a date converted to a string using the current locale. */
  toLocaleString(): string;

  /** Returns the primitive value of the specified object. */
  valueOf(): Object;

  /**
   * Determines whether an object has a property with the specified name.
   * @param v A property name.
   */
  hasOwnProperty(v: string): boolean;

  /**
   * Determines whether an object exists in another object's prototype chain.
   * @param v Another object whose prototype chain is to be checked.
   */
  isPrototypeOf(v: Object): boolean;

  /**
   * Determines whether a specified property is enumerable.
   * @param v A property name.
   */
  propertyIsEnumerable(v: string): boolean;
}

The Empty Type {}

There’s yet _{{ 还 }} another type which is quite similar: {}, the empty type. It describes an object that has no members on its own. TypeScript issues a compile-time error when you try to access arbitrary properties on such an object:

1
2
3
4
5

// Type {}
const obj = {};

// Error: Property 'prop' does not exist on type '{}'.
obj.prop = "value";

However, you can still use all properties and methods defined on the Object type, which are implicitly available via JavaScript’s prototype chain:

1
2
3
4
5

// Type {}
const obj = {};

// "[object Object]"
obj.toString();

References

• The object Type in TypeScript — Marius Schulz