Interface UcFormatPresentations<T, TSchema>

Schema constraints for presentations of schema instances used as top-level formats.

Each property corresponds to particular format presentation.

More presentations may be added by augmenting this interface.

Type Parameters

  • out T = unknown

    Implied data type.

  • out TSchema extends UcSchema<T> = UcSchema<T>

    Supported schema type.

Hierarchy

  • UcFormatPresentations

Properties

charge? json? plainText? uriEncoded? uriParams?

Properties

Optional Readonly charge

charge?: UcConstraints<T, TSchema>

Constraints for schema instance represented in URI Charge Notation.

Optional Readonly json

json?: UcConstraints<T, TSchema>

Constraints for schema instance represented as JSON.

Optional Readonly plainText

plainText?: UcConstraints<T, TSchema>

Constraints for schema instance represented as plain text.

Optional Readonly uriEncoded

uriEncoded?: UcConstraints<T, TSchema>

Constraints for schema instance represented as URI-encoded value.

Optional Readonly uriParams

uriParams?: UcConstraints<T, TSchema>

Constraints for schema instance represented as & or ; - separated URI parameters.

This works for e.g.:

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc