JsonSchema

Defined in: extract/schema.ts:708

JSON Schema utilities for extraction specs.

Provides static methods to derive JSON Schema from extraction specs.

Constructors

Constructor

new JsonSchema(): JsonSchema

Returns

JsonSchema

Methods

output()

Call Signature

static output(source, options?): JsonSchemaObject

Defined in: extract/schema.ts:747

Generates a JSON Schema describing the output shape produced by a spec. Works statically without executing against data.

Use cases:

• Generate API contracts / OpenAPI schemas
• Generate TypeScript types
• Document output structure

Parameters

source

Spec

A Spec or a compiled Plan

options?

JsonSchemaOptions

Optional schema generation options

Returns

JsonSchemaObject

JSON Schema describing the output structure

Example

// From a Spec
const spec = extract($ => ({
  name: $.get('user').get('name').string(),
  age: $.get('user').get('age').number(),
}))
const schema = JsonSchema.output(spec)

// From a Plan with options
const plan = new Planner()
  .in(loadFile('data.json'))
  .mapIn(parseJson())
  .emit((out, $) => out
    .add('name', $.get('name').string())
    .add('age', $.get('age').number())
  )
  .compile()
const schema = JsonSchema.output(plan, {
  id: 'https://example.com/schema',
  title: 'User',
  deduplicate: true,
})

Call Signature

static output(source, options?): JsonSchemaObject

Defined in: extract/schema.ts:748

Generates a JSON Schema describing the output shape produced by a spec. Works statically without executing against data.

Use cases:

• Generate API contracts / OpenAPI schemas
• Generate TypeScript types
• Document output structure

Parameters

source

Plan<unknown>

A Spec or a compiled Plan

options?

JsonSchemaOptions

Optional schema generation options

Returns

JsonSchemaObject

JSON Schema describing the output structure

Example

// From a Spec
const spec = extract($ => ({
  name: $.get('user').get('name').string(),
  age: $.get('user').get('age').number(),
}))
const schema = JsonSchema.output(spec)

// From a Plan with options
const plan = new Planner()
  .in(loadFile('data.json'))
  .mapIn(parseJson())
  .emit((out, $) => out
    .add('name', $.get('name').string())
    .add('age', $.get('age').number())
  )
  .compile()
const schema = JsonSchema.output(plan, {
  id: 'https://example.com/schema',
  title: 'User',
  deduplicate: true,
})