Interface InstanceRepository

interface InstanceRepository {
    activity: {
        list(meta?: HttpMetaParams<"none">): Paginator<Activity[], undefined>;
    };
    domainBlocks: {
        fetch(meta?: HttpMetaParams<"none">): Promise<mastodon.v1.DomainBlock[]>;
    };
    extendedDescription: {
        fetch(meta?: HttpMetaParams<"none">): Promise<ExtendedDescription>;
    };
    languages: {
        list(meta?: HttpMetaParams<"none">): Promise<string[]>;
    };
    peers: {
        list(meta?: HttpMetaParams<"none">): Paginator<string[], undefined>;
    };
    translationLanguages: {
        list(meta?: HttpMetaParams<"none">): Promise<Record<string, string[]>>;
    };
    fetch(meta?: HttpMetaParams<"none">): Promise<mastodon.v1.Instance>;
}

Index

Properties

activity domainBlocks extendedDescription languages peers translationLanguages

Methods

fetch

Properties

activity

activity: {
list(meta?: HttpMetaParams<"none">): Paginator<Activity[], undefined>;
}

Type declaration

list:function
- list(meta?): Paginator<Activity[], undefined>
- Instance activity over the last 3 months, binned weekly.
  Parameters
  - Optionalmeta: HttpMetaParams<"none">
  Returns Paginator<Activity[], undefined>
  Array of Activity
  
  See
  https://docs.joinmastodon.org/methods/instance/#activity
  - Defined in src/mastodon/rest/v1/instance-repository.ts:33

domainBlocks

domainBlocks: {
fetch(meta?: HttpMetaParams<"none">): Promise<mastodon.v1.DomainBlock[]>;
}

Type declaration

fetch:function
- fetch(meta?): Promise<mastodon.v1.DomainBlock[]>
- Obtain a list of domains that have been blocked.
  Parameters
  - Optionalmeta: HttpMetaParams<"none">
  Returns Promise<mastodon.v1.DomainBlock[]>
  See
  https://docs.joinmastodon.org/methods/instance/#domain_blocks
  - Defined in src/mastodon/rest/v1/instance-repository.ts:58

extendedDescription

extendedDescription: {
fetch(meta?: HttpMetaParams<"none">): Promise<ExtendedDescription>;
}

Type declaration

fetch:function
- fetch(meta?): Promise<ExtendedDescription>
- Obtain an extended description of this server
  Parameters
  - Optionalmeta: HttpMetaParams<"none">
  Returns Promise<ExtendedDescription>
  - Defined in src/mastodon/rest/v1/instance-repository.ts:45

languages

languages: {
list(meta?: HttpMetaParams<"none">): Promise<string[]>;
}

Type declaration

list:function
- list(meta?): Promise<string[]>
- https://github.com/mastodon/mastodon/pull/24443
  Parameters
  - Optionalmeta: HttpMetaParams<"none">
  Returns Promise<string[]>
  - Defined in src/mastodon/rest/v1/instance-repository.ts:38

peers

peers: {
list(meta?: HttpMetaParams<"none">): Paginator<string[], undefined>;
}

Type declaration

list:function
- list(meta?): Paginator<string[], undefined>
- Domains that this instance is aware of.
  Parameters
  - Optionalmeta: HttpMetaParams<"none">
  Returns Paginator<string[], undefined>
  Array of Activity
  
  See
  https://docs.joinmastodon.org/methods/instance/
  - Defined in src/mastodon/rest/v1/instance-repository.ts:24

translationLanguages

translationLanguages: {
list(meta?: HttpMetaParams<"none">): Promise<Record<string, string[]>>;
}

Type declaration

list:function
- list(meta?): Promise<Record<string, string[]>>
- https://github.com/mastodon/mastodon/pull/24037
  Parameters
  - Optionalmeta: HttpMetaParams<"none">
  Returns Promise<Record<string, string[]>>
  - Defined in src/mastodon/rest/v1/instance-repository.ts:50

Methods

fetch

fetch(meta?): Promise<mastodon.v1.Instance>
Information about the server.
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Promise<mastodon.v1.Instance>
Instance

See
https://docs.joinmastodon.org/methods/instance/
- Defined in src/mastodon/rest/v1/instance-repository.ts:16

Interface InstanceRepository

Index

Properties

Methods

Properties

activity

Type declaration

list:function

Parameters

Returns Paginator<Activity[], undefined>

See

domainBlocks

Type declaration

fetch:function

Parameters

Returns Promise<mastodon.v1.DomainBlock[]>

See

extendedDescription

Type declaration

fetch:function

Parameters

Returns Promise<ExtendedDescription>

languages

Type declaration

list:function

Parameters

Returns Promise<string[]>

peers

Type declaration

list:function

Parameters

Returns Paginator<string[], undefined>

See

translationLanguages

Type declaration

list:function

Parameters

Returns Promise<Record<string, string[]>>

Methods

fetch

Parameters

Returns Promise<mastodon.v1.Instance>

See

Settings

On This Page