Interface UcSchemaConstraint

Constraint to apply to the schema by schema processor.

The feature is declared in ECMAScript module and exported from it as a named symbol.

The feature interface is specific to the schema processor.

Hierarchy

  • UcSchemaConstraint

Properties

from use with?

Methods

id?

Properties

Readonly from

from: string

Name of ECMAScript module to import the feature from.

Readonly use

use: string

Feature name to use.

ECMAScript symbol to import from the module and use as schema processing feature.

Optional Readonly with

with?: unknown

Additional options to pass to the feature.

The format is specific to the feature.

Methods

Optional id

  • Builds unique identifier based on additional options.

    This identifier will be appended to full schema identifier.

    When omitted, the schema identifier will be built based on JSON representation of options.

    Parameters

    • schema: UcSchema<unknown>

      Target schema.

    • schemaId: ((schema) => string)

      Builds unique schema identifier.

        • (schema): string

        • Parameters

          Returns string

    Returns string

    Part of schema identifier.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc