Class BotCollection

Collection of Bots

Hierarchy (View Summary)

ClassCollection<Bot, HydratedBot>
- BotCollection

Index

Constructors

constructor

new BotCollection(client: Client): BotCollection
Create generic class collection
Parameters
- client: Client
  Client
Returns BotCollection
Inherited from ClassCollection.constructor
- Defined in src/collections/Collection.ts:239

Properties

`Readonly`client

client: Client

`Readonly`getUnderlyingObject

getUnderlyingObject: (id: string) => HydratedBot

`Readonly`updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedBot>>

Methods

create

create(
    id: string,
    type:
        | "user"
        | "server"
        | "channel"
        | "bot"
        | "channelUnread"
        | "channelWebhook"
        | "emoji"
        | "message"
        | "serverMember"
        | "session",
    instance: Bot,
    context: unknown,
    data?: unknown,
): void
Create a new instance of an object
Parameters
- id: string
  Id
- type:
      | "user"
      | "server"
      | "channel"
      | "bot"
      | "channelUnread"
      | "channelWebhook"
      | "emoji"
      | "message"
      | "serverMember"
      | "session"
  Type
- instance: Bot
  Instance
- context: unknown
  Context
- Optionaldata: unknown
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

createBot

createBot(name: string): Promise<Bot>
Create a bot
Parameters
- name: string
  Bot name
Returns Promise<Bot>
The newly-created bot
- Defined in src/collections/BotCollection.ts:73

delete

delete(id: string): void
Delete an object
Parameters
- id: string
  Id
Returns void
Inherited from ClassCollection.delete
- Defined in src/collections/Collection.ts:154

entries

entries(): IterableIterator<[string, Bot]>
Iterable of key, value pairs in the map

Returns IterableIterator<[string, Bot]>
Iterable
Inherited from ClassCollection.entries
- Defined in src/collections/Collection.ts:215

fetch

fetch(id: string): Promise<Bot>
Fetch bot by ID
Parameters
- id: string
  Id
Returns Promise<Bot>
Bot
- Defined in src/collections/BotCollection.ts:20

fetchOwned

fetchOwned(): Promise<Bot[]>
Fetch owned bots

Returns Promise<Bot[]>
List of bots
- Defined in src/collections/BotCollection.ts:32

fetchPublic

fetchPublic(id: string): Promise<PublicBot>
Fetch public bot by ID
Parameters
- id: string
  Id
Returns Promise<PublicBot>
Public Bot
- Defined in src/collections/BotCollection.ts:47

filter

filter(predicate: (value: Bot, key: string) => boolean): Bot[]
Filter the collection by a given predicate
Parameters
- predicate: (value: Bot, key: string) => boolean
  Predicate to satisfy
Returns Bot[]
Inherited from ClassCollection.filter
- Defined in src/collections/Collection.ts:77

find

find(predicate: (value: Bot, key: string) => boolean): undefined | Bot
Find some value based on a predicate
Parameters
- predicate: (value: Bot, key: string) => boolean
  Predicate to satisfy
Returns undefined | Bot
Inherited from ClassCollection.find
- Defined in src/collections/Collection.ts:105

forEach

forEach(cb: (value: Bot, key: string, map: Map<string, Bot>) => void): void
Execute a provided function over each key, value pair in the map
Parameters
- cb: (value: Bot, key: string, map: Map<string, Bot>) => void
  Callback for each pair
Returns void
Iterable
Inherited from ClassCollection.forEach
- Defined in src/collections/Collection.ts:224

get

get(id: string): undefined | Bot
Get an existing object
Parameters
- id: string
  Id
Returns undefined | Bot
Object
Inherited from ClassCollection.get
- Defined in src/collections/Collection.ts:137

getOrCreate

getOrCreate(
    id: string,
    data: {
        _id: string;
        analytics?: boolean;
        discoverable?: boolean;
        flags?: number;
        interactions_url?: string;
        owner: string;
        privacy_policy_url?: string;
        public: boolean;
        terms_of_service_url?: string;
        token: string;
    },
): Bot
Get or create
Parameters
- id: string
  Id
- data: {
      _id: string;
      analytics?: boolean;
      discoverable?: boolean;
      flags?: number;
      interactions_url?: string;
      owner: string;
      privacy_policy_url?: string;
      public: boolean;
      terms_of_service_url?: string;
      token: string;
  }
  Data
  - _id: string
    Description
    Bot Id
  - Optionalanalytics?: boolean
    Description
    Whether to enable analytics
  - Optionaldiscoverable?: boolean
    Description
    Whether this bot should be publicly discoverable
  - Optionalflags?: number
    Format: uint32
    
    Description
    Enum of bot flags
  - Optionalinteractions_url?: string
    Description
    Reserved; URL for handling interactions
  - owner: string
    Description
    User Id of the bot owner
  - Optionalprivacy_policy_url?: string
    Description
    URL for privacy policy
  - public: boolean
    Description
    Whether the bot is public (may be invited by anyone)
  - Optionalterms_of_service_url?: string
    Description
    URL for terms of service
  - token: string
    Description
    Token used to authenticate requests for this bot
Returns Bot
Bot
- Defined in src/collections/BotCollection.ts:58

has

has(id: string): boolean
Check whether an id exists in the Collection
Parameters
- id: string
  Id
Returns boolean
Whether it exists
Inherited from ClassCollection.has
- Defined in src/collections/Collection.ts:146

isPartial

isPartial(id: string): boolean
Check whether an object is partially defined
Parameters
- id: string
  Id
Returns boolean
Whether it is a partial
Inherited from ClassCollection.isPartial
- Defined in src/collections/Collection.ts:183

keys

keys(): IterableIterator<string>
Iterable of keys in the map

Returns IterableIterator<string>
Iterable
Inherited from ClassCollection.keys
- Defined in src/collections/Collection.ts:199

map

map<O>(cb: (value: Bot, key: string) => O): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: (value: Bot, key: string) => O
  Callback
Returns O[]
Inherited from ClassCollection.map
- Defined in src/collections/Collection.ts:92

size

size(): number
Number of stored objects

Returns number
Size
Inherited from ClassCollection.size
- Defined in src/collections/Collection.ts:191

toList

toList(): Bot[]
List of values in the map

Returns Bot[]
List
Inherited from ClassCollection.toList
- Defined in src/collections/Collection.ts:69

values

values(): IterableIterator<Bot>
Iterable of values in the map

Returns IterableIterator<Bot>
Iterable
Inherited from ClassCollection.values
- Defined in src/collections/Collection.ts:207

Class BotCollection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BotCollection

Properties

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

Methods

create

Parameters

Returns void

createBot

Parameters

Returns Promise<Bot>

delete

Parameters

Returns void

entries

Returns IterableIterator<[string, Bot]>

fetch

Parameters

Returns Promise<Bot>

fetchOwned

Returns Promise<Bot[]>

fetchPublic

Parameters

Returns Promise<PublicBot>

filter

Parameters

Returns Bot[]

find

Parameters

Returns undefined | Bot

forEach

Parameters

Returns void

get

Parameters

Returns undefined | Bot

getOrCreate

Parameters

_id: string

Description

Optionalanalytics?: boolean

Description

Optionaldiscoverable?: boolean

Description

Optionalflags?: number

Description

Optionalinteractions_url?: string

Description

owner: string

Description

Optionalprivacy_policy_url?: string

Description

public: boolean

Description

Optionalterms_of_service_url?: string

Description

token: string

Description

Returns Bot

has

Parameters

Returns boolean

isPartial

Parameters

Returns boolean

keys

Returns IterableIterator<string>

map

Type Parameters

Parameters

`Readonly`client

`Readonly`getUnderlyingObject

`Readonly`updateUnderlyingObject

`Optional`analytics?: boolean

`Optional`discoverable?: boolean

`Optional`flags?: number

`Optional`interactions_url?: string

`Optional`privacy_policy_url?: string

`Optional`terms_of_service_url?: string