Interface IPluginSearchServiceHooks

Hierarchy

  • IPluginSearchServiceHooks

Properties

name onBlocksChanged onGraphRemoved onIndiceInit onIndiceReset onQuery options?

Properties

name

name: string

onBlocksChanged

onBlocksChanged: ((graph: string, changes: {
    added: SearchBlockItem[];
    removed: BlockEntity[];
}) => Promise<void>)

Type declaration

onGraphRemoved

onGraphRemoved: ((graph: string, opts?: {}) => Promise<any>)

Type declaration

    • (graph: string, opts?: {}): Promise<any>

    • Parameters

      • graph: string
      • Optional opts: {}

        Returns Promise<any>

    onIndiceInit

    onIndiceInit: ((graph: string) => Promise<boolean>)

    Type declaration

      • (graph: string): Promise<boolean>

      • Parameters

        • graph: string

        Returns Promise<boolean>

    onIndiceReset

    onIndiceReset: ((graph: string) => Promise<void>)

    Type declaration

      • (graph: string): Promise<void>

      • Parameters

        • graph: string

        Returns Promise<void>

    onQuery

    onQuery: ((graph: string, key: string, opts: Partial<{
        limit: number;
    }>) => Promise<{
        blocks?: Partial<SearchBlockItem>[];
        files?: string[];
        graph: string;
        key: string;
        pages?: string[];
    }>)

    Type declaration

      • (graph: string, key: string, opts: Partial<{
            limit: number;
        }>): Promise<{
            blocks?: Partial<SearchBlockItem>[];
            files?: string[];
            graph: string;
            key: string;
            pages?: string[];
        }>

      • Parameters

        • graph: string
        • key: string
        • opts: Partial<{
              limit: number;
          }>

        Returns Promise<{
            blocks?: Partial<SearchBlockItem>[];
            files?: string[];
            graph: string;
            key: string;
            pages?: string[];
        }>

    Optional options

    options?: Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc