Class PlApiDirectoryClient

constructor

• new PlApiDirectoryClient(baseURL: string): PlApiDirectoryClient

  Parameters

  • baseURL: string

    Server directory URL. e.g. https://joinmastodon.org

  Returns PlApiDirectoryClient

accessToken

baseURL

iceshrimpAccessToken

request

getCategories

• getCategories(
      params?: Params,
  ): Promise<{ category: string; servers_count: null | number }[]>

  Parameters

  • Optionalparams: Params

  Returns Promise<{ category: string; servers_count: null | number }[]>

getLanguages

• getLanguages(
      params?: Params,
  ): Promise<
      { language: string; locale: string; servers_count: null
      | number }[],
  >

  Parameters

  • Optionalparams: Params

  Returns Promise<{ language: string; locale: string; servers_count: null | number }[]>

getServers

• getServers(
      params?: Params,
  ): Promise<
      {
          approval_required: boolean;
          blurhash: null
          | string;
          categories: string[];
          category: string;
          description: string;
          domain: string;
          language: string;
          languages: string[];
          last_week_users: number;
          proxied_thumbnail: null | string;
          region: string;
          total_users: number;
          version: string;
      }[],
  >

  Parameters

  • Optionalparams: Params

  Returns Promise<
      {
          approval_required: boolean;
          blurhash: null
          | string;
          categories: string[];
          category: string;
          description: string;
          domain: string;
          language: string;
          languages: string[];
          last_week_users: number;
          proxied_thumbnail: null | string;
          region: string;
          total_users: number;
          version: string;
      }[],
  >

getStatistics

• getStatistics(): Promise<
      {
          active_user_count: null
          | number;
          period: string;
          server_count: null | number;
          user_count: null | number;
      }[],
  >

  Returns Promise<
      {
          active_user_count: null
          | number;
          period: string;
          server_count: null | number;
          user_count: null | number;
      }[],
  >