Class BotCollection

Collection of Bots

Hierarchy

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

`Private` #objects

#objects: ReactiveMap<string, Bot> = ...

`Private` #storage

#storage: ObjectStorage<HydratedBot> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id: string) => HydratedBot)

Type declaration

- (id: string): HydratedBot
- Parameters
  - id: string
  Returns 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
- Optional data: unknown
  
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

createBot

createBot(name: string): Promise<Bot>
Create a bot

Returns
The newly-created bot
Parameters
- name: string
  
  Bot name
Returns Promise<Bot>
- Defined in src/collections/BotCollection.ts:72

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
Iterable

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

fetch

fetch(id: string): Promise<Bot>
Fetch bot by ID

Returns
Bot
Parameters
- id: string
  
  Id
Returns Promise<Bot>
- Defined in src/collections/BotCollection.ts:19

fetchOwned

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

Returns
List of bots

Returns Promise<Bot[]>
- Defined in src/collections/BotCollection.ts:31

fetchPublic

fetchPublic(id: string): Promise<PublicBot>
Fetch public bot by ID

Returns
Public Bot
Parameters
- id: string
  
  Id
Returns Promise<PublicBot>
- Defined in src/collections/BotCollection.ts:46

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
  - - (value: Bot, key: string): boolean
    - Parameters
      
      value: Bot
      
      key: string
      
      Returns boolean
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
  - - (value: Bot, key: string): boolean
    - Parameters
      
      value: Bot
      
      key: string
      
      Returns boolean
Returns undefined | Bot
Inherited from ClassCollection.find
- Defined in src/collections/Collection.ts:105

forEach

forEach(cb: ((value: Bot, key: string, map: ReactiveMap<string, Bot>) => void)): void
Execute a provided function over each key, value pair in the map

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

get

get(id: string): undefined | Bot
Get an existing object

Returns
Object
Parameters
- id: string
  
  Id
Returns undefined | Bot
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

Returns
Bot
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
  - Optional analytics?: boolean
    
    Description
    Whether to enable analytics
  - Optional discoverable?: boolean
    
    Description
    Whether this bot should be publicly discoverable
  - Optional flags?: number
    
    Format: uint32
    
    Description
    Enum of bot flags
  - Optional interactions_url?: string
    
    Description
    Reserved; URL for handling interactions
  - owner: string
    
    Description
    User Id of the bot owner
  - Optional privacy_policy_url?: string
    
    Description
    URL for privacy policy
  - public: boolean
    
    Description
    Whether the bot is public (may be invited by anyone)
  - Optional terms_of_service_url?: string
    
    Description
    URL for terms of service
  - token: string
    
    Description
    Token used to authenticate requests for this bot
Returns Bot
- Defined in src/collections/BotCollection.ts:57

has

has(id: string): boolean
Check whether an id exists in the Collection

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

isPartial

isPartial(id: string): boolean
Check whether an object is partially defined

Returns
Whether it is a partial
Parameters
- id: string
  
  Id
Returns boolean
Inherited from ClassCollection.isPartial
- Defined in src/collections/Collection.ts:183

keys

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

Returns
Iterable

Returns IterableIterator<string>
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
  - - (value: Bot, key: string): O
    - Parameters
      
      value: Bot
      
      key: string
      
      Returns O
Returns O[]
Inherited from ClassCollection.map
- Defined in src/collections/Collection.ts:92

size

size(): number
Number of stored objects

Returns
Size

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

toList

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

Returns
List

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

values

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

Returns
Iterable

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

Class BotCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns BotCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedBot

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

type: "user" | "server" | "channel" | "bot" | "channelUnread" | "channelWebhook" | "emoji" | "message" | "serverMember" | "session"

instance: Bot

context: unknown

Optional data: unknown

Returns void

createBot

Returns

Parameters

name: string

Returns Promise<Bot>

delete

Parameters

id: string

Returns void

entries

Returns

Returns IterableIterator<[string, Bot]>

fetch

Returns

Parameters

id: string

Returns Promise<Bot>

fetchOwned

Returns

Returns Promise<Bot[]>

fetchPublic

Returns

Parameters

id: string

Returns Promise<PublicBot>

filter

Parameters

predicate: ((value: Bot, key: string) => boolean)

Parameters

value: Bot

key: string

Returns boolean

Returns Bot[]

find

Parameters

predicate: ((value: Bot, key: string) => boolean)

Parameters

value: Bot

key: string

Returns boolean

Returns undefined | Bot

forEach

Returns

Parameters

cb: ((value: Bot, key: string, map: ReactiveMap<string, Bot>) => void)

Parameters

value: Bot

key: string

map: ReactiveMap<string, Bot>

Returns void

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

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;
}

`Optional` analytics?: boolean

`Optional` discoverable?: boolean

`Optional` flags?: number

`Optional` interactions_url?: string

`Optional` privacy_policy_url?: string

`Optional` terms_of_service_url?: string