Skip to content

StageInstanceManager

Defined in: packages/managers/src/guild-resources.ts:249

Manages stage instances, cached by stage channel ID.

new StageInstanceManager(rest): StageInstanceManager

Defined in: packages/managers/src/guild-resources.ts:252

REST

StageInstanceManager

Manager.constructor

readonly cache: Collection<string, APIStageInstance>

Defined in: packages/managers/src/base.ts:27

Authoritative resource state. Entries never expire: see Manager.set.

Manager.cache

get size(): number

Defined in: packages/managers/src/base.ts:105

Gets cache size.

number

Number of cached values.

Manager.size

[iterator](): IterableIterator<[string, APIStageInstance]>

Defined in: packages/managers/src/base.ts:121

Iterates cached entries.

IterableIterator<[string, APIStageInstance]>

Cache iterator.

Manager.[iterator]


clear(): void

Defined in: packages/managers/src/base.ts:101

Clears the cache.

void

Nothing.

Manager.clear


create(channelId, options): Promise<APIStageInstance>

Defined in: packages/managers/src/guild-resources.ts:263

Starts a stage instance in a stage channel.

string

StageInstanceCreateOptions

Promise<APIStageInstance>


delete(id): boolean

Defined in: packages/managers/src/base.ts:96

Deletes a cached value.

string

Cache key.

boolean

True when deleted.

Manager.delete


edit(channelId, options): Promise<APIStageInstance>

Defined in: packages/managers/src/guild-resources.ts:290

Edits a stage instance’s topic or privacy level.

string

number

string

string

Promise<APIStageInstance>


fetch(channelId): Promise<APIStageInstance>

Defined in: packages/managers/src/guild-resources.ts:283

Fetches the stage instance of a stage channel.

string

Promise<APIStageInstance>


find(predicate): APIStageInstance | undefined

Defined in: packages/managers/src/base.ts:117

Finds a cached value.

(value, key) => boolean

Predicate.

APIStageInstance | undefined

Matching value.

Manager.find


first(): APIStageInstance | undefined

Defined in: packages/managers/src/base.ts:109

Gets the first cached value.

APIStageInstance | undefined

First value.

Manager.first


get(id): APIStageInstance | undefined

Defined in: packages/managers/src/base.ts:36

Gets a cached value.

string

Cache key.

APIStageInstance | undefined

Cached value.

Manager.get


has(id): boolean

Defined in: packages/managers/src/base.ts:40

Checks whether a value is cached.

string

Cache key.

boolean

True when cached.

Manager.has


remove(channelId, reason?): Promise<void>

Defined in: packages/managers/src/guild-resources.ts:304

Ends a stage instance.

string

string

Promise<void>


set(id, value): this

Defined in: packages/managers/src/base.ts:88

Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.

string

Cache key.

APIStageInstance

Value.

this

This manager.

Manager.set


values(): APIStageInstance[]

Defined in: packages/managers/src/base.ts:113

Returns cached values.

APIStageInstance[]

Array of values.

Manager.values