masto/dist/cjs/mastodon/rest/v1/directory.d.ts

Mastodon API client for JavaScript, TypeScript, Node.js, browsers

import { type HttpMetaParams } from "../../../interfaces/index.js";
import { type Account } from "../../entities/v1/index.js";
import { type Paginator } from "../../paginator.js";
export interface DirectoryOrderTypeRegistry {
    active: never;
    new: never;
}
export type DirectoryOrderType = keyof DirectoryOrderTypeRegistry;
export interface ListDirectoryParams {
    /** How many accounts to load. Default 40. */
    readonly limit?: number | null;
    /** How many accounts to skip before returning results. Default 0. */
    readonly offset?: number | null;
    /** `active` to sort by most recently posted statuses (default) or `new` to sort by most recently created profiles. */
    readonly order?: DirectoryOrderType | null;
    /** Only return local accounts. */
    readonly local?: boolean | null;
}
export interface DirectoryResource {
    /**
     * List accounts visible in the directory.
     * @param params Parameters
     * @return Array of Account
     * @see https://docs.joinmastodon.org/methods/instance/directory/
     */
    list(params?: ListDirectoryParams, meta?: HttpMetaParams<"json">): Paginator<Account[], ListDirectoryParams>;
}
/** @deprecated Use `DirectoryResource` instead. */
export type DirectoryRepository = DirectoryResource;