getSchema Method

Attempts to obtain a schema from this context that matches the specified criteria.

getSchema<T extends Schema<T>>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<undefined | T>

@returns the schema matching the input criteria, or undefined if no such schema could be located.

Parameter Type Description
schemaKey Readonly<SchemaKey> Identifies the schema to obtain.
matchType SchemaMatchType Criteria by which to identify potentially matching schemas.

Returns - Promise<undefined | T>

the schema matching the input criteria, or undefined if no such schema could be located.

Defined in

Last Updated: 16 April, 2024