Options
All
  • Public
  • Public/Protected
  • All
Menu

External module search.model

Index

Type aliases

EntityMatchType

EntityMatchType: object

the object that tell us, how the result matches to the query

Type declaration

  • language: WikidataLanguage

    the language of the matches to a query

  • text: string

    text of the query

  • type: string

    that match with a query

ResultType

ResultType: object

the return result from APIs query.

Type declaration

  • [key: string]: any
  • Optional aliases?: string[]

    a alias key of the entity

  • concepturi: string

    concepturi is a concept url of the entities (usually will be on this form: http://www.wikidata.org/entity/)

  • Optional description?: undefined | string

    description of this label (might not exist in some of language and entities)

  • id: string

    the entities ID (should start with Q or P ???)

  • label: string

    label of entities that will show as a title in website (should be human readable string text)

  • Optional match?: EntityMatchType

    the object show how this entities is match a query

  • pageid: number

    a wikidata page id (???)

  • repository: string

    (???)

  • title: string

    the title of the id (usually will be the same as id ???)

  • url: string

    a wikidata url (should be inform of 'http://www.wikidata.org/wiki/')

SearchResultType

SearchResultType: object

Search result type is the result type that you will receive after fetching the REST API

param

is a object contain searching query

param

is a search query

param

is a array of entities result

Type declaration

  • search: ResultType[]
  • searchinfo: object
    • search: string

Generated using TypeDoc