nested keys union

объединение вложенных ключей

nested-keys-union — это тип утилиты TypeScript, который генерирует тип объединения, представляющий все возможные вложенные ключи в заданной структуре вложенных объектов. Он поддерживает массивы, объекты и примитивные типы, что позволяет легко перемещаться и работать с глубоко вложенными структурами.

Установка

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

Использование

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

В этом примере NestedKeys используется для получения типа объединения AllNestedKeys представляющего все возможные ключи в структуре exampleObject . Полученный тип AllNestedKeys можно использовать для обеспечения безопасности типов при работе с вложенными ключами.

Вклад

Вклады приветствуются! Не стесняйтесь открывать проблемы или отправлять запросы на включение для улучшения функциональности или документации.

Лицензия

Этот проект лицензируется по лицензии MIT — подробности см. в файле LICENSE.md.