Interface SearchThreadsOptions

interface SearchThreadsOptions {
    archived?: boolean;
    limit?: number;
    maxID?: string;
    minID?: string;
    name?: string;
    offset?: number;
    slop?: number;
    sortBy?: ThreadSearchSortBy;
    sortOrder?: ThreadSearchSortOrder;
    tag?: string | string[];
    tagSetting?: ThreadSearchTagSetting;
}

Properties

archived? limit? maxID? minID? name? offset? slop? sortBy? sortOrder? tag? tagSetting?

Properties

Optional archived

archived?: boolean

Include archived threads.

Optional limit

limit?: number

The maximum number of threads to return.

Optional maxID

maxID?: string

Search threads before this thread ID.

Optional minID

minID?: string

Search threads after this thread ID.

Optional name

name?: string

The thread name to search for.

Optional offset

offset?: number

The offset into the search results.

Optional slop

slop?: number

The matching tolerance for the name query.

Optional sortBy

sortBy?: ThreadSearchSortBy

The field to sort by.

Optional sortOrder

sortOrder?: ThreadSearchSortOrder

The sort order.

Optional tag

tag?: string | string[]

Restrict results to threads with these forum/media tags.

Optional tagSetting

tagSetting?: ThreadSearchTagSetting

Whether all or any provided tags should match.

Settings

Member Visibility

Theme

On This Page

archivedlimitmaxIDminIDnameoffsetslopsortBysortOrdertagtagSetting