@illavv/run_typer - v4.1.0
    Preparing search index...

    Type Alias ToJSONSchemaOptions

    Options accepted by toJSONSchema.

    type ToJSONSchemaOptions = {
        $schema?: string | false;
        description?: string;
        id?: string;
        strict?: boolean;
        title?: string;
        unrepresentable?: UnrepresentablePolicy;
    }
    Index
    $schema? description? id? strict? title? unrepresentable?
    $schema?: string | false

    The $schema dialect to declare. Defaults to draft 2020-12; pass false to omit the keyword entirely, which is what you want when the result is embedded in a larger document such as an OpenAPI spec.

    description?: string

    Value for the document's description.

    id?: string

    Value for the document's $id.

    strict?: boolean

    Emit additionalProperties: false, mirroring Typer's strict mode.

    title?: string

    Value for the document's title.

    unrepresentable?: UnrepresentablePolicy

    What to do with a slot that has no JSON Schema equivalent. Defaults to 'any'.

    Settings
    Member Visibility

    On This Page
    Properties