SchemaValidator | @salesforce/core

Loads a JSON schema and performs validations against JSON objects.

Hierarchy

SchemaValidator

Index

Constructors

constructor

Methods

Constructors

constructor

new SchemaValidator(logger: Logger, schemaPath: string): SchemaValidator

- Defined in schemaValidator.ts:34
Creates a new SchemaValidator instance given a logger and path to a schema file.

Parameters
- logger: Logger
  
  An {@link SfdxLogger} instance on which to base this class's logger.
- schemaPath: string
  
  The path from which the schema with which to validate should be loaded.
Returns SchemaValidator

Methods

load

load(): Promise<JsonMap>

- Defined in schemaValidator.ts:52
Loads a JSON schema from the schemaPath parameter provided at instantiation.

Returns Promise<JsonMap>

validate

validate(json: AnyJson): Promise<AnyJson>

- Defined in schemaValidator.ts:68
Performs validation of JSON data against the schema located at the schemaPath value provided at instantiation.

throws

{SfdxError}

Parameters
- json: AnyJson
  
  A JSON value to validate against this instance's target schema.
Returns Promise<AnyJson>

The validated JSON data.