SpecBuilderMethods
Defined in: extract/data-spec-builder.ts:35
Methods inherited from SpecBuilder, available on every DataSpecProxy node.
Properties
Section titled “Properties”
readonlypath: readonly (string|number)[]
Defined in: extract/data-spec-builder.ts:59
Current path
Methods
Section titled “Methods”array()
Section titled “array()”array<
S>(itemMapper):ArraySpec<S>
Defined in: extract/data-spec-builder.ts:51
Map over array items
Type Parameters
Section titled “Type Parameters”S extends Spec
Parameters
Section titled “Parameters”itemMapper
Section titled “itemMapper”(item) => S
Returns
Section titled “Returns”ArraySpec<S>
at(
index):SpecBuilderMethods
Defined in: extract/data-spec-builder.ts:39
Navigate to an array element by index
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”SpecBuilderMethods
boolean()
Section titled “boolean()”boolean():
BooleanSpec
Defined in: extract/data-spec-builder.ts:47
Extract as boolean
Returns
Section titled “Returns”get(
key):DataSpecProxy<Record<string,unknown>>
Defined in: extract/data-spec-builder.ts:37
Navigate to a property by key
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”DataSpecProxy<Record<string, unknown>>
match()
Section titled “match()”Defined in: extract/data-spec-builder.ts:57
Conditional extraction
Parameters
Section titled “Parameters”…(MatchCase<Spec> | MatchDefault<Spec>)[]
Returns
Section titled “Returns”null()
Section titled “null()”null():
NullSpec
Defined in: extract/data-spec-builder.ts:49
Extract as null
Returns
Section titled “Returns”number()
Section titled “number()”number():
NumberSpec
Defined in: extract/data-spec-builder.ts:45
Extract as number
Returns
Section titled “Returns”numbers()
Section titled “numbers()”numbers():
ArraySpec<NumberSpec>
Defined in: extract/data-spec-builder.ts:55
Extract array of numbers
Returns
Section titled “Returns”string()
Section titled “string()”string():
StringSpec
Defined in: extract/data-spec-builder.ts:43
Extract as string
Returns
Section titled “Returns”strings()
Section titled “strings()”strings():
ArraySpec<StringSpec>
Defined in: extract/data-spec-builder.ts:53
Extract array of strings
Returns
Section titled “Returns”to(…
keys):SpecBuilderMethods
Defined in: extract/data-spec-builder.ts:41
Navigate multiple levels at once
Parameters
Section titled “Parameters”…(string | number)[]
Returns
Section titled “Returns”SpecBuilderMethods