Class Stream

Hierarchy

API
- Stream

Index

Constructors

constructor

new Stream(options, discordBotToken?): Stream
Parameters
- options: StreamOptions
- Optional discordBotToken: string
Returns Stream
Overrides API.constructor
- Defined in src/stream/index.ts:15

Properties

`Private` #agents

#agents: Map<string, BskyAgent> = ...

`Private` #debug

#debug: boolean = false

`Private` #discordBotToken

#discordBotToken: undefined | string

Only needed for 'channels.channelId' options so the package can send announcements

`Private` cache

cache: Map<string, SetStreamUserOption> = ...

`Protected` options

options: StreamOptions

`Private` stream

stream: __module = ...

Accessors

`Private` #icon

get #icon(): string
Returns string
- Defined in src/stream/index.ts:141

`Private` #mins

get #mins(): number
Returns number
- Defined in src/stream/index.ts:145

`Private` #name

get #name(): string
Returns string
- Defined in src/stream/index.ts:137

agents

get agents(): {
    add: ((keys) => Promise<void>);
    list: (() => BskyAgent[]);
    remove: ((name, service?) => API);
    search: ((query, searchType?) => null | BskyAgent[]);
}
Returns {
    add: ((keys) => Promise<void>);
    list: (() => BskyAgent[]);
    remove: ((name, service?) => API);
    search: ((query, searchType?) => null | BskyAgent[]);
}
- add: ((keys) => Promise<void>)
  - - (keys): Promise<void>
    - Parameters
      
      keys: APIKey | APIKey[]
      Returns Promise<void>
- list: (() => BskyAgent[])
  - - (): BskyAgent[]
    - Returns BskyAgent[]
- remove: ((name, service?) => API)
  - - (name, service?): API
    - Parameters
      
      name: string
      
      Optional service: string
      Returns API
- search: ((query, searchType?) => null | BskyAgent[])
  - - (query, searchType?): null | BskyAgent[]
    - Parameters
      
      query: {
      service?: string;
      username?: string;
      }
      
      Optional service?: string
      
      Optional username?: string
      
      searchType: "filter" | "find" = "find"
      Returns null | BskyAgent[]
Inherited from API.agents
- Defined in src/api/index.ts:24

manage

get manage(): {
    add: ((users) => void);
    clear: (() => void);
    get: ((user) => null | Readonly<StreamUserOption>);
    list: (() => SetStreamUserOption[]);
    remove: ((users) => void);
    set: ((user, searchId, options) => {
        message: string;
        status: false;
    } | {
        data: {
            channel: StreamUserOptions;
            user: SetStreamUserOption;
        };
        status: true;
    });
}
Returns {
    add: ((users) => void);
    clear: (() => void);
    get: ((user) => null | Readonly<StreamUserOption>);
    list: (() => SetStreamUserOption[]);
    remove: ((users) => void);
    set: ((user, searchId, options) => {
        message: string;
        status: false;
    } | {
        data: {
            channel: StreamUserOptions;
            user: SetStreamUserOption;
        };
        status: true;
    });
}
- add: ((users) => void)
  - - (users): void
    - Parameters
      
      users: StreamUserOption | StreamUserOption[]
      Returns void
- clear: (() => void)
  - - (): void
    - Returns void
- get: ((user) => null | Readonly<StreamUserOption>)
  - - (user): null | Readonly<StreamUserOption>
    - Parameters
      
      user: string
      Returns null | Readonly<StreamUserOption>
- list: (() => SetStreamUserOption[])
  - - (): SetStreamUserOption[]
    - Returns SetStreamUserOption[]
- remove: ((users) => void)
  - - (users): void
    - Parameters
      
      users: string | string[]
      Returns void
- set: ((user, searchId, options) => {
      message: string;
      status: false;
  } | {
      data: {
          channel: StreamUserOptions;
          user: SetStreamUserOption;
      };
      status: true;
  })
  - - (user, searchId, options): {
          message: string;
          status: false;
      } | {
          data: {
              channel: StreamUserOptions;
              user: SetStreamUserOption;
          };
          status: true;
      }
    - Parameters
      
      user: string
      
      searchId: string
      
      options: Omit<StreamUserOptional, "searchId">
      Returns {
          message: string;
          status: false;
      } | {
          data: {
              channel: StreamUserOptions;
              user: SetStreamUserOption;
          };
          status: true;
      }
- Defined in src/stream/index.ts:19

users

get users(): {
    feeds: {
        fetch: ((name, options?) => Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>);
        fetchMultiple: ((names, options?) => Promise<{
            message: string;
            status: false;
        } | {
            data: Map<string, FeedViewPost[]>;
            status: true;
        }>);
    };
    fetch: ((name) => Promise<{
        message: string;
        status: false;
    } | {
        data: ProfileViewDetailed;
        status: true;
    }>);
    fetchMultiple: ((names) => Promise<{
        message: string;
        status: false;
    } | {
        data: ProfileViewDetailed[];
        status: true;
    }>);
    likes: {
        get: ((name, limit?) => Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>);
    };
}
Returns {
    feeds: {
        fetch: ((name, options?) => Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>);
        fetchMultiple: ((names, options?) => Promise<{
            message: string;
            status: false;
        } | {
            data: Map<string, FeedViewPost[]>;
            status: true;
        }>);
    };
    fetch: ((name) => Promise<{
        message: string;
        status: false;
    } | {
        data: ProfileViewDetailed;
        status: true;
    }>);
    fetchMultiple: ((names) => Promise<{
        message: string;
        status: false;
    } | {
        data: ProfileViewDetailed[];
        status: true;
    }>);
    likes: {
        get: ((name, limit?) => Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>);
    };
}
- feeds: {
      fetch: ((name, options?) => Promise<{
          message: string;
          status: false;
      } | {
          data: FeedViewPost[];
          status: true;
      }>);
      fetchMultiple: ((names, options?) => Promise<{
          message: string;
          status: false;
      } | {
          data: Map<string, FeedViewPost[]>;
          status: true;
      }>);
  }
  - fetch: ((name, options?) => Promise<{
        message: string;
        status: false;
    } | {
        data: FeedViewPost[];
        status: true;
    }>)
    - - (name, options?): Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>
      - Parameters
        
        name: string
        
        Optional options: FeedOptions
        
        Returns Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>
  - fetchMultiple: ((names, options?) => Promise<{
        message: string;
        status: false;
    } | {
        data: Map<string, FeedViewPost[]>;
        status: true;
    }>)
    - - (names, options?): Promise<{
            message: string;
            status: false;
        } | {
            data: Map<string, FeedViewPost[]>;
            status: true;
        }>
      - Parameters
        
        names: string[]
        
        Optional options: FeedOptions
        
        Returns Promise<{
            message: string;
            status: false;
        } | {
            data: Map<string, FeedViewPost[]>;
            status: true;
        }>
- fetch: ((name) => Promise<{
      message: string;
      status: false;
  } | {
      data: ProfileViewDetailed;
      status: true;
  }>)
  - - (name): Promise<{
          message: string;
          status: false;
      } | {
          data: ProfileViewDetailed;
          status: true;
      }>
    - Parameters
      
      name: string
      Returns Promise<{
          message: string;
          status: false;
      } | {
          data: ProfileViewDetailed;
          status: true;
      }>
- fetchMultiple: ((names) => Promise<{
      message: string;
      status: false;
  } | {
      data: ProfileViewDetailed[];
      status: true;
  }>)
  - - (names): Promise<{
          message: string;
          status: false;
      } | {
          data: ProfileViewDetailed[];
          status: true;
      }>
    - Parameters
      
      names: string[]
      Returns Promise<{
          message: string;
          status: false;
      } | {
          data: ProfileViewDetailed[];
          status: true;
      }>
- likes: {
      get: ((name, limit?) => Promise<{
          message: string;
          status: false;
      } | {
          data: FeedViewPost[];
          status: true;
      }>);
  }
  - get: ((name, limit?) => Promise<{
        message: string;
        status: false;
    } | {
        data: FeedViewPost[];
        status: true;
    }>)
    - - (name, limit?): Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>
      - Parameters
        
        name: string
        
        limit: number = 100
        
        Returns Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>
Inherited from API.users
- Defined in src/api/index.ts:85

Methods

`Private` #debug

#debug(...args): void
Parameters
- Rest ...args: unknown[]
Returns void
- Defined in src/stream/index.ts:317

`Private` #getDefaultService

#getDefaultService(): string
Returns string
Inherited from API.#getDefaultService
- Defined in src/api/index.ts:59

`Private` #getStr

#getStr(username, service?): string
Parameters
- username: string
- Optional service: string
Returns string
Inherited from API.#getStr
- Defined in src/api/index.ts:63

`Private` #handlePost

#handlePost(user, post, viewed): Promise<unknown>
Parameters
- user: SetStreamUserOption
- post: FormattedStreamPost
- viewed: PostViewed
Returns Promise<unknown>
- Defined in src/stream/index.ts:194

`Private` #run

#run(): Timeout
Returns Timeout
- Defined in src/stream/index.ts:313

onDebug

onDebug(listener): __module
Parameters
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: unknown[]
      
      Returns void
Returns __module
- Defined in src/stream/index.ts:153

onPost

onPost(listener): __module
Parameters
- listener: ((user, post, format) => void)
  - - (user, post, format): void
    - Parameters
      
      user: SetStreamUserOption
      
      post: PostViewed
      
      format: FormattedStreamPost
      
      Returns void
Returns __module
- Defined in src/stream/index.ts:149

start

start(): Promise<unknown>
Returns Promise<unknown>
- Defined in src/stream/index.ts:158

Class Stream

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: StreamOptions

Optional discordBotToken: string

Returns Stream

Properties

Private #agents

Private #debug

Private #discordBotToken

Private cache

Protected options

Private stream

Accessors

Private #icon

Returns string

Private #mins

Returns number

Private #name

Returns string

agents

Returns { add: ((keys) => Promise<void>); list: (() => BskyAgent[]); remove: ((name, service?) => API); search: ((query, searchType?) => null | BskyAgent[]); }

add: ((keys) => Promise<void>)

Parameters

keys: APIKey | APIKey[]

Returns Promise<void>

list: (() => BskyAgent[])

Returns BskyAgent[]

remove: ((name, service?) => API)

Parameters

name: string

Optional service: string

Returns API

search: ((query, searchType?) => null | BskyAgent[])

Parameters

query: { service?: string; username?: string; }

Optional service?: string

Optional username?: string

searchType: "filter" | "find" = "find"

Returns null | BskyAgent[]

manage

add: ((users) => void)

Parameters

users: StreamUserOption | StreamUserOption[]

Returns void

clear: (() => void)

Returns void

get: ((user) => null | Readonly<StreamUserOption>)

Parameters

user: string

Returns null | Readonly<StreamUserOption>

list: (() => SetStreamUserOption[])

Returns SetStreamUserOption[]

remove: ((users) => void)

Parameters

users: string | string[]

Returns void

set: ((user, searchId, options) => { message: string; status: false; } | { data: { channel: StreamUserOptions; user: SetStreamUserOption; }; status: true; })

Parameters

user: string

searchId: string

options: Omit<StreamUserOptional, "searchId">

Returns { message: string; status: false; } | { data: { channel: StreamUserOptions; user: SetStreamUserOption; }; status: true; }

users

feeds: { fetch: ((name, options?) => Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>); fetchMultiple: ((names, options?) => Promise<{ message: string; status: false; } | { data: Map<string, FeedViewPost[]>; status: true; }>); }

fetch: ((name, options?) => Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>)

Parameters

name: string

Optional options: FeedOptions

Returns Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>

fetchMultiple: ((names, options?) => Promise<{ message: string; status: false; } | { data: Map<string, FeedViewPost[]>; status: true; }>)

Parameters

names: string[]

`Optional` discordBotToken: string

`Private` #agents

`Private` #debug

`Private` #discordBotToken

`Private` cache

`Protected` options

`Private` stream

`Private` #icon

`Private` #mins

`Private` #name

Returns {
add: ((keys) => Promise<void>);
list: (() => BskyAgent[]);
remove: ((name, service?) => API);
search: ((query, searchType?) => null | BskyAgent[]);
}

`Optional` service: string

query: {
service?: string;
username?: string;
}

`Optional` service?: string

`Optional` username?: string

set: ((user, searchId, options) => {
message: string;
status: false;
} | {
data: {
channel: StreamUserOptions;
user: SetStreamUserOption;
};
status: true;
})

Returns {
message: string;
status: false;
} | {
data: {
channel: StreamUserOptions;
user: SetStreamUserOption;
};
status: true;
}

feeds: {
fetch: ((name, options?) => Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>);
fetchMultiple: ((names, options?) => Promise<{
message: string;
status: false;
} | {
data: Map<string, FeedViewPost[]>;
status: true;
}>);
}

fetch: ((name, options?) => Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>)

`Optional` options: FeedOptions

Returns Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>

fetchMultiple: ((names, options?) => Promise<{
message: string;
status: false;
} | {
data: Map<string, FeedViewPost[]>;
status: true;
}>)

`Optional` options: FeedOptions

Returns Promise<{
message: string;
status: false;
} | {
data: Map<string, FeedViewPost[]>;
status: true;
}>

fetch: ((name) => Promise<{
message: string;
status: false;
} | {
data: ProfileViewDetailed;
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
data: ProfileViewDetailed;
status: true;
}>

fetchMultiple: ((names) => Promise<{
message: string;
status: false;
} | {
data: ProfileViewDetailed[];
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
data: ProfileViewDetailed[];
status: true;
}>

likes: {
get: ((name, limit?) => Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>);
}

get: ((name, limit?) => Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>

`Private` #debug

`Rest` ...args: unknown[]

`Private` #getDefaultService

`Private` #getStr

`Optional` service: string

`Private` #handlePost

`Private` #run

`Rest` ...args: unknown[]