isBrowser

isBrowser は現在実行している JavaScript ランタイムがブラウザー環境がどうかを判定する関数です。

インポート

import { isBrowser } from "@tai-kun/surrealdb/utils";

使い方

function isBrowser(): boolean;

引数

なし。

返値

ブラウザー環境であれば true、そうでなければ false を返します。

例

次の例では、ブラウザー環境がどうかを判定しています:

import { isBrowser } from "@tai-kun/surrealdb/utils";

if (isBrowser()) {
  document;
}

解説

グローバル変数 document が undefined でなければブラウザーと判定します。例えば Deno では window オブジェクトををグローバルに追加するため、window オブジェクトの有無で判定するとサーバーランタイムでもブラウザーと誤判定します。Web フレームワークの Remix はこれを Document Guard と呼んでいます。