nested keys union

union de clés imbriquées

nested-keys-union est un type d'utilitaire TypeScript qui génère un type d'union représentant toutes les clés imbriquées possibles dans une structure d'objet imbriquée donnée. Il prend en charge les tableaux, les objets et les types primitifs, vous permettant de naviguer et de travailler facilement avec des structures profondément imbriquées.

Installation

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

Usage

 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' ;

Dans cet exemple, NestedKeys est utilisé pour obtenir un type d'union AllNestedKeys représentant toutes les clés possibles dans la structure exampleObject . Le type résultant AllNestedKeys peut être utilisé pour garantir la sécurité du type lorsque vous travaillez avec des clés imbriquées.

Contribution

Les contributions sont les bienvenues ! N'hésitez pas à ouvrir des tickets ou à soumettre des demandes d'extraction pour améliorer la fonctionnalité ou la documentation.

Licence

Ce projet est sous licence MIT - voir le fichier LICENSE.md pour plus de détails.