Interface StackExchangeAPIParams

interface StackExchangeAPIParams {
    maxResult?: number;
    options?: StackExchangeOptions;
    queryType?: "title" | "body" | "all";
    resultSeparator?: string;
}

Properties

maxResult? options? queryType? resultSeparator?

Properties

Optional maxResult

maxResult?: number

The maximum number of results to return from the search. Limiting to 10 to avoid context overload.

Default

3

Optional options

options?: StackExchangeOptions

Additional params to pass to the StackExchange API

Optional queryType

queryType?: "title" | "body" | "all"

Which part of StackOverflows items to match against. One of 'all', 'title', 'body'.

Default

"all"

Optional resultSeparator

resultSeparator?: string

Separator between question,answer pairs.

Default

"\n\n"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc