SpecBuilder

Defined in: extract/spec.ts:205

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:214

Current path

Returns

JsonPath

Methods

array()

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

Defined in: extract/spec.ts:269

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:228

Navigate to array index

Parameters

index

number

Returns

SpecBuilder

---

boolean()

boolean(): BooleanSpec

Defined in: extract/spec.ts:252

Extract as boolean

Returns

BooleanSpec

---

get()

get(key): SpecBuilder

Defined in: extract/spec.ts:223

Navigate to object property

Parameters

key

string

Returns

SpecBuilder

---

match()

match(…cases): MatchSpec<Spec>

Defined in: extract/spec.ts:312

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(): NullSpec

Defined in: extract/spec.ts:257

Extract as null

Returns

NullSpec

---

number()

number(): NumberSpec

Defined in: extract/spec.ts:247

Extract as number

Returns

NumberSpec

---

numbers()

numbers(): ArraySpec<NumberSpec>

Defined in: extract/spec.ts:291

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

Returns

ArraySpec<NumberSpec>

---

string()

string(): StringSpec

Defined in: extract/spec.ts:242

Extract as string

Returns

StringSpec

---

strings()

strings(): ArraySpec<StringSpec>

Defined in: extract/spec.ts:283

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

Returns

ArraySpec<StringSpec>

---

to()

to(…keys): SpecBuilder

Defined in: extract/spec.ts:233

Navigate multiple levels at once

Parameters

keys

…(string | number)[]

Returns

SpecBuilder

---

root()

static root(): SpecBuilder

Defined in: extract/spec.ts:209

Start building from root

Returns

SpecBuilder