The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

json-machete

Interfaces#

Type aliases#

Variables#

Functions#

Type aliases#

JSONSchema#

Ƭ JSONSchema: JSONSchemaObject | JSONSchemaBoolean

default {}

Defined in#

node_modules/@json-schema-tools/meta-schema/index.d.ts:119

Variables#

FIRST_VISITED_PATH#

Const FIRST_VISITED_PATH: typeof FIRST_VISITED_PATH

Defined in#

packages/json-machete/src/visitJSONSchema.ts:16

Functions#

compareJSONSchemas#

compareJSONSchemas(oldSchema, newSchema): Promise<void\>

Parameters#

NameType
oldSchemaJSONSchema
newSchemaJSONSchema

Returns#

Promise<void\>

Defined in#

packages/json-machete/src/compareJSONSchemas.ts:6


dereferenceObject#

dereferenceObject<T, TRoot\>(obj, __namedParameters?): Promise<T\>

Type parameters#

NameType
TT: object
TRootTRoot = T

Parameters#

NameType
objT
__namedParametersObject
__namedParameters.cwd?string
__namedParameters.externalFileCache?Map<string, any\>
__namedParameters.refMap?Map<string, any\>
__namedParameters.root?TRoot

Returns#

Promise<T\>

Defined in#

packages/json-machete/src/dereferenceObject.ts:28


healJSONSchema#

healJSONSchema(schema): Promise<any\>

Parameters#

NameType
schemaJSONSchema

Returns#

Promise<any\>

Defined in#

packages/json-machete/src/healJSONSchema.ts:44


referenceJSONSchema#

referenceJSONSchema(schema): Promise<any\>

Parameters#

NameType
schemaJSONSchemaObject

Returns#

Promise<any\>

Defined in#

packages/json-machete/src/referenceJSONSchema.ts:4


resolvePath#

Const resolvePath(path, root): any

Parameters#

NameType
pathstring
rootany

Returns#

any

Defined in#

packages/json-machete/src/dereferenceObject.ts:6


visitJSONSchema#

visitJSONSchema<T\>(schema, visitorFn, __namedParameters?): Promise<any\>

Type parameters#

Name
T

Parameters#

NameType
schemaJSONSchema
visitorFn(subSchema: JSONSchema, context: JSONSchemaVisitorContext<T\>) => Promise<T\> | T
__namedParametersJSONSchemaVisitorContext<T\>

Returns#

Promise<any\>

Defined in#

packages/json-machete/src/visitJSONSchema.ts:18