Type Alias ListCommunities

Fetches a list of communities.

type ListCommunities = {
    limit?: number;
    multi_community_id?: MultiCommunityId;
    page_cursor?: PaginationCursor;
    search_term?: string;
    search_title_only?: boolean;
    show_nsfw?: boolean;
    sort?: CommunitySortType;
    time_range_seconds?: number;
    type_?: ListingType;
}

Index

Properties

limit? multi_community_id? page_cursor? search_term? search_title_only? show_nsfw? sort? time_range_seconds? type_?

Properties

`Optional`limit

limit?: number

`Optional`multi_community_id

multi_community_id?: MultiCommunityId

`Optional`page_cursor

page_cursor?: PaginationCursor

`Optional`search_term

search_term?: string

`Optional`search_title_only

search_title_only?: boolean

`Optional`show_nsfw

show_nsfw?: boolean

`Optional`sort

sort?: CommunitySortType

`Optional`time_range_seconds

time_range_seconds?: number

Filter to within a given time range, in seconds. IE 60 would give results for the past minute.

`Optional`type_

type_?: ListingType