Function rebuildSearch

  • rebuildSearch(search, app, event, options?): Search

  • Parameters

    • search: Search
    • app: Application
    • event: RendererEvent
    • Optionaloptions: {
          formatComment?: ((comment: undefined | string, reflection: undefined | DeclarationReflection | DocumentReflection) => undefined | string);
          formatDocument?: ((document: undefined | string, reflection: undefined | DeclarationReflection | DocumentReflection) => undefined | string);
          formatName?: ((name: undefined | string, reflection: undefined | DeclarationReflection | DocumentReflection) => undefined | string);
      }
      • OptionalformatComment?: ((comment: undefined | string, reflection: undefined | DeclarationReflection | DocumentReflection) => undefined | string)
          • (comment, reflection): undefined | string

          • Parameters

            • comment: undefined | string
            • reflection: undefined | DeclarationReflection | DocumentReflection

            Returns undefined | string

      • OptionalformatDocument?: ((document: undefined | string, reflection: undefined | DeclarationReflection | DocumentReflection) => undefined | string)
          • (document, reflection): undefined | string

          • Parameters

            • document: undefined | string
            • reflection: undefined | DeclarationReflection | DocumentReflection

            Returns undefined | string

      • OptionalformatName?: ((name: undefined | string, reflection: undefined | DeclarationReflection | DocumentReflection) => undefined | string)
          • (name, reflection): undefined | string

          • Parameters

            • name: undefined | string
            • reflection: undefined | DeclarationReflection | DocumentReflection

            Returns undefined | string

    Returns Search

    Deprecated

    Use alterSearch and formatSearch instead.

Settings

Member Visibility