ScopedOutputTransformBuilder
Defined in: output-transform/builder.ts:265
Scoped builder that prepends a path prefix to all operations.
Returned by OutputTransformBuilder.at().
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ScopedOutputTransformBuilder(
parentSpecs,scopePath):ScopedOutputTransformBuilder
Defined in: output-transform/builder.ts:271
Parameters
Section titled “Parameters”parentSpecs
Section titled “parentSpecs”readonly OutputTransformSpec[]
scopePath
Section titled “scopePath”string
Returns
Section titled “Returns”ScopedOutputTransformBuilder
Methods
Section titled “Methods”aggregate()
Section titled “aggregate()”Call Signature
Section titled “Call Signature”aggregate(
options):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:297
Parameters
Section titled “Parameters”options
Section titled “options”string
operations
Section titled “operations”readonly AggregateOp[]
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
Call Signature
Section titled “Call Signature”aggregate(
subPath,options):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:301
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
options
Section titled “options”string
operations
Section titled “operations”readonly AggregateOp[]
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
apply()
Section titled “apply()”apply(
fn,description):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:459
Parameters
Section titled “Parameters”(value) => unknown
description
Section titled “description”string
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
filter()
Section titled “filter()”Call Signature
Section titled “Call Signature”filter(
predicate):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:385
Parameters
Section titled “Parameters”predicate
Section titled “predicate”Returns
Section titled “Returns”OutputTransformBuilder<unknown>
Call Signature
Section titled “Call Signature”filter(
subPath,predicate):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:386
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
predicate
Section titled “predicate”Returns
Section titled “Returns”OutputTransformBuilder<unknown>
groupBy()
Section titled “groupBy()”groupBy(
key,options?):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:284
Parameters
Section titled “Parameters”string
options?
Section titled “options?”format?
Section titled “format?”"entries" | "record"
omitKey?
Section titled “omitKey?”boolean
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
indexBy()
Section titled “indexBy()”indexBy(
key,options?):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:447
Parameters
Section titled “Parameters”string
options?
Section titled “options?”omitKey?
Section titled “omitKey?”boolean
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
nest()
Section titled “nest()”nest(
target,fields):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:405
Parameters
Section titled “Parameters”target
Section titled “target”string
fields
Section titled “fields”readonly string[]
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
omit()
Section titled “omit()”omit(
fields):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:440
Parameters
Section titled “Parameters”fields
Section titled “fields”readonly string[]
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
pick()
Section titled “pick()”pick(
fields):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:433
Parameters
Section titled “Parameters”fields
Section titled “fields”readonly string[]
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
rename()
Section titled “rename()”rename(
mappings):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:421
Parameters
Section titled “Parameters”mappings
Section titled “mappings”Record<string, string>
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
sort()
Section titled “sort()”Call Signature
Section titled “Call Signature”sort(
by,direction?):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:326
Parameters
Section titled “Parameters”string | readonly SortField[]
direction?
Section titled “direction?”"asc" | "desc"
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
Call Signature
Section titled “Call Signature”sort(
subPath,by,direction?):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:330
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
string | readonly SortField[]
direction?
Section titled “direction?”"asc" | "desc"
Returns
Section titled “Returns”OutputTransformBuilder<unknown>
unnest()
Section titled “unnest()”unnest(
subPath,fields?):OutputTransformBuilder<unknown>
Defined in: output-transform/builder.ts:413
Parameters
Section titled “Parameters”subPath
Section titled “subPath”string
fields?
Section titled “fields?”readonly string[]
Returns
Section titled “Returns”OutputTransformBuilder<unknown>