Variable LanguagesApiConst

Type Declaration

• create: function

  • create(
        data: LanguageCreateRequest,
    ): Promise<ApiResponse<LanguageCreateResponse>>

    Create a new language.

    Parameters

    • data: LanguageCreateRequest

      Language data

    Returns Promise<ApiResponse<LanguageCreateResponse>>

    Promise with create result including new ID

• delete: function

  • delete(id: number): Promise<ApiResponse<LanguageDeleteResponse>>

    Delete a language.

    Parameters

    • id: number

      Language ID

    Returns Promise<ApiResponse<LanguageDeleteResponse>>

    Promise with delete result

• get: function

  • get(id: number): Promise<ApiResponse<LanguageGetResponse>>

    Get a single language by ID.

    Parameters

    • id: number

      Language ID

    Returns Promise<ApiResponse<LanguageGetResponse>>

    Promise with language data and all languages dictionary

• getDefinitions: function

  • getDefinitions(): Promise<ApiResponse<LanguageDefinitionsResponse>>

    Get all predefined language definitions (presets).

    Returns Promise<ApiResponse<LanguageDefinitionsResponse>>

    Promise with language definitions keyed by name

• getStats: function

  • getStats(id: number): Promise<ApiResponse<LanguageStatsResponse>>

    Get statistics for a language (text counts, word counts, etc.).

    Parameters

    • id: number

      Language ID

    Returns Promise<ApiResponse<LanguageStatsResponse>>

    Promise with language stats

• list: function

  • list(): Promise<ApiResponse<LanguageListResponse>>

    Get all languages with statistics.

    Returns Promise<ApiResponse<LanguageListResponse>>

    Promise with language list and current language ID

• refresh: function

  • refresh(id: number): Promise<ApiResponse<LanguageRefreshResponse>>

    Refresh (reparse) all texts for a language. This is needed when parsing-related settings change.

    Parameters

    • id: number

      Language ID

    Returns Promise<ApiResponse<LanguageRefreshResponse>>

    Promise with refresh statistics

• setDefault: function

  • setDefault(id: number): Promise<ApiResponse<LanguageSetDefaultResponse>>

    Set a language as the current/default language.

    Parameters

    • id: number

      Language ID

    Returns Promise<ApiResponse<LanguageSetDefaultResponse>>

    Promise with success status

• update: function

  • update(
        id: number,
        data: LanguageCreateRequest,
    ): Promise<ApiResponse<LanguageUpdateResponse>>

    Update an existing language.

    Parameters

    • id: number

      Language ID

    • data: LanguageCreateRequest

      Updated language data

    Returns Promise<ApiResponse<LanguageUpdateResponse>>

    Promise with update result