Interface TranslatableStrings

What is translatable?

TypeDoc includes a lot of literal strings. By convention, messages which are displayed to the user at the INFO level or above should be present in this object to be available for translation. Messages at the VERBOSE level need not be translated as they are primarily intended for debugging. ERROR/WARNING deprecation messages related to TypeDoc's API, or requesting users submit a bug report need not be translated.

Errors thrown by TypeDoc are generally not considered translatable as they are not displayed to the user. An exception to this is errors thrown by the validate method on options, as option readers will use them to report errors to the user.

Interface Keys

This object uses a similar convention as TypeScript, where the specified key should indicate where placeholders are present by including a number in the name. This is so that translations can easily tell that they are including the appropriate placeholders. This will also be validated at runtime by the Internationalization class, but it's better to have that hint when editing as well.

This interface defines the available translatable strings, and the number of placeholders that are required to use each string. Plugins may use declaration merging to add members to this interface to use TypeDoc's internationalization module.

Example

declare module "typedoc" {
    interface TranslatableStrings {
        // Define a translatable string with no arguments
        plugin_msg: [];
        // Define a translatable string requiring one argument
        plugin_msg_0: [string];
    }
}

Hierarchy

BuiltinTranslatableStringArgs
- TranslatableStrings

Index

Properties

at_most_one_inheritdoc_tag_expected_in_comment_at_0 at_most_one_remarks_tag_expected_in_comment_at_0 at_most_one_returns_tag_expected_in_comment_at_0 circular_reference_extends_0 comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group comment_for_0_includes_groupDescription_for_1_but_no_child_in_group comment_for_0_should_not_contain_block_or_modifier_tags comments_for_0_are_declared_at_1 content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0 content_in_summary_overwritten_by_inheritdoc_in_comment_at_0 converting_0_as_class_requires_value_declaration converting_0_as_class_without_construct_signatures converting_project_at_0 converting_union_as_interface could_not_create_output_directory_0 could_not_empty_output_directory_0 could_not_write_0 custom_css_file_0_does_not_exist custom_js_file_0_does_not_exist custom_theme_does_not_define_getSlugger declaration_reference_in_inheritdoc_for_0_not_fully_parsed defaulting_project_name disable_git_set_and_git_revision_used disable_git_set_but_not_source_link_template docs_could_not_be_generated docs_generated_at_0 entry_point_0_did_not_exist entry_point_0_did_not_match_any_files_after_exclude entry_point_0_did_not_match_any_packages entry_point_0_not_in_program entrypoint_did_not_match_files_0 example_tag_literal_name exclude_not_documented_specified_0_valid_values_are_1 expected_object_with_flag_values_for_0 external_symbol_link_mappings_must_be_object failed_read_options_file_0 failed_read_tsdoc_json_0 failed_resolve_0_to_file_in_1 failed_to_convert_packages failed_to_find_0_to_inherit_comment_from_in_1 failed_to_find_jsdoc_tag_for_name_0 failed_to_find_packages failed_to_parse_json_0 failed_to_read_0_when_processing_document_child_in_1 failed_to_read_0_when_processing_document_tag_in_1 failed_to_read_0_when_processing_project_document failed_to_resolve_link_to_0_in_comment_for_1 failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2 failed_to_resolve_link_to_0_in_document_1 failed_to_resolve_link_to_0_in_document_1_may_have_meant_2 failed_to_resolve_link_to_0_in_readme_for_1 failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2 file_0_not_an_object flag_0_is_not_valid_for_1_expected_2 flag_abstract flag_const flag_external flag_inherited flag_optional flag_private flag_protected flag_public flag_readonly flag_rest flag_static flag_values_for_0_must_be_booleans found_0_errors_and_1_warnings frontmatter_children_0_should_be_an_array_of_strings_or_object_with_string_values git_remote_0_not_valid glob_0_did_not_match_any_files help_alwaysCreateEntryPointModule help_basePath help_blockTags help_cacheBust help_categorizeByGroup help_categoryOrder help_cleanOutputDir help_cname help_commentStyle help_compilerOptions help_customCss help_customFooterHtml help_customFooterHtmlDisableWrapper help_customJs help_darkHighlightTheme help_defaultCategory help_disableGit help_disableSources help_emit help_entryPoints help_entryPointStrategy help_exclude help_excludeCategories help_excludeExternals help_excludeInternal help_excludeNotDocumented help_excludeNotDocumentedKinds help_excludePrivate help_excludeProtected help_excludeReferences help_excludeTags help_externalPattern help_externalSymbolLinkMappings help_githubPages help_gitRemote help_gitRevision help_groupOrder help_headings help_help help_hideGenerator help_hideParameterTypesInTitle help_highlightLanguages help_hostedBaseUrl help_includeVersion help_inlineTags help_intentionallyNotExported help_jsDocCompatibility help_json help_kindSortOrder help_lang help_lightHighlightTheme help_locales help_logLevel help_markdownItLoader help_markdownItOptions help_markdownLinkExternal help_maxTypeConversionDepth help_modifierTags help_name help_navigation help_navigationLeaves help_navigationLinks help_options help_out help_packageOptions help_plugin help_preserveLinkText help_preserveWatchOutput help_pretty help_projectDocuments help_readme help_requiredToBeDocumented help_searchCategoryBoosts help_searchGroupBoosts help_searchInComments help_searchInDocuments help_showConfig help_sidebarLinks help_skipErrorChecking help_sort help_sortEntryPoints help_sourceLinkExternal help_sourceLinkTemplate help_theme help_titleLink help_treatValidationWarningsAsErrors help_treatWarningsAsErrors help_tsconfig help_useHostedBaseUrlForAbsoluteLinks help_useTsLinkResolution help_validation help_version help_visibilityFilters help_watch highlight_theme_0_must_be_one_of_1 highlightLanguages_contains_invalid_languages_0 hostedBaseUrl_must_start_with_http inheritdoc_circular_inheritance_chain_0 inheritdoc_tag_properly_capitalized inline_inheritdoc_should_not_appear_in_block_tag_in_comment_at_0 inline_tag_not_closed invalid_intentionally_not_exported_symbols_0 invalid_plugin_0_missing_load_function invalid_tsdoc_json_0 json_written_to_0 kind_accessor kind_call_signature kind_class kind_constructor kind_constructor_signature kind_document kind_enum kind_enum_member kind_function kind_get_signature kind_index_signature kind_interface kind_method kind_module kind_namespace kind_parameter kind_plural_accessor kind_plural_call_signature kind_plural_class kind_plural_constructor kind_plural_constructor_signature kind_plural_document kind_plural_enum kind_plural_enum_member kind_plural_function kind_plural_get_signature kind_plural_index_signature kind_plural_interface kind_plural_method kind_plural_module kind_plural_namespace kind_plural_parameter kind_plural_project kind_plural_property kind_plural_reference kind_plural_set_signature kind_plural_type_alias kind_plural_type_literal kind_plural_type_parameter kind_plural_variable kind_project kind_property kind_reference kind_set_signature kind_type_alias kind_type_literal kind_type_parameter kind_variable label_0_for_1_cannot_be_referenced loaded_multiple_times_0 loaded_plugin_0 locales_must_be_an_object merging_converted_projects modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2 multiple_type_parameters_on_template_tag_unsupported nested_packages_unsupported_0 no_compiler_options_set no_entry_points_for_packages no_entry_points_provided no_entry_points_to_merge not_all_search_category_boosts_used_0 not_all_search_group_boosts_used_0 open_brace_within_inline_tag option_0_can_only_be_specified_by_config_file option_0_expected_a_value_but_none_provided option_0_must_be_a_function option_0_must_be_an_object option_0_must_be_between_1_and_2 option_0_must_be_equal_to_or_greater_than_1 option_0_must_be_less_than_or_equal_to_1 option_0_must_be_object_with_urls option_0_must_be_one_of_1 option_0_specified_1_but_only_2_is_valid option_0_values_must_be_array_of_tags option_0_values_must_be_numbers options_file_0_does_not_exist plugin_0_could_not_be_loaded previous_error_occurred_when_reading_options_for_0 provided_readme_at_0_could_not_be_read reflection_0_kind_1_defined_in_2_does_not_have_any_documentation reflection_0_tried_to_copy_comment_from_1_but_source_had_no_comment relative_path_0_is_not_a_file_and_will_not_be_copied_to_output saved_relative_path_0_resolved_from_1_is_not_a_file serialized_project_referenced_0_not_part_of_project signature_0_has_unused_param_with_name_1 solution_not_supported_in_watch_mode strategy_not_supported_in_watch_mode symbol_0_has_multiple_declarations_with_comment tag_abstract tag_alpha tag_augments tag_author tag_beta tag_callback tag_category tag_categoryDescription tag_class tag_default tag_defaultValue tag_deprecated tag_document tag_enum tag_event tag_eventProperty tag_example tag_experimental tag_extends tag_group tag_groupDescription tag_hidden tag_hideCategories tag_hideconstructor tag_hideGroups tag_ignore tag_import tag_inheritDoc tag_interface tag_internal tag_jsx tag_label tag_license tag_link tag_linkcode tag_linkplain tag_module tag_namespace tag_overload tag_override tag_packageDocumentation tag_param tag_private tag_privateRemarks tag_prop tag_property tag_protected tag_public tag_readonly tag_remarks tag_return tag_returns tag_satisfies tag_sealed tag_see tag_showCategories tag_showGroups tag_since tag_template tag_throws tag_type tag_typedef tag_typeParam tag_virtual tag_yields tags_0_defined_in_typedoc_json_overwritten_by_tsdoc_json theme_0_is_not_defined_available_are_1 theme_class_hierarchy_title theme_copied theme_copy theme_dark theme_defined_in theme_generated_using_typedoc theme_hierarchy theme_hierarchy_view_full theme_implementation_of theme_implemented_by theme_implements theme_index theme_indexable theme_inherited_from theme_light theme_loading theme_member_visibility theme_menu theme_normally_hidden theme_on_this_page theme_os theme_overrides theme_permalink theme_preparing_search_index theme_re_exports theme_renames_and_re_exports theme_returns theme_search theme_search_index_not_available theme_settings theme_theme theme_type_declaration treating_unrecognized_tag_0_as_modifier tsconfig_file_0_does_not_exist tsconfig_file_specifies_options_file tsconfig_file_specifies_tsconfig_file type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs typedoc_key_in_0_ignored typedoc_options_must_be_object_in_0 unable_to_find_any_entry_points unescaped_open_brace_without_inline_tag unknown_block_tag_0 unknown_inline_tag_0 unknown_option_0_may_have_meant_1 unknown_option_0_you_may_have_meant_1 unloaded_language_0_not_highlighted_in_comment_for_1 unmatched_closing_brace unsupported_highlight_language_0_not_highlighted_in_comment_for_1 unsupported_ts_version_0 use_expand_or_glob_for_files_in_dir useHostedBaseUrlForAbsoluteLinks_requires_hostedBaseUrl visibility_filters_must_be_booleans visibility_filters_only_include_0 watch_does_not_support_merge_mode watch_does_not_support_packages_mode yaml_frontmatter_not_an_object

Properties

`Readonly`at_most_one_inheritdoc_tag_expected_in_comment_at_0

at_most_one_inheritdoc_tag_expected_in_comment_at_0: [string] = "At most one @inheritDoc tag is expected in a comment, ignoring all but the first in comment at {0}"

`Readonly`at_most_one_remarks_tag_expected_in_comment_at_0

at_most_one_remarks_tag_expected_in_comment_at_0: [string] = "At most one @remarks tag is expected in a comment, ignoring all but the first in comment at {0}"

`Readonly`at_most_one_returns_tag_expected_in_comment_at_0

at_most_one_returns_tag_expected_in_comment_at_0: [string] = "At most one @returns tag is expected in a comment, ignoring all but the first in comment at {0}"

`Readonly`circular_reference_extends_0

circular_reference_extends_0: [string] = ...

`Readonly`comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group

comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group: [string, string] = ...

`Readonly`comment_for_0_includes_groupDescription_for_1_but_no_child_in_group

comment_for_0_includes_groupDescription_for_1_but_no_child_in_group: [string, string] = ...

`Readonly`comment_for_0_should_not_contain_block_or_modifier_tags

comment_for_0_should_not_contain_block_or_modifier_tags: [string] = ...

`Readonly`comments_for_0_are_declared_at_1

comments_for_0_are_declared_at_1: [string, string] = ...

`Readonly`content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0

content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0: [string] = "Content in the @remarks block will be overwritten by the @inheritDoc tag in comment at {0}"

`Readonly`content_in_summary_overwritten_by_inheritdoc_in_comment_at_0

content_in_summary_overwritten_by_inheritdoc_in_comment_at_0: [string] = "Content in the summary section will be overwritten by the @inheritDoc tag in comment at {0}"

`Readonly`converting_0_as_class_requires_value_declaration

converting_0_as_class_requires_value_declaration: [string] = ...

`Readonly`converting_0_as_class_without_construct_signatures

converting_0_as_class_without_construct_signatures: [string] = ...

`Readonly`converting_project_at_0

converting_project_at_0: [string] = "Converting project at {0}"

`Readonly`converting_union_as_interface

converting_union_as_interface: [] = ...

`Readonly`could_not_create_output_directory_0

could_not_create_output_directory_0: [string] = ...

`Readonly`could_not_empty_output_directory_0

could_not_empty_output_directory_0: [string] = ...

`Readonly`could_not_write_0

could_not_write_0: [string] = ...

`Readonly`custom_css_file_0_does_not_exist

custom_css_file_0_does_not_exist: [string] = ...

`Readonly`custom_js_file_0_does_not_exist

custom_js_file_0_does_not_exist: [string] = ...

`Readonly`custom_theme_does_not_define_getSlugger

custom_theme_does_not_define_getSlugger: [] = ...

`Readonly`declaration_reference_in_inheritdoc_for_0_not_fully_parsed

declaration_reference_in_inheritdoc_for_0_not_fully_parsed: [string] = ...

`Readonly`defaulting_project_name

defaulting_project_name: [] = 'The --name option was not specified, and no package.json was found. Defaulting project name to "Documentation"'

`Readonly`disable_git_set_and_git_revision_used

disable_git_set_and_git_revision_used: [] = ...

`Readonly`disable_git_set_but_not_source_link_template

disable_git_set_but_not_source_link_template: [] = ...

`Readonly`docs_could_not_be_generated

docs_could_not_be_generated: [] = "Documentation could not be generated due to the errors above"

`Readonly`docs_generated_at_0

docs_generated_at_0: [string] = "Documentation generated at {0}"

`Readonly`entry_point_0_did_not_exist

entry_point_0_did_not_exist: [string] = ...

`Readonly`entry_point_0_did_not_match_any_files_after_exclude

entry_point_0_did_not_match_any_files_after_exclude: [string] = ...

`Readonly`entry_point_0_did_not_match_any_packages

entry_point_0_did_not_match_any_packages: [string] = ...

`Readonly`entry_point_0_not_in_program

entry_point_0_not_in_program: [string] = ...

`Readonly`entrypoint_did_not_match_files_0

entrypoint_did_not_match_files_0: [string] = "The entrypoint glob {0} did not match any files"

`Readonly`example_tag_literal_name

example_tag_literal_name: [] = "The first line of an example tag will be taken literally as the example name, and should only contain text"

`Readonly`exclude_not_documented_specified_0_valid_values_are_1

exclude_not_documented_specified_0_valid_values_are_1: [string, string] = ...

`Readonly`expected_object_with_flag_values_for_0

expected_object_with_flag_values_for_0: [string] = "Expected an object with flag values for {0} or true/false"

`Readonly`external_symbol_link_mappings_must_be_object

external_symbol_link_mappings_must_be_object: [] = "externalSymbolLinkMappings must be a Record<package name, Record<symbol name, link>>"

`Readonly`failed_read_options_file_0

failed_read_options_file_0: [string] = ...

`Readonly`failed_read_tsdoc_json_0

failed_read_tsdoc_json_0: [string] = ...

`Readonly`failed_resolve_0_to_file_in_1

failed_resolve_0_to_file_in_1: [string, string] = ...

`Readonly`failed_to_convert_packages

failed_to_convert_packages: [] = "Failed to convert one or more packages, result will not be merged together"

`Readonly`failed_to_find_0_to_inherit_comment_from_in_1

failed_to_find_0_to_inherit_comment_from_in_1: [string, string] = ...

`Readonly`failed_to_find_jsdoc_tag_for_name_0

failed_to_find_jsdoc_tag_for_name_0: [string] = ...

`Readonly`failed_to_find_packages

failed_to_find_packages: [] = "Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json"

`Readonly`failed_to_parse_json_0

failed_to_parse_json_0: [string] = ...

`Readonly`failed_to_read_0_when_processing_document_child_in_1

failed_to_read_0_when_processing_document_child_in_1: [string, string] = ...

`Readonly`failed_to_read_0_when_processing_document_tag_in_1

failed_to_read_0_when_processing_document_tag_in_1: [string, string] = ...

`Readonly`failed_to_read_0_when_processing_project_document

failed_to_read_0_when_processing_project_document: [string] = ...

`Readonly`failed_to_resolve_link_to_0_in_comment_for_1

failed_to_resolve_link_to_0_in_comment_for_1: [string, string] = ...

`Readonly`failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2

failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2: [string, string, string] = ...

`Readonly`failed_to_resolve_link_to_0_in_document_1

failed_to_resolve_link_to_0_in_document_1: [string, string] = ...

`Readonly`failed_to_resolve_link_to_0_in_document_1_may_have_meant_2

failed_to_resolve_link_to_0_in_document_1_may_have_meant_2: [string, string, string] = ...

`Readonly`failed_to_resolve_link_to_0_in_readme_for_1

failed_to_resolve_link_to_0_in_readme_for_1: [string, string] = ...

`Readonly`failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2

failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2: [string, string, string] = ...

`Readonly`file_0_not_an_object

file_0_not_an_object: [string] = ...

`Readonly`flag_0_is_not_valid_for_1_expected_2

flag_0_is_not_valid_for_1_expected_2: [string, string, string] = "The flag '{0}' is not valid for {1}, expected one of {2}"

`Readonly`flag_abstract

flag_abstract: [] = "Abstract"

`Readonly`flag_const

flag_const: [] = "Const"

`Readonly`flag_external

flag_external: [] = "External"

`Readonly`flag_inherited

flag_inherited: [] = "Inherited"

`Readonly`flag_optional

flag_optional: [] = "Optional"

`Readonly`flag_private

flag_private: [] = "Private"

`Readonly`flag_protected

flag_protected: [] = "Protected"

`Readonly`flag_public

flag_public: [] = "Public"

`Readonly`flag_readonly

flag_readonly: [] = "Readonly"

`Readonly`flag_rest

flag_rest: [] = "Rest"

`Readonly`flag_static

flag_static: [] = "Static"

`Readonly`flag_values_for_0_must_be_booleans

flag_values_for_0_must_be_booleans: [string] = "Flag values for {0} must be a boolean"

`Readonly`found_0_errors_and_1_warnings

found_0_errors_and_1_warnings: [string, string] = "Found {0} errors and {1} warnings"

`Readonly`frontmatter_children_0_should_be_an_array_of_strings_or_object_with_string_values

frontmatter_children_0_should_be_an_array_of_strings_or_object_with_string_values: [string] = "Frontmatter children in {0} should be an array of strings or an object with string values"

`Readonly`git_remote_0_not_valid

git_remote_0_not_valid: [string] = ...

`Readonly`glob_0_did_not_match_any_files

glob_0_did_not_match_any_files: [string] = ...

`Readonly`help_alwaysCreateEntryPointModule

help_alwaysCreateEntryPointModule: [] = "When set, TypeDoc will always create a `Module` for entry points, even if only one is provided"

`Readonly`help_basePath

help_basePath: [] = "Specifies the base path to be used when displaying file paths"

`Readonly`help_blockTags

help_blockTags: [] = "Block tags which TypeDoc should recognize when parsing comments"

`Readonly`help_cacheBust

help_cacheBust: [] = "Include the generation time in links to static assets"

`Readonly`help_categorizeByGroup

help_categorizeByGroup: [] = "Specify whether categorization will be done at the group level"

`Readonly`help_categoryOrder

help_categoryOrder: [] = "Specify the order in which categories appear. * indicates the relative order for categories not in the list"

`Readonly`help_cleanOutputDir

help_cleanOutputDir: [] = "If set, TypeDoc will remove the output directory before writing output"

`Readonly`help_cname

help_cname: [] = "Set the CNAME file text, it's useful for custom domains on GitHub Pages"

`Readonly`help_commentStyle

help_commentStyle: [] = "Determines how TypeDoc searches for comments"

`Readonly`help_compilerOptions

help_compilerOptions: [] = "Selectively override the TypeScript compiler options used by TypeDoc"

`Readonly`help_customCss

help_customCss: [] = "Path to a custom CSS file to for the theme to import"

`Readonly`help_customFooterHtml

help_customFooterHtml: [] = "Custom footer after the TypeDoc link"

`Readonly`help_customFooterHtmlDisableWrapper

help_customFooterHtmlDisableWrapper: [] = "If set, disables the wrapper element for customFooterHtml"

`Readonly`help_customJs

help_customJs: [] = "Path to a custom JS file to import"

`Readonly`help_darkHighlightTheme

help_darkHighlightTheme: [] = "Specify the code highlighting theme in dark mode"

`Readonly`help_defaultCategory

help_defaultCategory: [] = "Specify the default category for reflections without a category"

`Readonly`help_disableGit

help_disableGit: [] = "Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath"

`Readonly`help_disableSources

help_disableSources: [] = "Disable setting the source of a reflection when documenting it"

`Readonly`help_emit

help_emit: [] = "Specify what TypeDoc should emit, 'docs', 'both', or 'none'"

`Readonly`help_entryPoints

help_entryPoints: [] = "The entry points of your documentation"

`Readonly`help_entryPointStrategy

help_entryPointStrategy: [] = "The strategy to be used to convert entry points into documentation modules"

`Readonly`help_exclude

help_exclude: [] = "Define patterns to be excluded when expanding a directory that was specified as an entry point"

`Readonly`help_excludeCategories

help_excludeCategories: [] = "Exclude symbols within this category from the documentation"

`Readonly`help_excludeExternals

help_excludeExternals: [] = "Prevent externally resolved symbols from being documented"

`Readonly`help_excludeInternal

help_excludeInternal: [] = "Prevent symbols that are marked with @internal from being documented"

`Readonly`help_excludeNotDocumented

help_excludeNotDocumented: [] = "Prevent symbols that are not explicitly documented from appearing in the results"

`Readonly`help_excludeNotDocumentedKinds

help_excludeNotDocumentedKinds: [] = "Specify the type of reflections that can be removed by excludeNotDocumented"

`Readonly`help_excludePrivate

help_excludePrivate: [] = "Ignore private variables and methods, defaults to true."

`Readonly`help_excludeProtected

help_excludeProtected: [] = "Ignore protected variables and methods"

`Readonly`help_excludeReferences

help_excludeReferences: [] = "If a symbol is exported multiple times, ignore all but the first export"

`Readonly`help_excludeTags

help_excludeTags: [] = "Remove the listed block/modifier tags from doc comments"

`Readonly`help_externalPattern

help_externalPattern: [] = "Define patterns for files that should be considered being external"

`Readonly`help_externalSymbolLinkMappings

help_externalSymbolLinkMappings: [] = "Define custom links for symbols not included in the documentation"

`Readonly`help_githubPages

help_githubPages: [] = "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`"

`Readonly`help_gitRemote

help_gitRemote: [] = "Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set"

`Readonly`help_gitRevision

help_gitRevision: [] = "Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set"

`Readonly`help_groupOrder

help_groupOrder: [] = "Specify the order in which groups appear. * indicates the relative order for groups not in the list"

`Readonly`help_headings

help_headings: [] = "Determines which optional headings are rendered"

`Readonly`help_help

help_help: [] = "Print this message"

`Readonly`help_hideGenerator

help_hideGenerator: [] = "Do not print the TypeDoc link at the end of the page"

`Readonly`help_hideParameterTypesInTitle

help_hideParameterTypesInTitle: [] = "Hides parameter types in signature titles for easier scanning"

`Readonly`help_highlightLanguages

help_highlightLanguages: [] = "Specify the languages which will be loaded to highlight code when rendering"

`Readonly`help_hostedBaseUrl

help_hostedBaseUrl: [] = "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated"

`Readonly`help_includeVersion

help_includeVersion: [] = "Add the package version to the project name"

`Readonly`help_inlineTags

help_inlineTags: [] = "Inline tags which TypeDoc should recognize when parsing comments"

`Readonly`help_intentionallyNotExported

help_intentionallyNotExported: [] = "A list of types which should not produce 'referenced but not documented' warnings"

`Readonly`help_jsDocCompatibility

help_jsDocCompatibility: [] = "Sets compatibility options for comment parsing that increase similarity with JSDoc comments"

`Readonly`help_json

help_json: [] = "Specify the location and filename a JSON file describing the project is written to"

`Readonly`help_kindSortOrder

help_kindSortOrder: [] = "Specify the sort order for reflections when 'kind' is specified"

`Readonly`help_lang

help_lang: [] = "Sets the language to be used in generation and in TypeDoc's messages"

`Readonly`help_lightHighlightTheme

help_lightHighlightTheme: [] = "Specify the code highlighting theme in light mode"

`Readonly`help_locales

help_locales: [] = "Add translations for a specified locale. This option is primarily intended to be used as a stopgap while waiting for official locale support to be added to TypeDoc"

`Readonly`help_logLevel

help_logLevel: [] = "Specify what level of logging should be used"

`Readonly`help_markdownItLoader

help_markdownItLoader: [] = "Specify a callback to be called when loading the markdown-it instance. Will be passed the instance of the parser which TypeDoc will use"

`Readonly`help_markdownItOptions

help_markdownItOptions: [] = "Specify the options passed to markdown-it, the Markdown parser used by TypeDoc"

`Readonly`help_markdownLinkExternal

help_markdownLinkExternal: [] = "Specifies that http[s]:// links in comments and markdown files should be treated as external links to be opened in a new tab"

`Readonly`help_maxTypeConversionDepth

help_maxTypeConversionDepth: [] = "Set the maximum depth of types to be converted"

`Readonly`help_modifierTags

help_modifierTags: [] = "Modifier tags which TypeDoc should recognize when parsing comments"

`Readonly`help_name

help_name: [] = "Set the name of the project that will be used in the header of the template"

`Readonly`help_navigation

help_navigation: [] = "Determines how the navigation sidebar is organized"

`Readonly`help_navigationLeaves

help_navigationLeaves: [] = "Branches of the navigation tree which should not be expanded"

`Readonly`help_navigationLinks

help_navigationLinks: [] = "Defines links to be included in the header"

`Readonly`help_options

help_options: [] = "Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory"

`Readonly`help_out

help_out: [] = "Specify the location the documentation should be written to"

`Readonly`help_packageOptions

help_packageOptions: [] = "Set options which will be set within each package when entryPointStrategy is set to packages"

`Readonly`help_plugin

help_plugin: [] = "Specify the npm plugins that should be loaded. Omit to load all installed plugins"

`Readonly`help_preserveLinkText

help_preserveLinkText: [] = "If set, @link tags without link text will use the text content as the link. If not set, will use the target reflection name"

`Readonly`help_preserveWatchOutput

help_preserveWatchOutput: [] = "If set, TypeDoc will not clear the screen between compilation runs"

`Readonly`help_pretty

help_pretty: [] = "Specify whether the output JSON should be formatted with tabs"

`Readonly`help_projectDocuments

help_projectDocuments: [] = "Documents which should be added as children to the root of the generated documentation. Supports globs to match multiple files"

`Readonly`help_readme

help_readme: [] = "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page"

`Readonly`help_requiredToBeDocumented

help_requiredToBeDocumented: [] = "A list of reflection kinds that must be documented"

`Readonly`help_searchCategoryBoosts

help_searchCategoryBoosts: [] = "Configure search to give a relevance boost to selected categories"

`Readonly`help_searchGroupBoosts

help_searchGroupBoosts: [] = 'Configure search to give a relevance boost to selected kinds (eg "class")'

`Readonly`help_searchInComments

help_searchInComments: [] = "If set, the search index will also include comments. This will greatly increase the size of the search index"

`Readonly`help_searchInDocuments

help_searchInDocuments: [] = "If set, the search index will also include documents. This will greatly increase the size of the search index"

`Readonly`help_showConfig

help_showConfig: [] = "Print the resolved configuration and exit"

`Readonly`help_sidebarLinks

help_sidebarLinks: [] = "Defines links to be included in the sidebar"

`Readonly`help_skipErrorChecking

help_skipErrorChecking: [] = "Do not run TypeScript's type checking before generating docs"

`Readonly`help_sort

help_sort: [] = "Specify the sort strategy for documented values"

`Readonly`help_sortEntryPoints

help_sortEntryPoints: [] = "If set, entry points will be subject to the same sorting rules as other reflections"

`Readonly`help_sourceLinkExternal

help_sourceLinkExternal: [] = "Specifies that source links should be treated as external links to be opened in a new tab"

`Readonly`help_sourceLinkTemplate

help_sourceLinkTemplate: [] = "Specify a link template to be used when generating source urls. If not set, will be automatically created using the git remote. Supports {path}, {line}, {gitRevision} placeholders"

`Readonly`help_theme

help_theme: [] = "Specify the theme name to render the documentation with"

`Readonly`help_titleLink

help_titleLink: [] = "Set the link the title in the header points to. Defaults to the documentation homepage"

`Readonly`help_treatValidationWarningsAsErrors

help_treatValidationWarningsAsErrors: [] = "If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings"

`Readonly`help_treatWarningsAsErrors

help_treatWarningsAsErrors: [] = "If set, all warnings will be treated as errors"

`Readonly`help_tsconfig

help_tsconfig: [] = "Specify a TypeScript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory"

`Readonly`help_useHostedBaseUrlForAbsoluteLinks

help_useHostedBaseUrlForAbsoluteLinks: [] = "If set, TypeDoc will produce absolute links to pages on your site using the hostedBaseUrl option"

`Readonly`help_useTsLinkResolution

help_useTsLinkResolution: [] = "Use TypeScript's link resolution when determining where @link tags point. This only applies to JSDoc style comments"

`Readonly`help_validation

help_validation: [] = "Specify which validation steps TypeDoc should perform on your generated documentation"

`Readonly`help_version

help_version: [] = "Print TypeDoc's version"

`Readonly`help_visibilityFilters

help_visibilityFilters: [] = "Specify the default visibility for builtin filters and additional filters according to modifier tags"

`Readonly`help_watch

help_watch: [] = "Watch files for changes and rebuild docs on change"

`Readonly`highlight_theme_0_must_be_one_of_1

highlight_theme_0_must_be_one_of_1: [string, string] = "{0} must be one of the following: {1}"

`Readonly`highlightLanguages_contains_invalid_languages_0

highlightLanguages_contains_invalid_languages_0: [string] = "highlightLanguages contains invalid languages: {0}, run typedoc --help for a list of supported languages"

`Readonly`hostedBaseUrl_must_start_with_http

hostedBaseUrl_must_start_with_http: [] = "hostedBaseUrl must start with http:// or https://"

`Readonly`inheritdoc_circular_inheritance_chain_0

inheritdoc_circular_inheritance_chain_0: [string] = ...

`Readonly`inheritdoc_tag_properly_capitalized

inheritdoc_tag_properly_capitalized: [] = "The @inheritDoc tag should be properly capitalized"

`Readonly`inline_inheritdoc_should_not_appear_in_block_tag_in_comment_at_0

inline_inheritdoc_should_not_appear_in_block_tag_in_comment_at_0: [string] = "An inline @inheritDoc tag should not appear within a block tag as it will not be processed in comment at {0}"

`Readonly`inline_tag_not_closed

inline_tag_not_closed: [] = ...

`Readonly`invalid_intentionally_not_exported_symbols_0

invalid_intentionally_not_exported_symbols_0: [string] = "The following symbols were marked as intentionally not exported, but were either not referenced in the documentation, or were exported:\n\t{0}"

`Readonly`invalid_plugin_0_missing_load_function

invalid_plugin_0_missing_load_function: [string] = ...

`Readonly`invalid_tsdoc_json_0

invalid_tsdoc_json_0: [string] = ...

`Readonly`json_written_to_0

json_written_to_0: [string] = "JSON written to {0}"

`Readonly`kind_accessor

kind_accessor: [] = "Accessor"

`Readonly`kind_call_signature

kind_call_signature: [] = "Call Signature"

`Readonly`kind_class

kind_class: [] = "Class"

`Readonly`kind_constructor

kind_constructor: [] = "Constructor"

`Readonly`kind_constructor_signature

kind_constructor_signature: [] = "Constructor Signature"

`Readonly`kind_document

kind_document: [] = "Document"

`Readonly`kind_enum

kind_enum: [] = "Enumeration"

`Readonly`kind_enum_member

kind_enum_member: [] = "Enumeration Member"

`Readonly`kind_function

kind_function: [] = "Function"

`Readonly`kind_get_signature

kind_get_signature: [] = "Get Signature"

`Readonly`kind_index_signature

kind_index_signature: [] = "Index Signature"

`Readonly`kind_interface

kind_interface: [] = "Interface"

`Readonly`kind_method

kind_method: [] = "Method"

`Readonly`kind_module

kind_module: [] = "Module"

`Readonly`kind_namespace

kind_namespace: [] = "Namespace"

`Readonly`kind_parameter

kind_parameter: [] = "Parameter"

`Readonly`kind_plural_accessor

kind_plural_accessor: [] = "Accessors"

`Readonly`kind_plural_call_signature

kind_plural_call_signature: [] = "Call Signatures"

`Readonly`kind_plural_class

kind_plural_class: [] = "Classes"

`Readonly`kind_plural_constructor

kind_plural_constructor: [] = "Constructors"

`Readonly`kind_plural_constructor_signature

kind_plural_constructor_signature: [] = "Constructor Signatures"

`Readonly`kind_plural_document

kind_plural_document: [] = "Documents"

`Readonly`kind_plural_enum

kind_plural_enum: [] = "Enumerations"

`Readonly`kind_plural_enum_member

kind_plural_enum_member: [] = "Enumeration Members"

`Readonly`kind_plural_function

kind_plural_function: [] = "Functions"

`Readonly`kind_plural_get_signature

kind_plural_get_signature: [] = "Get Signatures"

`Readonly`kind_plural_index_signature

kind_plural_index_signature: [] = "Index Signatures"

`Readonly`kind_plural_interface

kind_plural_interface: [] = "Interfaces"

`Readonly`kind_plural_method

kind_plural_method: [] = "Methods"

`Readonly`kind_plural_module

kind_plural_module: [] = "Modules"

`Readonly`kind_plural_namespace

kind_plural_namespace: [] = "Namespaces"

`Readonly`kind_plural_parameter

kind_plural_parameter: [] = "Parameters"

`Readonly`kind_plural_project

kind_plural_project: [] = "Projects"

`Readonly`kind_plural_property

kind_plural_property: [] = "Properties"

`Readonly`kind_plural_reference

kind_plural_reference: [] = "References"

`Readonly`kind_plural_set_signature

kind_plural_set_signature: [] = "Set Signatures"

`Readonly`kind_plural_type_alias

kind_plural_type_alias: [] = "Type Aliases"

`Readonly`kind_plural_type_literal

kind_plural_type_literal: [] = "Type Literals"

`Readonly`kind_plural_type_parameter

kind_plural_type_parameter: [] = "Type Parameters"

`Readonly`kind_plural_variable

kind_plural_variable: [] = "Variables"

`Readonly`kind_project

kind_project: [] = "Project"

`Readonly`kind_property

kind_property: [] = "Property"

`Readonly`kind_reference

kind_reference: [] = "Reference"

`Readonly`kind_set_signature

kind_set_signature: [] = "Set Signature"

`Readonly`kind_type_alias

kind_type_alias: [] = "Type Alias"

`Readonly`kind_type_literal

kind_type_literal: [] = "Type Literal"

`Readonly`kind_type_parameter

kind_type_parameter: [] = "Type Parameter"

`Readonly`kind_variable

kind_variable: [] = "Variable"

`Readonly`label_0_for_1_cannot_be_referenced

label_0_for_1_cannot_be_referenced: [string, string] = ...

`Readonly`loaded_multiple_times_0

loaded_multiple_times_0: [string] = "TypeDoc has been loaded multiple times. This is commonly caused by plugins which have their own installation of TypeDoc. The loaded paths are:\n\t{0}"

`Readonly`loaded_plugin_0

loaded_plugin_0: [string] = ...

`Readonly`locales_must_be_an_object

locales_must_be_an_object: [] = "The 'locales' option must be set to an object which resembles: { en: { theme_implements: \"Implements\" }}"

`Readonly`merging_converted_projects

merging_converted_projects: [] = "Merging converted projects"

`Readonly`modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2

modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2: [string, string, string] = ...

`Readonly`multiple_type_parameters_on_template_tag_unsupported

multiple_type_parameters_on_template_tag_unsupported: [] = ...

`Readonly`nested_packages_unsupported_0

nested_packages_unsupported_0: [string] = "Project at {0} has entryPointStrategy set to packages, but nested packages are not supported"

`Readonly`no_compiler_options_set

no_compiler_options_set: [] = "No compiler options set. This likely means that TypeDoc did not find your tsconfig.json. Generated documentation will probably be empty"

`Readonly`no_entry_points_for_packages

no_entry_points_for_packages: [] = "No entry points provided to packages mode, documentation cannot be generated"

`Readonly`no_entry_points_provided

no_entry_points_provided: [] = "No entry points were provided, this is likely a misconfiguration"

`Readonly`no_entry_points_to_merge

no_entry_points_to_merge: [] = "No entry points provided to merge"

`Readonly`not_all_search_category_boosts_used_0

not_all_search_category_boosts_used_0: [string] = ...

`Readonly`not_all_search_group_boosts_used_0

not_all_search_group_boosts_used_0: [string] = ...

`Readonly`open_brace_within_inline_tag

open_brace_within_inline_tag: [] = ...

`Readonly`option_0_can_only_be_specified_by_config_file

option_0_can_only_be_specified_by_config_file: [string] = ...

`Readonly`option_0_expected_a_value_but_none_provided

option_0_expected_a_value_but_none_provided: [string] = ...

`Readonly`option_0_must_be_a_function

option_0_must_be_a_function: [string] = "The '{0}' option must be a function"

`Readonly`option_0_must_be_an_object

option_0_must_be_an_object: [string] = "The '{0}' option must be a non-array object"

`Readonly`option_0_must_be_between_1_and_2

option_0_must_be_between_1_and_2: [string, string, string] = "{0} must be between {1} and {2}"

`Readonly`option_0_must_be_equal_to_or_greater_than_1

option_0_must_be_equal_to_or_greater_than_1: [string, string] = "{0} must be equal to or greater than {1}"

`Readonly`option_0_must_be_less_than_or_equal_to_1

option_0_must_be_less_than_or_equal_to_1: [string, string] = "{0} must be less than or equal to {1}"

`Readonly`option_0_must_be_object_with_urls

option_0_must_be_object_with_urls: [string] = ...

`Readonly`option_0_must_be_one_of_1

option_0_must_be_one_of_1: [string, string] = "{0} must be one of {1}"

`Readonly`option_0_specified_1_but_only_2_is_valid

option_0_specified_1_but_only_2_is_valid: [string, string, string] = ...

`Readonly`option_0_values_must_be_array_of_tags

option_0_values_must_be_array_of_tags: [string] = "{0} must be an array of valid tag names"

`Readonly`option_0_values_must_be_numbers

option_0_values_must_be_numbers: [string] = "All values of {0} must be numbers"

`Readonly`options_file_0_does_not_exist

options_file_0_does_not_exist: [string] = ...

`Readonly`plugin_0_could_not_be_loaded

plugin_0_could_not_be_loaded: [string] = ...

`Readonly`previous_error_occurred_when_reading_options_for_0

previous_error_occurred_when_reading_options_for_0: [string] = "The previous error occurred when reading options for the package at {0}"

`Readonly`provided_readme_at_0_could_not_be_read

provided_readme_at_0_could_not_be_read: [string] = ...

`Readonly`reflection_0_kind_1_defined_in_2_does_not_have_any_documentation

reflection_0_kind_1_defined_in_2_does_not_have_any_documentation: [string, string, string] = ...

`Readonly`reflection_0_tried_to_copy_comment_from_1_but_source_had_no_comment

reflection_0_tried_to_copy_comment_from_1_but_source_had_no_comment: [string, string] = ...

`Readonly`relative_path_0_is_not_a_file_and_will_not_be_copied_to_output

relative_path_0_is_not_a_file_and_will_not_be_copied_to_output: [string] = ...

`Readonly`saved_relative_path_0_resolved_from_1_is_not_a_file

saved_relative_path_0_resolved_from_1_is_not_a_file: [string, string] = ...

`Readonly`serialized_project_referenced_0_not_part_of_project

serialized_project_referenced_0_not_part_of_project: [string] = ...

`Readonly`signature_0_has_unused_param_with_name_1

signature_0_has_unused_param_with_name_1: [string, string] = ...

`Readonly`solution_not_supported_in_watch_mode

solution_not_supported_in_watch_mode: [] = "The provided tsconfig file looks like a solution style tsconfig, which is not supported in watch mode"

`Readonly`strategy_not_supported_in_watch_mode

strategy_not_supported_in_watch_mode: [] = "entryPointStrategy must be set to either resolve or expand for watch mode"

`Readonly`symbol_0_has_multiple_declarations_with_comment

symbol_0_has_multiple_declarations_with_comment: [string] = ...

tag_abstract

tag_abstract: []

tag_alpha

tag_alpha: []

tag_augments

tag_augments: []

tag_author

tag_author: []

tag_beta

tag_beta: []

tag_callback

tag_callback: []

tag_category

tag_category: []

tag_categoryDescription

tag_categoryDescription: []

tag_class

tag_class: []

tag_default

tag_default: []

tag_defaultValue

tag_defaultValue: []

tag_deprecated

tag_deprecated: []

tag_document

tag_document: []

tag_enum

tag_enum: []

tag_event

tag_event: []

tag_eventProperty

tag_eventProperty: []

tag_example

tag_example: []

tag_experimental

tag_experimental: []

tag_extends

tag_extends: []

tag_group

tag_group: []

tag_groupDescription

tag_groupDescription: []

tag_hidden

tag_hidden: []

tag_hideCategories

tag_hideCategories: []

tag_hideconstructor

tag_hideconstructor: []

tag_hideGroups

tag_hideGroups: []

tag_ignore

tag_ignore: []

tag_import

tag_import: []

tag_inheritDoc

tag_inheritDoc: []

tag_interface

tag_interface: []

tag_internal

tag_internal: []

tag_jsx

tag_jsx: []

tag_label

tag_label: []

tag_license

tag_license: []

tag_link

tag_link: []

tag_linkcode

tag_linkcode: []

tag_linkplain

tag_linkplain: []

tag_module

tag_module: []

tag_namespace

tag_namespace: []

tag_overload

tag_overload: []

tag_override

tag_override: []

tag_packageDocumentation

tag_packageDocumentation: []

tag_param

tag_param: []

tag_private

tag_private: []

tag_privateRemarks

tag_privateRemarks: []

tag_prop

tag_prop: []

tag_property

tag_property: []

tag_protected

tag_protected: []

tag_public

tag_public: []

tag_readonly

tag_readonly: []

tag_remarks

tag_remarks: []

tag_return

tag_return: []

tag_returns

tag_returns: []

tag_satisfies

tag_satisfies: []

tag_sealed

tag_sealed: []

tag_see

tag_see: []

tag_showCategories

tag_showCategories: []

tag_showGroups

tag_showGroups: []

tag_since

tag_since: []

tag_template

tag_template: []

tag_throws

tag_throws: []

tag_type

tag_type: []

tag_typedef

tag_typedef: []

tag_typeParam

tag_typeParam: []

tag_virtual

tag_virtual: []

tag_yields

tag_yields: []

`Readonly`tags_0_defined_in_typedoc_json_overwritten_by_tsdoc_json

tags_0_defined_in_typedoc_json_overwritten_by_tsdoc_json: [string] = ...

`Readonly`theme_0_is_not_defined_available_are_1

theme_0_is_not_defined_available_are_1: [string, string] = ...

`Readonly`theme_class_hierarchy_title

theme_class_hierarchy_title: [] = "Class Hierarchy"

`Readonly`theme_copied

theme_copied: [] = "Copied!"

`Readonly`theme_copy

theme_copy: [] = "Copy"

`Readonly`theme_dark

theme_dark: [] = "Dark"

`Readonly`theme_defined_in

theme_defined_in: [] = "Defined in"

`Readonly`theme_generated_using_typedoc

theme_generated_using_typedoc: [] = "Generated using TypeDoc"

`Readonly`theme_hierarchy

theme_hierarchy: [] = "Hierarchy"

`Readonly`theme_hierarchy_view_full

theme_hierarchy_view_full: [] = "view full"

`Readonly`theme_implementation_of

theme_implementation_of: [] = "Implementation of"

`Readonly`theme_implemented_by

theme_implemented_by: [] = "Implemented by"

`Readonly`theme_implements

theme_implements: [] = "Implements"

`Readonly`theme_index

theme_index: [] = "Index"

`Readonly`theme_indexable

theme_indexable: [] = "Indexable"

`Readonly`theme_inherited_from

theme_inherited_from: [] = "Inherited from"

`Readonly`theme_light

theme_light: [] = "Light"

`Readonly`theme_loading

theme_loading: [] = "Loading..."

`Readonly`theme_member_visibility

theme_member_visibility: [] = "Member Visibility"

`Readonly`theme_menu

theme_menu: [] = "Menu"

`Readonly`theme_normally_hidden

theme_normally_hidden: [] = "This member is normally hidden due to your filter settings."

`Readonly`theme_on_this_page

theme_on_this_page: [] = "On This Page"

`Readonly`theme_os

theme_os: [] = "OS"

`Readonly`theme_overrides

theme_overrides: [] = "Overrides"

`Readonly`theme_permalink

theme_permalink: [] = "Permalink"

`Readonly`theme_preparing_search_index

theme_preparing_search_index: [] = "Preparing search index..."

`Readonly`theme_re_exports

theme_re_exports: [] = "Re-exports"

`Readonly`theme_renames_and_re_exports

theme_renames_and_re_exports: [] = "Renames and re-exports"

`Readonly`theme_returns

theme_returns: [] = "Returns"

`Readonly`theme_search

theme_search: [] = "Search"

`Readonly`theme_search_index_not_available

theme_search_index_not_available: [] = "The search index is not available"

`Readonly`theme_settings

theme_settings: [] = "Settings"

`Readonly`theme_theme

theme_theme: [] = "Theme"

`Readonly`theme_type_declaration

theme_type_declaration: [] = "Type declaration"

`Readonly`treating_unrecognized_tag_0_as_modifier

treating_unrecognized_tag_0_as_modifier: [string] = ...

`Readonly`tsconfig_file_0_does_not_exist

tsconfig_file_0_does_not_exist: [string] = ...

`Readonly`tsconfig_file_specifies_options_file

tsconfig_file_specifies_options_file: [] = ...

`Readonly`tsconfig_file_specifies_tsconfig_file

tsconfig_file_specifies_tsconfig_file: [] = ...

`Readonly`type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs

type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs: [string, string, string] = ...

`Readonly`typedoc_key_in_0_ignored

typedoc_key_in_0_ignored: [string] = ...

`Readonly`typedoc_options_must_be_object_in_0

typedoc_options_must_be_object_in_0: [string] = ...

`Readonly`unable_to_find_any_entry_points

unable_to_find_any_entry_points: [] = "Unable to find any entry points. See previous warnings"

`Readonly`unescaped_open_brace_without_inline_tag

unescaped_open_brace_without_inline_tag: [] = ...

`Readonly`unknown_block_tag_0

unknown_block_tag_0: [string] = ...

`Readonly`unknown_inline_tag_0

unknown_inline_tag_0: [string] = ...

`Readonly`unknown_option_0_may_have_meant_1

unknown_option_0_may_have_meant_1: [string, string] = ...

`Readonly`unknown_option_0_you_may_have_meant_1

unknown_option_0_you_may_have_meant_1: [string, string] = ...

`Readonly`unloaded_language_0_not_highlighted_in_comment_for_1

unloaded_language_0_not_highlighted_in_comment_for_1: [string, string] = ...

`Readonly`unmatched_closing_brace

unmatched_closing_brace: [] = ...

`Readonly`unsupported_highlight_language_0_not_highlighted_in_comment_for_1

unsupported_highlight_language_0_not_highlighted_in_comment_for_1: [string, string] = ...

`Readonly`unsupported_ts_version_0

unsupported_ts_version_0: [string] = "You are running with an unsupported TypeScript version! If TypeDoc crashes, this is why. TypeDoc supports {0}"

`Readonly`use_expand_or_glob_for_files_in_dir

use_expand_or_glob_for_files_in_dir: [] = ...

`Readonly`useHostedBaseUrlForAbsoluteLinks_requires_hostedBaseUrl

useHostedBaseUrlForAbsoluteLinks_requires_hostedBaseUrl: [] = "The useHostedBaseUrlForAbsoluteLinks option requires that hostedBaseUrl be set"

`Readonly`visibility_filters_must_be_booleans

visibility_filters_must_be_booleans: [] = ...

`Readonly`visibility_filters_only_include_0

visibility_filters_only_include_0: [string] = ...

`Readonly`watch_does_not_support_merge_mode

watch_does_not_support_merge_mode: [] = "Watch mode does not support 'merge' style entry points"

`Readonly`watch_does_not_support_packages_mode

watch_does_not_support_packages_mode: [] = "Watch mode does not support 'packages' style entry points"

`Readonly`yaml_frontmatter_not_an_object

yaml_frontmatter_not_an_object: [] = ...

Interface TranslatableStrings

What is translatable?

Interface Keys

Example

Hierarchy

Index

Properties

Properties

Readonlyat_most_one_inheritdoc_tag_expected_in_comment_at_0

Readonlyat_most_one_remarks_tag_expected_in_comment_at_0

Readonlyat_most_one_returns_tag_expected_in_comment_at_0

Readonlycircular_reference_extends_0

Readonlycomment_for_0_includes_categoryDescription_for_1_but_no_child_in_group

Readonlycomment_for_0_includes_groupDescription_for_1_but_no_child_in_group

Readonlycomment_for_0_should_not_contain_block_or_modifier_tags

Readonlycomments_for_0_are_declared_at_1

Readonlycontent_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0

Readonlycontent_in_summary_overwritten_by_inheritdoc_in_comment_at_0

Readonlyconverting_0_as_class_requires_value_declaration

Readonlyconverting_0_as_class_without_construct_signatures

Readonlyconverting_project_at_0

Readonlyconverting_union_as_interface

Readonlycould_not_create_output_directory_0

Readonlycould_not_empty_output_directory_0

Readonlycould_not_write_0

Readonlycustom_css_file_0_does_not_exist

Readonlycustom_js_file_0_does_not_exist

Readonlycustom_theme_does_not_define_getSlugger

Readonlydeclaration_reference_in_inheritdoc_for_0_not_fully_parsed

Readonlydefaulting_project_name

Readonlydisable_git_set_and_git_revision_used

Readonlydisable_git_set_but_not_source_link_template

Readonlydocs_could_not_be_generated

Readonlydocs_generated_at_0

Readonlyentry_point_0_did_not_exist

Readonlyentry_point_0_did_not_match_any_files_after_exclude

Readonlyentry_point_0_did_not_match_any_packages

Readonlyentry_point_0_not_in_program

Readonlyentrypoint_did_not_match_files_0

Readonlyexample_tag_literal_name

Readonlyexclude_not_documented_specified_0_valid_values_are_1

Readonlyexpected_object_with_flag_values_for_0

Readonlyexternal_symbol_link_mappings_must_be_object

Readonlyfailed_read_options_file_0

Readonlyfailed_read_tsdoc_json_0

Readonlyfailed_resolve_0_to_file_in_1

Readonlyfailed_to_convert_packages

Readonlyfailed_to_find_0_to_inherit_comment_from_in_1

Readonlyfailed_to_find_jsdoc_tag_for_name_0

Readonlyfailed_to_find_packages

Readonlyfailed_to_parse_json_0

Readonlyfailed_to_read_0_when_processing_document_child_in_1

Readonlyfailed_to_read_0_when_processing_document_tag_in_1

Readonlyfailed_to_read_0_when_processing_project_document

Readonlyfailed_to_resolve_link_to_0_in_comment_for_1

Readonlyfailed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2

Readonlyfailed_to_resolve_link_to_0_in_document_1

Readonlyfailed_to_resolve_link_to_0_in_document_1_may_have_meant_2

Readonlyfailed_to_resolve_link_to_0_in_readme_for_1

Readonlyfailed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2

Readonlyfile_0_not_an_object

Readonlyflag_0_is_not_valid_for_1_expected_2

Readonlyflag_abstract

Readonlyflag_const

Readonlyflag_external

Readonlyflag_inherited

Readonlyflag_optional

Readonlyflag_private

Readonlyflag_protected

Readonlyflag_public

Readonlyflag_readonly

Readonlyflag_rest

Readonlyflag_static

Readonlyflag_values_for_0_must_be_booleans

Readonlyfound_0_errors_and_1_warnings

Readonlyfrontmatter_children_0_should_be_an_array_of_strings_or_object_with_string_values

Readonlygit_remote_0_not_valid

Readonlyglob_0_did_not_match_any_files

Readonlyhelp_alwaysCreateEntryPointModule

Readonlyhelp_basePath

`Readonly`at_most_one_inheritdoc_tag_expected_in_comment_at_0

`Readonly`at_most_one_remarks_tag_expected_in_comment_at_0

`Readonly`at_most_one_returns_tag_expected_in_comment_at_0

`Readonly`circular_reference_extends_0

`Readonly`comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group

`Readonly`comment_for_0_includes_groupDescription_for_1_but_no_child_in_group

`Readonly`comment_for_0_should_not_contain_block_or_modifier_tags

`Readonly`comments_for_0_are_declared_at_1

`Readonly`content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0

`Readonly`content_in_summary_overwritten_by_inheritdoc_in_comment_at_0

`Readonly`converting_0_as_class_requires_value_declaration

`Readonly`converting_0_as_class_without_construct_signatures

`Readonly`converting_project_at_0

`Readonly`converting_union_as_interface

`Readonly`could_not_create_output_directory_0

`Readonly`could_not_empty_output_directory_0

`Readonly`could_not_write_0

`Readonly`custom_css_file_0_does_not_exist

`Readonly`custom_js_file_0_does_not_exist

`Readonly`custom_theme_does_not_define_getSlugger

`Readonly`declaration_reference_in_inheritdoc_for_0_not_fully_parsed

`Readonly`defaulting_project_name

`Readonly`disable_git_set_and_git_revision_used

`Readonly`disable_git_set_but_not_source_link_template

`Readonly`docs_could_not_be_generated

`Readonly`docs_generated_at_0

`Readonly`entry_point_0_did_not_exist

`Readonly`entry_point_0_did_not_match_any_files_after_exclude

`Readonly`entry_point_0_did_not_match_any_packages

`Readonly`entry_point_0_not_in_program

`Readonly`entrypoint_did_not_match_files_0

`Readonly`example_tag_literal_name

`Readonly`exclude_not_documented_specified_0_valid_values_are_1

`Readonly`expected_object_with_flag_values_for_0

`Readonly`external_symbol_link_mappings_must_be_object

`Readonly`failed_read_options_file_0

`Readonly`failed_read_tsdoc_json_0

`Readonly`failed_resolve_0_to_file_in_1

`Readonly`failed_to_convert_packages

`Readonly`failed_to_find_0_to_inherit_comment_from_in_1

`Readonly`failed_to_find_jsdoc_tag_for_name_0

`Readonly`failed_to_find_packages

`Readonly`failed_to_parse_json_0

`Readonly`failed_to_read_0_when_processing_document_child_in_1

`Readonly`failed_to_read_0_when_processing_document_tag_in_1

`Readonly`failed_to_read_0_when_processing_project_document

`Readonly`failed_to_resolve_link_to_0_in_comment_for_1

`Readonly`failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2

`Readonly`failed_to_resolve_link_to_0_in_document_1

`Readonly`failed_to_resolve_link_to_0_in_document_1_may_have_meant_2

`Readonly`failed_to_resolve_link_to_0_in_readme_for_1

`Readonly`failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2

`Readonly`file_0_not_an_object

`Readonly`flag_0_is_not_valid_for_1_expected_2

`Readonly`flag_abstract

`Readonly`flag_const

`Readonly`flag_external

`Readonly`flag_inherited

`Readonly`flag_optional

`Readonly`flag_private

`Readonly`flag_protected

`Readonly`flag_public

`Readonly`flag_readonly

`Readonly`flag_rest

`Readonly`flag_static

`Readonly`flag_values_for_0_must_be_booleans

`Readonly`found_0_errors_and_1_warnings

`Readonly`frontmatter_children_0_should_be_an_array_of_strings_or_object_with_string_values

`Readonly`git_remote_0_not_valid

`Readonly`glob_0_did_not_match_any_files

`Readonly`help_alwaysCreateEntryPointModule

`Readonly`help_basePath

`Readonly`help_blockTags

`Readonly`help_cacheBust

`Readonly`help_categorizeByGroup

`Readonly`help_categoryOrder

`Readonly`help_cleanOutputDir

`Readonly`help_cname

`Readonly`help_commentStyle

`Readonly`help_compilerOptions