Class: Client¶
Entry point for the OLO TypeScript SDK.
Construct with a Connect transport from olo/node (gRPC) or
olo/web (gRPC-Web).
Constructors¶
Constructor¶
new Client(transport, options?): Client;
Parameters¶
Parameter |
Type |
|---|---|
|
|
|
Returns¶
Client
Accessors¶
ai¶
Get Signature¶
get ai(): Ai;
Return the AI API wrapper.
Returns¶
archive¶
Get Signature¶
get archive(): Archive;
Return the local archive API wrapper.
Returns¶
core¶
Get Signature¶
get core(): Core;
Return the Core API wrapper.
Returns¶
kinematics¶
Get Signature¶
get kinematics(): Kinematics;
Return the Kinematics API wrapper.
Returns¶
locomotion¶
Get Signature¶
get locomotion(): Locomotion;
Return the local locomotion API wrapper.
Returns¶
platform¶
Get Signature¶
get platform(): Platform;
Return the platform catalog API (server-direct, PAT-authenticated).
Returns¶
spatial¶
Get Signature¶
get spatial(): Spatial;
Return the Spatial API wrapper.
Returns¶
Methods¶
[asyncDispose]()¶
asyncDispose: Promise<void>;
Returns¶
Promise<void>
close()¶
close(): void;
Release transport resources so short-lived Node scripts can exit cleanly.
Returns¶
void
robot()¶
robot(namespace?): Promise<Robot>;
Return a namespace-scoped robot handle.
Parameters¶
Parameter |
Type |
|---|---|
|
|
Returns¶
Promise<Robot>