Interface SearchParams

interface SearchParams {
    accountId?: null | string;
    excludeUnreviewed?: null | boolean;
    following?: null | boolean;
    limit?: null | number;
    maxId?: null | string;
    minId?: null | string;
    offset?: null | number;
    q: string;
    resolve?: null | boolean;
    sinceId?: null | string;
    type?: null | (keyof SearchTypeRegistry);
}

Hierarchy (View Summary)

Properties

accountId? excludeUnreviewed? following? limit? maxId? minId? offset? q resolve? sinceId? type?

Properties

Optional ReadonlyaccountId

accountId?: null | string

If provided, statuses returned will be authored only by this account

Optional ReadonlyexcludeUnreviewed

excludeUnreviewed?: null | boolean

Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.

Optional Readonlyfollowing

following?: null | boolean

Only include accounts that the user is following. Defaults to false.

Optional Readonlylimit

limit?: null | number

Maximum number of results to return per page. Defaults to 40. NOTE: Pagination is done with the Link header from the response.

Optional ReadonlymaxId

maxId?: null | string

Return results older than this ID.

Optional ReadonlyminId

minId?: null | string

Get a list of items with ID greater than this value excluding this ID

Optional Readonlyoffset

offset?: null | number

Skip the first n results.

Readonlyq

q: string

Attempt WebFinger lookup. Defaults to false.

Optional Readonlyresolve

resolve?: null | boolean

Attempt WebFinger look-up

Optional ReadonlysinceId

sinceId?: null | string

Return results newer than this ID.

Optional Readonlytype

type?: null | (keyof SearchTypeRegistry)

Enum(accounts, hashtags, statuses)

Settings

Member Visibility

On This Page

Properties