For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/llms-full.txt, and this page is available as Markdown at https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md.
types-mediawiki-response
  • English

      • Interface: ApiSearchResult

      Defined in: core/query/search.ts:30

      One search hit (list=search), and the page data generator=search injects into a query.pages entry.

      Which fields appear is controlled by srprop for list=search and by gsrprop for generator=search. The two differ in their default: gsrprop defaults to empty in generator mode, so only ns, title, pageid and the injected index appear unless gsrprop is passed explicitly.

      Extended by

      Properties

      categorysnippet?

      optional categorysnippet?: string

      Defined in: core/query/search.ts:56

      Snippet of the matching category. srprop=categorysnippet.

      extensiondata?

      optional extensiondata?: unknown

      Defined in: core/query/search.ts:74

      Search-backend extension data, keyed by augmentor name. srprop=extensiondata.

      isfilematch?

      optional isfilematch?: boolean

      Defined in: core/query/search.ts:71

      Whether the hit matched a file. srprop=isfilematch; a real boolean.

      ns?

      optional ns?: number

      Defined in: core/query/search.ts:32

      Namespace index.

      pageid?

      optional pageid?: number

      Defined in: core/query/search.ts:38

      Page id.

      redirectsnippet?

      optional redirectsnippet?: string

      Defined in: core/query/search.ts:68

      HTML snippet of the redirect target title. srprop=redirectsnippet.

      redirecttitle?

      optional redirecttitle?: string

      Defined in: core/query/search.ts:65

      Title of the redirect target, if this hit redirects. srprop=redirecttitle.

      sectionsnippet?

      optional sectionsnippet?: string

      Defined in: core/query/search.ts:62

      HTML snippet of the section heading. srprop=sectionsnippet.

      sectiontitle?

      optional sectiontitle?: string

      Defined in: core/query/search.ts:59

      Title of the section the match is in. srprop=sectiontitle.

      size?

      optional size?: number

      Defined in: core/query/search.ts:41

      Page size in bytes. srprop=size.

      snippet?

      optional snippet?: string

      Defined in: core/query/search.ts:50

      HTML snippet of the match, with highlights. srprop=snippet.

      timestamp?

      optional timestamp?: string

      Defined in: core/query/search.ts:47

      Last-edit timestamp. srprop=timestamp.

      title?

      optional title?: string

      Defined in: core/query/search.ts:35

      Full page title.

      titlesnippet?

      optional titlesnippet?: string

      Defined in: core/query/search.ts:53

      HTML snippet of the title. srprop=titlesnippet.

      wordcount?

      optional wordcount?: number

      Defined in: core/query/search.ts:44

      Word count. srprop=wordcount.