Interface Client

interface Client {
    direct: {
        subscribe(): Subscription;
    };
    hashtag: {
        local: {
            subscribe(params): Subscription;
        };
        subscribe(params): Subscription;
    };
    list: {
        subscribe(params): Subscription;
    };
    public: {
        local: {
            media: {
                subscribe(): Subscription;
            };
            subscribe(): Subscription;
        };
        media: {
            subscribe(): Subscription;
        };
        remote: {
            media: {
                subscribe(): Subscription;
            };
            subscribe(): Subscription;
        };
        subscribe(): Subscription;
    };
    user: {
        notification: {
            subscribe(): Subscription;
        };
        subscribe(): Subscription;
    };
    [dispose](): void;
    [dispose](): void;
    close(): void;
    prepare(): Promise<void>;
}

Hierarchy

Disposable
- Client

Index

Properties

direct hashtag list public user

Methods

[dispose] close prepare

Properties

direct

direct: {
subscribe(): Subscription;
}

Type declaration

subscribe:function
- subscribe(): Subscription
- Returns Subscription
  - Defined in src/mastodon/streaming/client.ts:46

hashtag

hashtag: {
    local: {
        subscribe(params): Subscription;
    };
    subscribe(params): Subscription;
}

Type declaration

local: {
subscribe(params): Subscription;
}
- subscribe:function
  - subscribe(params): Subscription
  - Parameters
    - params: SubscribeHashtagParams
    Returns Subscription
    - Defined in src/mastodon/streaming/client.ts:39
subscribe:function
- subscribe(params): Subscription
- Parameters
  - params: SubscribeHashtagParams
  Returns Subscription
  - Defined in src/mastodon/streaming/client.ts:37

list

list: {
subscribe(params): Subscription;
}

Type declaration

subscribe:function
- subscribe(params): Subscription
- Parameters
  - params: SubscribeListParams
  Returns Subscription
  - Defined in src/mastodon/streaming/client.ts:43

public

public: {
    local: {
        media: {
            subscribe(): Subscription;
        };
        subscribe(): Subscription;
    };
    media: {
        subscribe(): Subscription;
    };
    remote: {
        media: {
            subscribe(): Subscription;
        };
        subscribe(): Subscription;
    };
    subscribe(): Subscription;
}

Type declaration

local: {
    media: {
        subscribe(): Subscription;
    };
    subscribe(): Subscription;
}
- media: {
  subscribe(): Subscription;
  }
  - subscribe:function
    - subscribe(): Subscription
    - Returns Subscription
      Defined in src/mastodon/streaming/client.ts:26
- subscribe:function
  - subscribe(): Subscription
  - Returns Subscription
    - Defined in src/mastodon/streaming/client.ts:24
media: {
subscribe(): Subscription;
}
- subscribe:function
  - subscribe(): Subscription
  - Returns Subscription
    - Defined in src/mastodon/streaming/client.ts:21
remote: {
    media: {
        subscribe(): Subscription;
    };
    subscribe(): Subscription;
}
- media: {
  subscribe(): Subscription;
  }
  - subscribe:function
    - subscribe(): Subscription
    - Returns Subscription
      Defined in src/mastodon/streaming/client.ts:32
- subscribe:function
  - subscribe(): Subscription
  - Returns Subscription
    - Defined in src/mastodon/streaming/client.ts:30
subscribe:function
- subscribe(): Subscription
- Returns Subscription
  - Defined in src/mastodon/streaming/client.ts:19

user

user: {
    notification: {
        subscribe(): Subscription;
    };
    subscribe(): Subscription;
}

Type declaration

notification: {
subscribe(): Subscription;
}
- subscribe:function
  - subscribe(): Subscription
  - Returns Subscription
    - Defined in src/mastodon/streaming/client.ts:51
subscribe:function
- subscribe(): Subscription
- Returns Subscription
  - Defined in src/mastodon/streaming/client.ts:49

Methods

[dispose]

[dispose](): void
Returns void
Inherited from Disposable.[dispose]
- Defined in node_modules/typescript/lib/lib.esnext.disposable.d.ts:34
[dispose](): void
Returns void
Inherited from Disposable.[dispose]
- Defined in node_modules/@types/node/globals.d.ts:116

close

close(): void
Returns void
- Defined in src/mastodon/streaming/client.ts:55

prepare

prepare(): Promise<void>
Internal
Returns Promise<void>
- Defined in src/mastodon/streaming/client.ts:58

Interface Client

Hierarchy

Index

Properties

Methods

Properties

direct

Type declaration

subscribe:function

Returns Subscription

hashtag

Type declaration

local: { subscribe(params): Subscription; }

subscribe:function

Parameters

Returns Subscription

subscribe:function

Parameters

Returns Subscription

list

Type declaration

subscribe:function

Parameters

Returns Subscription

public

Type declaration

local: { media: { subscribe(): Subscription; }; subscribe(): Subscription; }

media: { subscribe(): Subscription; }

subscribe:function

Returns Subscription

subscribe:function

Returns Subscription

media: { subscribe(): Subscription; }

subscribe:function

Returns Subscription

remote: { media: { subscribe(): Subscription; }; subscribe(): Subscription; }

media: { subscribe(): Subscription; }

subscribe:function

Returns Subscription

subscribe:function

Returns Subscription

subscribe:function

Returns Subscription

user

Type declaration

notification: { subscribe(): Subscription; }

subscribe:function

Returns Subscription

subscribe:function

Returns Subscription

Methods

[dispose]

Returns void

Returns void

close

Returns void

prepare

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

local: {
subscribe(params): Subscription;
}

local: {
media: {
subscribe(): Subscription;
};
subscribe(): Subscription;
}

media: {
subscribe(): Subscription;
}

media: {
subscribe(): Subscription;
}

remote: {
media: {
subscribe(): Subscription;
};
subscribe(): Subscription;
}

media: {
subscribe(): Subscription;
}

notification: {
subscribe(): Subscription;
}