SDK Reference

Generated overview of the public @aster/sdk package surface.

The @aster/sdk package is published to npm and documented here from the SDK sources and generated client artifacts.

The main guarantee boundary is simple:

For endpoint-by-endpoint detail, jump to the API reference.

@aster/sdk

Generated SDK metadata

The helpers, entrypoints, client groups, and socket APIs below are read from the checked-in SDK sources and generated client files.

. {"types":"./src/index.ts","development":"./src/index.ts","default":"./dist/index.js"}

./apps {"types":"./src/apps/index.ts","development":"./src/apps/index.ts","default":"./dist/apps/index.js"}

./react {"types":"./src/react/index.ts","development":"./src/react/index.ts","default":"./dist/react/index.js"}

./gate {"types":"./src/gate/index.ts","development":"./src/gate/index.ts","default":"./dist/gate/index.js"}

./gate/client {"types":"./src/gate/client.ts","development":"./src/gate/client.ts","default":"./dist/gate/client.js"}

./gate/server {"types":"./src/gate/server.ts","development":"./src/gate/server.ts","default":"./dist/gate/server.js"}

./gate/transport {"types":"./src/gate/transport.ts","development":"./src/gate/transport.ts","default":"./dist/gate/transport.js"}

Create an authenticated or anonymous JS client for the gateway API.

createAsterClient(config?: AsterClientConfig)

_resolvePackageDirFromExportForTests(require: NodeRequire, specifier: string)

_resolveAsterCommandForTests()

Spawn an Aster server process and wait for gateway readiness.

createAsterServer(options?: ServerOptions)

React hook for Apps SDK pairing and connection state.

useAster(config: AsterMakeConfig, options: UseAsterOptions = {})

connectRuntimeCommandSocket(input: ConnectGatewayRuntimeSocketOptions)

Open the runtime WebSocket and subscribe to run events.

connectGatewayRuntimeSocket(input: ConnectGatewayRuntimeSocketOptions)