Skip to content

wikipedia

Search Wikipedia and read article summaries or full text from Agency code.

ts
import { search, summary } from "std::wikipedia"

node main() {
  const results = search("Ada Lovelace")
  const intro = summary(results[0].title)
  print(intro.extract)
}

Types

Effects

ts
effect std::wikipedia::search {
  query: string;
  limit: number
}

(source)

std::wikipedia::summary

ts
effect std::wikipedia::summary {
  title: string
}

(source)

std::wikipedia::article

ts
effect std::wikipedia::article {
  title: string
}

(source)

Functions

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

Search Wikipedia for articles matching a query. Each result has a title, description, and excerpt.

@param query - The search query @param limit - Maximum number of results to return

Parameters:

NameTypeDefault
querystring
limitnumber5

Returns: WikiSearchResult[]

Throws: std::wikipedia::search

(source)

summary

ts
summary(title: string): WikiSummary

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

@param title - The article title

Parameters:

NameTypeDefault
titlestring

Returns: WikiSummary

Throws: std::wikipedia::summary

(source)

article

ts
article(title: string): WikiArticle

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

@param title - The article title

Parameters:

NameTypeDefault
titlestring

Returns: WikiArticle

Throws: std::wikipedia::article

(source)