js-bao-wss-client

---

js-bao-wss-client / SetAliasParams

Interface: SetAliasParams

Parameters for documents.aliases.set(): the alias to create or update plus the document it should point to. Set mustNotExist to fail instead of overwriting an existing alias.

Extends

• ResolveAliasParams

Properties

aliasKey

aliasKey: string

Inherited from

ResolveAliasParams.aliasKey

---

documentId

documentId: string

---

mustNotExist?

optional mustNotExist?: boolean

---

scope

scope: "user"

Inherited from

ResolveAliasParams.scope

---

userId?

optional userId?: string

Inherited from

ResolveAliasParams.userId