ScopedOutputTransformBuilder
Defined in: output-transform/builder.ts:619
Scoped builder that wraps inner transforms in a ScopedSpec.
Returned by OutputTransformBuilder.at().
Type Parameters
Section titled “Type Parameters”Root = unknown
The root output type of the outer builder
Scope = unknown
The type at the scoped path
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ScopedOutputTransformBuilder<
Root,Scope>(parentSpecs,scopePath,isEach):ScopedOutputTransformBuilder<Root,Scope>
Defined in: output-transform/builder.ts:627
Parameters
Section titled “Parameters”parentSpecs
Section titled “parentSpecs”readonly OutputTransformSpec[]
scopePath
Section titled “scopePath”isEach
Section titled “isEach”boolean
Returns
Section titled “Returns”ScopedOutputTransformBuilder<Root, Scope>
Methods
Section titled “Methods”aggregate()
Section titled “aggregate()”Call Signature
Section titled “Call Signature”aggregate(
options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:713
Parameters
Section titled “Parameters”options
Section titled “options”AggregateOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”aggregate(
subPath,options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:714
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
options
Section titled “options”AggregateOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
apply()
Section titled “apply()”apply(
fn,description):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:1183
Apply an opaque function transform within the scoped value.
Parameters
Section titled “Parameters”(value) => unknown
description
Section titled “description”string
Returns
Section titled “Returns”OutputTransformBuilder<Root>
drop()
Section titled “drop()”drop(
paths):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:1026
Remove keys at arbitrary dot-paths within the scoped value.
Parameters
Section titled “Parameters”readonly string[]
Returns
Section titled “Returns”OutputTransformBuilder<Root>
each()
Section titled “each()”each():
ScopedOutputTransformBuilder<Root,ItemOf<Scope>>
Defined in: output-transform/builder.ts:641
Enable iteration — apply subsequent transforms to each element (array) or each value (record) at the scoped path.
Returns
Section titled “Returns”ScopedOutputTransformBuilder<Root, ItemOf<Scope>>
filter()
Section titled “filter()”Call Signature
Section titled “Call Signature”filter(
predicate):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:816
Parameters
Section titled “Parameters”predicate
Section titled “predicate”Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”filter(
subPath,predicate):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:817
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
predicate
Section titled “predicate”Returns
Section titled “Returns”OutputTransformBuilder<Root>
groupBy()
Section titled “groupBy()”Call Signature
Section titled “Call Signature”groupBy(
key,options?):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:676
Parameters
Section titled “Parameters”string
options?
Section titled “options?”GroupByOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”groupBy(
subPath,key,options?):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:677
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
string
options?
Section titled “options?”GroupByOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
indexBy()
Section titled “indexBy()”Call Signature
Section titled “Call Signature”indexBy(
key,options?):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:923
Parameters
Section titled “Parameters”string
options?
Section titled “options?”IndexByOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”indexBy(
subPath,key,options?):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:924
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
string
options?
Section titled “options?”IndexByOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
joinBy()
Section titled “joinBy()”Call Signature
Section titled “Call Signature”joinBy<
S>(options):OutputTransformBuilder<{ [P in string | number | symbol as P extends S[keyof S][“path”] ? never : P]: Root[P] }>
Defined in: output-transform/builder.ts:1140
Type Parameters
Section titled “Type Parameters”S extends Record<string, { cardinality: "one" | "many"; key: string; path: string & keyof Root; }>
Parameters
Section titled “Parameters”options
Section titled “options”JoinByBaseOptions & object
Returns
Section titled “Returns”OutputTransformBuilder<{ [P in string | number | symbol as P extends S[keyof S][“path”] ? never : P]: Root[P] }>
Call Signature
Section titled “Call Signature”joinBy(
options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:1152
Parameters
Section titled “Parameters”options
Section titled “options”JoinByBaseOptions & object
Returns
Section titled “Returns”OutputTransformBuilder<Root>
lookup()
Section titled “lookup()”Call Signature
Section titled “Call Signature”lookup<
F>(options):OutputTransformBuilder<{ [P in string | number | symbol as P extends F ? never : P]: Root[P] }>
Defined in: output-transform/builder.ts:1037
Type Parameters
Section titled “Type Parameters”F extends string
Parameters
Section titled “Parameters”options
Section titled “options”LookupOneMany & object
Returns
Section titled “Returns”OutputTransformBuilder<{ [P in string | number | symbol as P extends F ? never : P]: Root[P] }>
Call Signature
Section titled “Call Signature”lookup<
F>(options):OutputTransformBuilder<{ [P in string | number | symbol as P extends F ? never : P]: Root[P] }>
Defined in: output-transform/builder.ts:1040
Type Parameters
Section titled “Type Parameters”F extends string
Parameters
Section titled “Parameters”options
Section titled “options”LookupMerge & object
Returns
Section titled “Returns”OutputTransformBuilder<{ [P in string | number | symbol as P extends F ? never : P]: Root[P] }>
Call Signature
Section titled “Call Signature”lookup(
options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:1043
Parameters
Section titled “Parameters”options
Section titled “options”LookupOneMany & object
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”lookup(
options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:1046
Parameters
Section titled “Parameters”options
Section titled “options”LookupMerge & object
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”lookup<
F>(subPath,options):OutputTransformBuilder<{ [P in string | number | symbol as P extends F ? never : P]: Root[P] }>
Defined in: output-transform/builder.ts:1049
Type Parameters
Section titled “Type Parameters”F extends string
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
options
Section titled “options”LookupOneMany & object
Returns
Section titled “Returns”OutputTransformBuilder<{ [P in string | number | symbol as P extends F ? never : P]: Root[P] }>
Call Signature
Section titled “Call Signature”lookup<
F>(subPath,options):OutputTransformBuilder<{ [P in string | number | symbol as P extends F ? never : P]: Root[P] }>
Defined in: output-transform/builder.ts:1053
Type Parameters
Section titled “Type Parameters”F extends string
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
options
Section titled “options”LookupMerge & object
Returns
Section titled “Returns”OutputTransformBuilder<{ [P in string | number | symbol as P extends F ? never : P]: Root[P] }>
Call Signature
Section titled “Call Signature”lookup(
subPath,options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:1057
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
options
Section titled “options”LookupOneMany & object
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”lookup(
subPath,options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:1061
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
options
Section titled “options”LookupMerge & object
Returns
Section titled “Returns”OutputTransformBuilder<Root>
nest()
Section titled “nest()”nest(
target,fields,options?):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:846
Move flat properties into a nested sub-object within the scoped value.
Parameters
Section titled “Parameters”target
Section titled “target”string
fields
Section titled “fields”readonly string[]
options?
Section titled “options?”NestOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
omit()
Section titled “omit()”omit(
fields):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:912
Remove specified fields within the scoped value.
Parameters
Section titled “Parameters”fields
Section titled “fields”readonly string[]
Returns
Section titled “Returns”OutputTransformBuilder<Root>
pick()
Section titled “pick()”pick(
fields):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:898
Keep only specified fields within the scoped value.
Parameters
Section titled “Parameters”fields
Section titled “fields”readonly string[]
Returns
Section titled “Returns”OutputTransformBuilder<Root>
pivot()
Section titled “pivot()”Call Signature
Section titled “Call Signature”pivot(
options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:958
Parameters
Section titled “Parameters”options
Section titled “options”PivotOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”pivot(
subPath,options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:959
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
options
Section titled “options”PivotOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
rename()
Section titled “rename()”rename(
mappings):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:884
Rename output keys within the scoped value.
Parameters
Section titled “Parameters”mappings
Section titled “mappings”Record<string, string>
Returns
Section titled “Returns”OutputTransformBuilder<Root>
sort()
Section titled “sort()”Call Signature
Section titled “Call Signature”sort(
by,direction?):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:743
Parameters
Section titled “Parameters”string | readonly SortField[]
direction?
Section titled “direction?”"asc" | "desc"
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”sort(
subPath,by,direction?):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:747
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
string | readonly SortField[]
direction?
Section titled “direction?”"asc" | "desc"
Returns
Section titled “Returns”OutputTransformBuilder<Root>
unnest()
Section titled “unnest()”unnest(
path,fields?):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:866
Flatten a nested object’s properties up to the parent within the scoped value.
Parameters
Section titled “Parameters”string
fields?
Section titled “fields?”readonly string[]
Returns
Section titled “Returns”OutputTransformBuilder<Root>
unpivot()
Section titled “unpivot()”Call Signature
Section titled “Call Signature”unpivot(
options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:987
Parameters
Section titled “Parameters”options
Section titled “options”UnpivotOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>
Call Signature
Section titled “Call Signature”unpivot(
subPath,options):OutputTransformBuilder<Root>
Defined in: output-transform/builder.ts:988
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
options
Section titled “options”UnpivotOptions
Returns
Section titled “Returns”OutputTransformBuilder<Root>