StandardNestedFetcher
Defined in: nested.ts:97, nested.ts:161
A fetcher that returns all nested entries
Key features:
- Tracks nested objects in properties, arrays, sets, and maps
- Provides access to nested objects by key path
- Supports iteration over all nested objects
- Maintains parent-child relationships
Remarks
Section titled “Remarks”Symbol keys are not supported
Type Parameters
Section titled “Type Parameters”T extends object
Implements
Section titled “Implements”Iterable<StandardNestedFetcher.Entry<T>>
Entry<
T> =object
Defined in: nested.ts:168
Entry representing a nested object
Remarks
Section titled “Remarks”Used when iterating over nested objects to provide context about their location
Type Parameters
Section titled “Type Parameters”T extends object
readonlydata:T
Defined in: nested.ts:174
Data
readonlykey:KeyPath
Defined in: nested.ts:170
Name of the field containing the nested object
keyPath
Section titled “keyPath”
readonlykeyPath:KeyPath
Defined in: nested.ts:172
Full path to the nested object
Constructor
Section titled “Constructor”new StandardNestedFetcher<
T>(target,transform):StandardNestedFetcher<T>
Defined in: nested.ts:106
Parameters
Section titled “Parameters”target
Section titled “target”object
The target object
transform
Section titled “transform”(entry: StandardNestedFetcher.Entry<any>) => T | null
A function that transforms the entry to the desired type.
If the function returns null, the entry is ignored.
Returns
Section titled “Returns”StandardNestedFetcher<T>
Members
Section titled “Members”dataMap
Section titled “dataMap”Get Signature
Section titled “Get Signature”get dataMap():
ReadonlyMap<KeyPath,T>
Defined in: nested.ts:152
Map of key paths to data
Returns
Section titled “Returns”ReadonlyMap<KeyPath, T>
@computed
[iterator]()
Section titled “[iterator]()”[iterator]():
Generator<StandardNestedFetcher.Entry<T>,void,unknown>
Defined in: nested.ts:133
Iterate over all entries
Returns
Section titled “Returns”Generator<StandardNestedFetcher.Entry<T>, void, unknown>
Implementation of
Section titled “Implementation of”Iterable.[iterator]
getForKey()
Section titled “getForKey()”getForKey(
keyPath):Generator<StandardNestedFetcher.Entry<T>,void,unknown>
Defined in: nested.ts:142
Iterate over all entries for the given key path
Parameters
Section titled “Parameters”keyPath
Section titled “keyPath”Returns
Section titled “Returns”Generator<StandardNestedFetcher.Entry<T>, void, unknown>