Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/lookup-by-path > ILookupByPathJson

ILookupByPathJson interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

JSON-serializable representation of a LookupByPath instance.

Signature:

export interface ILookupByPathJson<TSerialized> 

Remarks

The values array stores each unique value exactly once (by reference identity). Nodes in the tree reference values by their index in this array, which ensures that reference equality is preserved across serialization and deserialization.

Properties

Property

Modifiers

Type

Description

delimiter

string

(BETA) The path delimiter used by the serialized trie.

tree

ISerializedPathTrieNode

(BETA) The serialized tree structure.

values

TSerialized[]

(BETA) Array of serialized values. Nodes in the tree reference values by their index in this array. Using an array with index-based references preserves reference equality: if multiple nodes share the same value (by reference), they will reference the same index.