Interface SchemaProvider

An interface to be implemented by objects that initialize Joi schema objects.

Hierarchy

SchemaProvider

Index

Properties

init name schema?

Properties

`Readonly` init

init: ((props: InitSchemaProps) => Promise<AnySchema<any>>)

Type declaration

- (props: InitSchemaProps): Promise<AnySchema<any>>
- Initialize Joi schema
  Parameters
  - props: InitSchemaProps
  Returns Promise<AnySchema<any>>

`Readonly` name

name: string | (() => string)

Name of the schema that this provider initializes.

`Optional` `Readonly` schema

schema?: ((props: SchemaProps) => ObjectSchema<any>)

Type declaration

- (props: SchemaProps): ObjectSchema<any>
- Create a schema used to validate properties used to initialize a new schema.
  Parameters
  - props: SchemaProps
  Returns ObjectSchema<any>

Generated using TypeDoc