covenix / parseContract

Function: parseContract()

parseContract(value): object

Defined in: src/contract.ts:235

Validates an unknown value as a CovenixContract — use this when reading a contract.json in a generator. Throws (with a version-mismatch error for an unrecognised covenixContract) if it doesn't conform.

Parameters

value

unknown

The parsed JSON to validate.

Returns

object

The validated contract.

covenixContract

covenixContract: "0.1"

info

info: object

Index Signature

[key: string]: unknown

info.title

title: string

info.version

version: string

operations

operations: object[]

schemas

schemas: Record<string, SchemaNode>