Interface TranslationGenerationOptions

interface TranslationGenerationOptions {
    defaultDescriptionTranslation?: (
        key: string,
        path: string[],
        schema: JSONSchema7,
    ) => string;
    defaultTitleTranslation?: (
        key: string,
        path: string[],
        schema: JSONSchema7,
    ) => string;
    includeDescription?: boolean;
}

Properties

defaultDescriptionTranslation? defaultTitleTranslation? includeDescription?

Properties

OptionaldefaultDescriptionTranslation

defaultDescriptionTranslation?: (
    key: string,
    path: string[],
    schema: JSONSchema7,
) => string

Function to generate default description translations

Type declaration

    • (key: string, path: string[], schema: JSONSchema7): string

    • Parameters

      • key: string

        The property key

      • path: string[]

        The path to the property as an array

      • schema: JSONSchema7

        The schema object for this property

      Returns string

      The default description translation

OptionaldefaultTitleTranslation

defaultTitleTranslation?: (
    key: string,
    path: string[],
    schema: JSONSchema7,
) => string

Function to generate default title translations

Type declaration

    • (key: string, path: string[], schema: JSONSchema7): string

    • Parameters

      • key: string

        The property key

      • path: string[]

        The path to the property as an array

      • schema: JSONSchema7

        The schema object for this property

      Returns string

      The default title translation

OptionalincludeDescription

includeDescription?: boolean

Whether to include description translations with _description suffix

Default

false

Settings

Member Visibility

On This Page

Properties