SpecBuilder

Defined in: extract/spec.ts:406

Builder for navigating and extracting from JSON structures. Records path and produces extraction specs.

Accessors

path

Get Signature

get path(): JsonPath

Defined in: extract/spec.ts:415

Current path

Returns

JsonPath

Methods

array()

array<T>(itemMapper): ArraySpec<T>

Defined in: extract/spec.ts:490

Mark current path as array and map over items. The mapper receives a SpecBuilder rooted at each item.

Type Parameters

T

T extends Spec

Parameters

itemMapper

(item) => T

Returns

ArraySpec<T>

---

at()

at(index): SpecBuilder

Defined in: extract/spec.ts:429

Navigate to array index

Parameters

index

number

Returns

SpecBuilder

---

boolean()

boolean(): FormatSpec<JsonStep, "boolean">

Defined in: extract/spec.ts:463

Extract as boolean

Returns

FormatSpec<JsonStep, "boolean">

---

get()

get(key): SpecBuilder

Defined in: extract/spec.ts:424

Navigate to object property

Parameters

key

string

Returns

SpecBuilder

---

match()

match(…cases): MatchSpec<Spec>

Defined in: extract/spec.ts:558

Conditional extraction based on the value at current path. Each case has a predicate function and a spec to use when matched.

Parameters

cases

…(MatchCase<Spec> | MatchDefault<Spec>)[]

Returns

MatchSpec<Spec>

Example

$.get('env').match(
  when(eq('production'), $.get('prodConfig').string()),
  when(startsWith('dev'), $.get('devConfig').string()),
  otherwise(literal('default'))
)

---

null()

null(): FormatSpec<JsonStep, "null">

Defined in: extract/spec.ts:473

Extract as null

Returns

FormatSpec<JsonStep, "null">

---

number()

number(): FormatSpec<JsonStep, "number">

Defined in: extract/spec.ts:453

Extract as number

Returns

FormatSpec<JsonStep, "number">

---

numbers()

numbers(): ArraySpec<FormatSpec<JsonStep, "number">>

Defined in: extract/spec.ts:517

Extract array of numbers. Shorthand for .array(item => item.number())

Returns

ArraySpec<FormatSpec<JsonStep, "number">>

---

objects()

objects<T>(itemMapper): ArraySpec<ObjectSpec<T>>

Defined in: extract/spec.ts:533

Extract array of objects. Shorthand for .array(item => object(itemMapper(item))).

Type Parameters

T

T extends Record<string, Spec>

Parameters

itemMapper

(item) => T

Returns

ArraySpec<ObjectSpec<T>>

Example

$.get('users').objects(item => ({
  name: item.get('name').string(),
  age: item.get('age').number(),
}))

---

string()

string(): FormatSpec<JsonStep, "string">

Defined in: extract/spec.ts:443

Extract as string

Returns

FormatSpec<JsonStep, "string">

---

strings()

strings(): ArraySpec<FormatSpec<JsonStep, "string">>

Defined in: extract/spec.ts:509

Extract array of strings. Shorthand for .array(item => item.string())

Returns

ArraySpec<FormatSpec<JsonStep, "string">>

---

to()

to(…keys): SpecBuilder

Defined in: extract/spec.ts:434

Navigate multiple levels at once

Parameters

keys

…(string | number)[]

Returns

SpecBuilder

---

root()

static root(): SpecBuilder

Defined in: extract/spec.ts:410

Start building from root

Returns

SpecBuilder