preferences

preferences

Field	Value
Prefix	preferences
Namespace constant	PreferencesNamespace
Subjects constant	PreferencesSubjects
Kind	bus
Schema record	PreferencesSchemas
Tier	framework
Package	@makaio/services-core
Defined in	packages/services/core/src/preferences/storage-namespace.ts

Subjects

Key	Wire	Type	Schema
delete	preferences.delete	rpc	schemas.ts
get	preferences.get	rpc	schemas.ts
list	preferences.list	rpc	schemas.ts
set	preferences.set	rpc	schemas.ts

Subject Details

preferences.delete (rpc)

Delete a preference.

Subject: preferences.delete Type: Request (RPC)

Request:

Field	Type	Required
category	string	yes
key	{ scope: string; surface?: "ui" | "app" | undefined; context?: string | undefined; viewport?: "desktop" | "tablet" | "mobile" | undefined; }	yes

Response:

Field	Type	Required
success	boolean	yes

preferences.get (rpc)

Get a preference value.

Subject: preferences.get Type: Request (RPC)

Request:

Field	Type	Required
category	string	yes
key	{ scope: string; surface?: "ui" | "app" | undefined; context?: string | undefined; viewport?: "desktop" | "tablet" | "mobile" | undefined; }	yes

Response:

Field	Type	Required
value	unknown	yes

preferences.list (rpc)

List preferences matching criteria.

Subject: preferences.list Type: Request (RPC)

Request:

Field	Type	Required
category	string | undefined	no
key	{ surface?: "ui" | "app" | undefined; scope?: string | undefined; context?: string | undefined; viewport?: "desktop" | "tablet" | "mobile" | undefined; } | undefined	no

Response:

Field	Type	Required
items	{ key: { scope: string; surface?: "ui" | "app" | undefined; context?: string | undefined; viewport?: "desktop" | "tablet" | "mobile" | undefined; }; category: string; value: unknown; updatedAt: number; }[]	yes

preferences.set (rpc)

Set a preference value.

Subject: preferences.set Type: Request (RPC)

Request:

Field	Type	Required
category	string	yes
key	{ scope: string; surface?: "ui" | "app" | undefined; context?: string | undefined; viewport?: "desktop" | "tablet" | "mobile" | undefined; }	yes
value	unknown	yes

Response:

Field	Type	Required
success	boolean	yes

---

Auto-generated by yarn docs:bus. Do not edit manually.