Class SearchTrends

Hierarchy (View Summary)

Base
- SearchTrends

Index

Constructors

Methods

clearCache list listRising purge updateSettings

Constructors

constructor

new SearchTrends(e621: E621, client: Client): SearchTrends
Parameters
- e621: E621
- client: Client
Returns SearchTrends
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:20

Methods

clearCache

clearCache(): Promise<SearchTrendsClearCacheResponse>
Requires Api Key Auth
Clear Search Trends Cache

You must be Admin+.

Returns Promise<SearchTrendsClearCacheResponse>

Operation Id
search_trends#clear_cache

See
Documentation for more details.
- Defined in lib/modules/SearchTrends.ts:41

list

list(options?: ListSearchTrendsOptions): Promise<SearchTrend[]>
Search Trends Index
Parameters
- Optionaloptions: ListSearchTrendsOptions
Returns Promise<SearchTrend[]>

Operation Id
search_trends#index

See
Documentation for more details.
- Defined in lib/modules/SearchTrends.ts:55

listRising

listRising(): Promise<RisingSearchTrend[]>
List Rising Search Trends

Returns Promise<RisingSearchTrend[]>

Operation Id
search_trends#rising

See
Documentation for more details.
- Defined in lib/modules/SearchTrends.ts:70

purge

purge(id: number): Promise<SearchTrendsPurgeResponse>
Requires Api Key Auth
Purge Search Trends

You must be Admin+.
Parameters
- id: number
Returns Promise<SearchTrendsPurgeResponse>

Operation Id
search_trends#purge

See
Documentation for more details.
- Defined in lib/modules/SearchTrends.ts:88

updateSettings

updateSettings(
options: UpdateSearchTrendsSettingsOptions,
): Promise<SearchTrendsUpdateSettingsResponse>
Requires Api Key Auth
Update Search Trends Settings

You must be Admin+.
Parameters
- options: UpdateSearchTrendsSettingsOptions
Returns Promise<SearchTrendsUpdateSettingsResponse>

Operation Id
search_trends#update_settings

See
Documentation for more details.
- Defined in lib/modules/SearchTrends.ts:107