js-bao-wss-client / DocumentAliasesAPI
Interface: DocumentAliasesAPI
Client API for document aliases — stable user-scoped keys that resolve to document IDs. Accessed as client.documents.aliases.
Methods
delete()
delete(
params):Promise<void>
Delete a document alias.
Parameters
params
The alias to delete
Returns
Promise<void>
listForDocument()
listForDocument(
documentId):Promise<DocumentAliasInfo[]>
List all aliases for a document.
Parameters
documentId
string
The document whose aliases to retrieve
Returns
Promise<DocumentAliasInfo[]>
resolve()
resolve(
params):Promise<DocumentAliasInfo|null>
Resolve a document alias to its document ID, returning null if not found.
Parameters
params
The alias to look up
Returns
Promise<DocumentAliasInfo | null>
set()
set(
params):Promise<DocumentAliasInfo>
Create or update a document alias.
Parameters
params
The alias configuration to create or update
Returns
Promise<DocumentAliasInfo>