website/src/content/docs/api/namespaces/Presence/functions/of.md

editUrl, next, prev, title

editUrl	next	prev	title
false	false	false	of

of(root): object

Create a Presence body which can be either:

• once, the presence is activated only once.
• repeated, per cycle or event, the presence can be changed.

Parameters

• root: Omit<Result, "repeat" | "onRepeat">

Returns

object

once()

once: () => Omit<Result, "repeat" | "onRepeat">

Example

Presence
    .of({
       activities: [
         { name: "Chilling out" }
       ]
     })
    .once() // Sets the presence once, with what's provided in '.of()'

Returns

Omit<Result, "repeat" | "onRepeat">

repeated()

repeated: (onRepeat, repeat) => object

Example

Presence
    .of({ 
         activities: [{ name: "deez nuts" }] 
    }) //starts the presence with "deez nuts".
    .repeated(prev => { 
        return {
            afk: true,
            activities: prev.activities?.map(s => ({ ...s, name: s.name+"s" }))
        };
    }, 10000)) //every 10 s, the callback sets the presence to the returned one.

Parameters

• onRepeat: PresenceReduce

• repeat: number | [Emitter, string]

Returns

object

activities?

optional activities: ActivitiesOptions[]

afk?

optional afk: boolean

onRepeat

onRepeat: PresenceReduce

repeat

repeat: number | [Emitter, string]

shardId?

optional shardId: number[]

status?

optional status: Status

Source

src/core/presences.ts:37