Class KosmosSchemaValidator

Hierarchy

KosmosSchemaValidator

Constructors

constructor

new KosmosSchemaValidator(dataSourceWrapper: DataSourceWrapper, schemaManager: SchemaManager, jsonContentSchemaManager: JsonContentSchemaManager): KosmosSchemaValidator
Parameters
- dataSourceWrapper: DataSourceWrapper
- schemaManager: SchemaManager
- jsonContentSchemaManager: JsonContentSchemaManager
Returns KosmosSchemaValidator
- Defined in src/schema/KosmosSchemaValidator.ts:56

Properties

`Protected` `Readonly` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

`Protected` `Readonly` jsonContentSchemaManager

jsonContentSchemaManager: JsonContentSchemaManager

`Protected` `Readonly` schemaManager

schemaManager: SchemaManager

`Private` state

state: ValidatorState = ...

`Private` validator

validator: Validator

Methods

`Private` cleanState

cleanState(): void
Returns void
- Defined in src/schema/KosmosSchemaValidator.ts:177

`Private` getFormats

getFormats(): Record<string, CustomFormat>
Returns Record<string, CustomFormat>
- Defined in src/schema/KosmosSchemaValidator.ts:133

`Private` getKeywords

getKeywords(): Record<string, CustomKeyword>
Returns Record<string, CustomKeyword>
- Defined in src/schema/KosmosSchemaValidator.ts:126

validate

validate(instance: any, schema: KosmosSchema, options: Options, context: KosmosUserContext<object>): Promise<void>
Async validation allows to use asynchronous keywords and formats:
- entityType keyword
Parameters
- instance: any
- schema: KosmosSchema
- options: Options
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/schema/KosmosSchemaValidator.ts:96

`Private` validateEntityTypeKeyword

validateEntityTypeKeyword(localInstance: any, schema: ExtendedSchema): undefined | "\"entityType\" expects a string"
Parameters
- localInstance: any
- schema: ExtendedSchema
Returns undefined | "\"entityType\" expects a string"
- Defined in src/schema/KosmosSchemaValidator.ts:167

`Private` validateEntityTypes

validateEntityTypes(context: KosmosUserContext<object>): Promise<void[]>
Parameters
- context: KosmosUserContext<object>
Returns Promise<void[]>
- Defined in src/schema/KosmosSchemaValidator.ts:110

validateSync

validateSync(instance: any, schema: KosmosSchema, options?: Options): void
Sync validation allows to use only synchronous keywords and formats
Parameters
- instance: any
- schema: KosmosSchema
- Optional options: Options
Returns void
- Defined in src/schema/KosmosSchemaValidator.ts:81

`Static` `Private` validateColourFormat

validateColourFormat(value: unknown): boolean
Validates the format of a color code.

Returns
Returns true if the value matches the color code format, otherwise false.
Parameters
- value: unknown
  
  The value to be validated.
Returns boolean
- Defined in src/schema/KosmosSchemaValidator.ts:197

`Static` `Private` validateDateTimeFormat

validateDateTimeFormat(value: unknown): boolean
Validates the format of a date-time string.

Returns
Returns true if the value matches the date-time format, otherwise false.
Parameters
- value: unknown
  
  The value to be validated.
Returns boolean
- Defined in src/schema/KosmosSchemaValidator.ts:206

`Static` `Private` validateHtmlKeyword

validateHtmlKeyword(localInstance: any, schema: ExtendedSchema): undefined | string
Validates the HTML content length

Returns
Returns true if the value matches html length, otherwise false.
Parameters
- localInstance: any
  
  The value to be validated.
- schema: ExtendedSchema
  
  Schema for this value.
Returns undefined | string
- Defined in src/schema/KosmosSchemaValidator.ts:150

`Static` `Private` validateKosmosIdFormat

validateKosmosIdFormat(value: unknown): boolean
Validates the format of a KOSMOS ID.

Returns
Returns true if the value matches the KOSMOS ID format, otherwise false.
Parameters
- value: unknown
  
  The value to be validated.
Returns boolean
- Defined in src/schema/KosmosSchemaValidator.ts:188

`Static` `Private` validateMachineNameFormat

validateMachineNameFormat(value: unknown): boolean
Validates the format of a machine name string.

Returns
Returns true if the value matches the machine name format, otherwise false.
Parameters
- value: unknown
  
  The value to be validated.
Returns boolean
- Defined in src/schema/KosmosSchemaValidator.ts:222

`Static` `Private` validateVersion

validateVersion(value: unknown): boolean
Validates the format of a version string.

Returns
Returns true if the value matches the version format, otherwise false.
Parameters
- value: unknown
  
  The value to be validated.
Returns boolean
- Defined in src/schema/KosmosSchemaValidator.ts:231

`Static` `Private` validateVersionRange

validateVersionRange(value: unknown): boolean
Validates the format of a version range string.

Returns
Returns true if the value matches the version range format, otherwise false.
Parameters
- value: unknown
  
  The value to be validated.
Returns boolean
- Defined in src/schema/KosmosSchemaValidator.ts:240

Generated using TypeDoc