Beignet API reference
    Preparing search index...

    Interface SchemaConverter

    Converts a validation schema into an OpenAPI-compatible JSON Schema object.

    interface SchemaConverter {
        name: string;
        canConvert(schema: unknown): boolean;
        toJSONSchema(
            schema: unknown,
            context: SchemaConverterContext,
        ): ConvertedSchemaObject;
    }
    Index
    name
    canConvert toJSONSchema
    name: string

    Human-readable converter name used in diagnostics.

    • Return true when this converter owns the schema value.

      Parameters

      • schema: unknown

      Returns boolean

    • Convert the schema into an OpenAPI-compatible JSON Schema object.

      Parameters

      • schema: unknown
      • context: SchemaConverterContext

      Returns ConvertedSchemaObject

    Settings
    Member Visibility

    On This Page
    Properties
    Methods