Utilitários Environment 1.0.0

A categoria Environment contém funções utilitárias que ajudam a detectar e identificar o ambiente em que o código está sendo executado, seja no navegador, servidor, ou dentro de diferentes tipos de workers. As funções dessa categoria são úteis para fornecer comportamentos específicos dependendo do ambiente de execução.

Installation

Para instalar os utilitários de ambiente, use um dos seguintes comandos, dependendo do seu gerenciador de pacotes:

npm

npm install @utilify/environment

yarn

yarn add @utilify/environment

pnpm

pnpm add @utilify/environment

Após a instalação, você pode importar as funções no seu projeto, utilizando tanto o ESM quanto o CJS.

Usage

Essa biblioteca oferece suporte tanto para os sistemas de módulo ESM quanto CJS.

esm

import { isBrowser } from '@utilify/environment';

cjs

const { isBrowser } = require('@utilify/environment');

Overview

Aqui está um overview das funções disponíveis na categoria environment:

getOS

function getOS(): string | undefined;

Retorna o sistema operacional do usuário baseado no userAgent do navegador. Retorna undefined se executado no servidor.

isBun

function isBun(): boolean;

Verifica se o código está sendo executado no ambiente Bun, identificando o tipo de execução através do objeto Bun.

isBrowser

function isBrowser(): boolean;

Verifica se o código está sendo executado em um ambiente de navegador, verificando o tipo de window.

isDeno

function isDeno(): boolean;

Verifica se o código está sendo executado no ambiente Deno, verificando a presença do objeto Deno.

isDedicatedWorker

function isDedicatedWorker(): boolean;

Determina se o código está sendo executado dentro de um Dedicated Worker (Worker dedicado), verificando o tipo de self.

isMobile

function isMobile(): boolean | undefined;

Verifica se o código está sendo executado em um dispositivo móvel, baseando-se no userAgent do navegador.

isNode

function isNode(): boolean;

Determina se o código está sendo executado no ambiente Node.js, verificando a presença do objeto global e process.

isServer

function isServer(): boolean;

Detecta se o código está sendo executado no servidor, verificando se o ambiente é Node.js, Deno ou Bun.

isServiceWorker

function isServiceWorker(): boolean;

Verifica se o código está sendo executado dentro de um Service Worker, utilizando o tipo de self.

isSharedWorker

function isSharedWorker(): boolean;

Determina se o código está sendo executado dentro de um Shared Worker, verificando o tipo de self.

isWebWorker

function isWebWorker(): boolean;

Verifica se o código está sendo executado dentro de qualquer tipo de Web Worker, incluindo Dedicated, Shared ou Service Worker.