AspireClient
Handle
interface AspireClient { readonly connected: boolean; cancelToken(tokenId: string): Promise<boolean>; connect(timeoutMs?: number): Promise<void>; disconnect(): void; invokeCapability( capabilityId: string, args?: Record<string, unknown>): Promise<T>; onDisconnect(callback: () => void): void; ping(): Promise<string>;} 7 members
Properties
property
connected boolean get Whether the client is currently connected
Methods
method
cancelToken Cancel a CancellationToken by its ID
cancelToken(tokenId: string): Promise<boolean>Parameters
tokenId string Returns
Promise<boolean> method
connect Connect to the AppHost
connect(timeoutMs?: number): Promise<void>Parameters
timeoutMs number optional Returns
Promise<void> method
invokeCapability Invoke an ATS capability by ID. Results are automatically wrapped in Handle objects when applicable.
invokeCapability<T>( capabilityId: string, args?: Record<string, unknown>): Promise<T>Parameters
capabilityId string args Record<string, unknown> optional Returns
Promise<T> method
onDisconnect Register a callback for connection loss
onDisconnect(callback: () => void): voidParameters
callback () => void