Edit

Share via

SchemaHelper class

  • Reference
Package:
botbuilder-dialogs-adaptive

Helper class for dialog schema.

Constructors

SchemaHelper(object)

Creates a new SchemaHelper instance.

Properties

property

Root object property for the schema.
required

List of required property names.
schema

JSON schema object.

Methods

pathToSchema(string)

Returns the schema object for a given property path.

Constructor Details

SchemaHelper(object)

Creates a new SchemaHelper instance.

new SchemaHelper(schema: object)

Parameters

schema

object

JSON schema to parse.

Property Details

property

Root object property for the schema.

property: PropertySchema

Property Value

PropertySchema

required

List of required property names.

string[] required

Property Value

string[]

The list of required property names.

schema

JSON schema object.

schema: object

Property Value

object

Method Details

pathToSchema(string)

Returns the schema object for a given property path.

function pathToSchema(path: string): PropertySchema | undefined

Parameters

path

string

Path of the properties schema to return.

Returns

PropertySchema | undefined

the schema object for a given property path.