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 文件。