JavaScript/TypeScriptでオブジェクトが空かどうかを確認する方法

2024-05-23

TypeScriptで特定のオブジェクトが空かどうかを確認する方法

Object.keys(obj).length === 0 を使用する

これは最もシンプルで分かりやすい方法です。Object.keys() メソッドは、オブジェクトのプロパティ名の配列を返します。この配列の長さが 0 であれば、オブジェクトは空であると言えます。

function isEmptyObject(obj: object): boolean {
  return Object.keys(obj).length === 0;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

!obj を使用する

これは、オブジェクトが null または undefined であるかどうかを確認するものです。オブジェクトが空であっても、null または undefined ではない場合があることに注意が必要です。

function isEmptyObject(obj: object): boolean {
  return !obj;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // false

for...in ループを使用する

これは、オブジェクトのプロパティをすべてループし、プロパティが存在しないかどうかを確認する方法です。

function isEmptyObject(obj: object): boolean {
  for (const key in obj) {
    return false;
  }
  return true;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

型ガードを使用する

TypeScript 4.1以降では、型ガードを使用してオブジェクトが空かどうかをより詳細にチェックすることができます。

function isEmptyObject<T>(obj: T): obj is {} {
  return Object.keys(obj).length === 0;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

オブジェクトが null または undefined であるかどうかを確認する必要がある場合は、!obj を使用する。
オブジェクトのプロパティをすべてループする必要がある場合は、for...in ループを使用する。
型ガードを使用してオブジェクトが空かどうかをより詳細にチェックする必要がある場合は、型ガードを使用する。

その他の注意点

上記の例では、object 型のジェネリック型パラメータ T を使用しています。これは、isEmptyObject 関数を任意の型のオブジェクトに使用できるようにするためです。
オブジェクトの継承関係を考慮する必要がある場合は、hasOwnProperty メソッドを使用する必要があります。

function isEmptyObject(obj: object): boolean {
  return Object.keys(obj).length === 0;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

function isEmptyObject(obj: object): boolean {
  return !obj;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // false

function isEmptyObject(obj: object): boolean {
  for (const key in obj) {
    return false;
  }
  return true;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

function isEmptyObject<T>(obj: T): obj is {} {
  return Object.keys(obj).length === 0;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

説明

各サンプルコードは、isEmptyObject という名前の関数を定義します。この関数は、引数として渡されたオブジェクトが空かどうかを返します。
Object.keys(obj).length === 0 を使用する方法は、オブジェクトのプロパティ名の配列の長さをチェックして、それが 0 であるかどうかを確認します。
!obj を使用する方法は、オブジェクトが null または undefined であるかどうかを確認します。
型ガードを使用する方法は、型ガードを使用してオブジェクトが空かどうかをより詳細にチェックします。

補足

これらのサンプルコードは、あくまでも一例です。状況に応じて、必要に応じてコードを変更する必要があります。

TypeScriptで特定のオブジェクトが空かどうかを確認するその他の方法

これは、Object.values() メソッドを使用して、オブジェクトの値の配列を取得し、その配列の長さが 0 であるかどうかを確認する方法です。

function isEmptyObject(obj: object): boolean {
  return Object.values(obj).length === 0;
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

JSON.stringify(obj) === '{}' を使用する

これは、オブジェクトを JSON 文字列に変換し、その文字列が '{}' であるかどうかを確認する方法です。

function isEmptyObject(obj: object): boolean {
  return JSON.stringify(obj) === '{}';
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

lodash.isEmpty を使用する

これは、Lodash ライブラリを使用して、オブジェクトが空かどうかを確認する方法です。

import * as _ from 'lodash';

function isEmptyObject(obj: object): boolean {
  return _.isEmpty(obj);
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true

import R from 'ramda';

function isEmptyObject(obj: object): boolean {
  return R.isEmpty(obj);
}

const myObj: { name: string, age: number } = {};
console.log(isEmptyObject(myObj)); // true