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用于获取表示exampleObject结构中所有可能键的联合类型AllNestedKeys 。生成的类型AllNestedKeys可用于确保使用嵌套键时的类型安全。

贡献

欢迎贡献！请随意提出问题或提交拉取请求以增强功能或文档。

执照

该项目已根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE.md 文件。