Skip to content

wikipedia

Types

WikiSearchResult

ts
type WikiSearchResult = {
  title: string;
  description: string;
  excerpt: string
}

(source)

WikiSummary

ts
type WikiSummary = {
  title: string;
  description: string;
  extract: string;
  url: string
}

(source)

WikiArticle

ts
type WikiArticle = {
  title: string;
  text: string;
  url: string
}

(source)

Functions

ts
search(query: string, limit: number): WikiSearchResult[]

Search Wikipedia for articles matching the given query. Returns up to limit results (default 5).

Parameters:

NameTypeDefault
querystring
limitnumber5

Returns: WikiSearchResult[]

(source)

summary

ts
summary(title: string): WikiSummary

Get a summary of a Wikipedia article by its title. Returns the title, description, intro extract, and URL.

Parameters:

NameTypeDefault
titlestring

Returns: WikiSummary

(source)

article

ts
article(title: string): WikiArticle

Get the full text of a Wikipedia article by its title. Returns the title, full plain text content, and URL.

Parameters:

NameTypeDefault
titlestring

Returns: WikiArticle

(source)