five-on-it / apps/client/src/ui/platform / PlatformMe

Interface: PlatformMe

Defined in: apps/client/src/ui/platform.ts:119

Who the session is (GET /me): the account, its roles, its limits a day and what it used of them today.

Properties

access?

optional access?: object

Defined in: apps/client/src/ui/platform.ts:140

What it may do on the platform: play, create (a platform of an older release says nothing).

create

create: boolean

play

play: boolean

---

account

account: PlatformAccount

Defined in: apps/client/src/ui/platform.ts:120

---

admin

admin: boolean

Defined in: apps/client/src/ui/platform.ts:123

An admin's (FOI_ADMINS): the admin page is theirs.

---

creation?

optional creation?: object

Defined in: apps/client/src/ui/platform.ts:131

Whether creation is open to it now; why not (off on the platform, the account, the day's budget spent) and when it resumes.

available

available: boolean

code?

optional code?: string

reason?

optional reason?: "off" | "account" | "budget"

resumesAt?

optional resumesAt?: string

---

creations?

optional creations?: object

Defined in: apps/client/src/ui/platform.ts:129

Its creations today: how many a day, used, left, and when they start again (ISO); absent on a platform of an older release.

left

left: number

limit

limit: number

resetsAt

resetsAt: string

used

used: number

---

limits

limits: Record<PlatformQuota, number> & object

Defined in: apps/client/src/ui/platform.ts:125

A number a day of each quota (an admin's override, else the defaults), and whether the day's budget skips the account.

Type Declaration

budgetExempt

budgetExempt: boolean

---

moderator

moderator: boolean

Defined in: apps/client/src/ui/platform.ts:121

---

steam?

optional steam?: PlatformSteam | null

Defined in: apps/client/src/ui/platform.ts:138

Its Steam account (none without one; a platform of an older release says nothing).

---

usage

usage: Record<PlatformQuota, number>

Defined in: apps/client/src/ui/platform.ts:127

What it used of each today.