nested keys union

unión-de-claves-anidadas

nested-keys-union es un tipo de utilidad TypeScript que genera un tipo de unión que representa todas las claves anidadas posibles dentro de una estructura de objeto anidada determinada. Admite matrices, objetos y tipos primitivos, lo que le permite navegar y trabajar fácilmente con estructuras profundamente anidadas.

Instalación

npm install nested-keys-union --save-dev
yarn add -D nested-keys-union
pnpm add nested-keys-union --save-dev

Uso

 import { NestedKeys } from 'nested-keys-union' ;

// Example object with nested structure
const exampleObject = {
  name : 'John Doe' ,
  age : 30 ,
  address : {
    city : 'Example City' ,
    postalCode : '12345' ,
    contacts : [
      { type : 'email' , value : '[email protected]' } ,
      { type : 'phone' , value : '555-1234' } ,
    ] ,
  } ;
} ;

// Get the union type of all nested keys
type AllNestedKeys = NestedKeys < typeof exampleObject > ;

// Usage example
const nestedKey : AllNestedKeys = 'address.contacts.0.value' ;

En este ejemplo, NestedKeys se utiliza para obtener un tipo de unión AllNestedKeys que representa todas las claves posibles dentro de la estructura exampleObject . El tipo resultante AllNestedKeys se puede utilizar para garantizar la seguridad de tipos cuando se trabaja con claves anidadas.

Contribución

¡Las contribuciones son bienvenidas! No dude en abrir incidencias o enviar solicitudes de extracción para mejorar la funcionalidad o la documentación.

Licencia

Este proyecto tiene la licencia MIT; consulte el archivo LICENSE.md para obtener más detalles.