Object 1.0.0

A categoria de funções utilitárias para objetos inclui diversas ferramentas práticas para manipulação, comparação e transformação de objetos. Essas funções simplificam muitas operações comuns no desenvolvimento com JavaScript/TypeScript ao lidar com objetos e estruturas de dados.

Instalação

Para utilizar as funções desta categoria, instale o pacote @utilify/object usando o gerenciador de pacotes de sua preferência:

npm

npm install @utilify/object

yarn

yarn add @utilify/object

pnpm

pnpm add @utilify/object

Uso

Você pode importar funções específicas conforme necessário:

esm

import { clone, deepClone, deepMerge } from '@utilify/object';

cjs

const { clone, deepClone, deepMerge } = require('@utilify/object');

Visão Geral

clone

function clone<T extends Record<string, any>>(value: T): T;
function clone<T extends unknown[]>(value: T): T;

Cria uma cópia rasa de um objeto ou array, copiando suas propriedades diretamente.

deepClone

function deepClone<T extends Record<string, any>>(value: T): T;
function deepClone<T extends unknown[]>(value: T): T;

Cria uma cópia profunda de um objeto ou array, incluindo todas as suas propriedades aninhadas.

deepFreeze

function deepFreeze(obj: Record<string, any>): Record<string, any>;

Congela profundamente um objeto, tornando suas propriedades e suas subpropriedades imutáveis.

deepMerge

function deepMerge(...values: Record<string, any>[]): Record<string, any>;

Realiza uma mesclagem profunda de múltiplos objetos, combinando suas propriedades e subpropriedades recursivamente.

flattenObj

function flattenObj(obj: Record<string, any>, separator: string = "."): Record<string, any>;

Achata um objeto aninhado em um formato de chave única, onde as chaves representam os caminhos das propriedades.

freeze

function freeze<T>(obj: T): T;

Congela um objeto, tornando suas propriedades imutáveis, mas não congela suas subpropriedades.

interpolate

function interpolate(str: string, values: Record<string, any>): string;

Substitui placeholders em uma string por valores fornecidos em um objeto.

isDeepEqual

function isDeepEqual(value1: Record<string, any>, value2: Record<string, any>): boolean;
function isDeepEqual(value1: unknown[], value2: unknown[]): boolean;

Compara dois objetos ou arrays profundamente para verificar se são estrutural e semanticamente iguais.

isEqual

function isEqual(value1: any, value2: any): boolean;

Compara dois valores primitivos ou referências para verificar se são estritamente iguais usando Object.is.

merge

function merge(...values: Record<string, any>[]): Record<string, any>;
function merge(...values: unknown[][]): unknown[];

Realiza uma mesclagem rasa de múltiplos objetos ou arrays, combinando suas propriedades ou elementos em um novo objeto ou array.

omit

function omit<T extends Record<string, any>, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;

Cria um novo objeto a partir de um objeto fornecido, excluindo as chaves especificadas.

pick

function pick<T extends Record<string, any>, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;

Cria um novo objeto contendo apenas as chaves selecionadas de um objeto original.

sanitizeObj

function sanitizeObj(obj: Record<string, any>, values: any[], replace?: any): Record<string, any>;

Sanitiza um objeto, substituindo valores específicos por um valor de substituição opcional.

unflattenObj

function unflattenObj(obj: Record<string, any>, separator: string = "."): Record<string, any>;

Transforma um objeto achatado de volta em sua estrutura aninhada original, utilizando um separador para identificar os níveis de hierarquia nas chaves.