crouter

Client

Constructing a client, the options it takes, and the authentication and profile calls it exposes.

Exports of @crouter/sdk, read from the TypeScript compiler at build time. Types re-exported from @crouter/api are documented with that package.

AppProfile

interface declared in resources/runs.ts

A profile an app may start runs with (profiles.list()). Pass profile_id as RunStartParams.profile.

Prop

Type

AuthStatus

interface declared in types.ts

Whether this client can reach a daemon that can run a model, and what to do if it cannot.

Prop

Type

AuthStatusParams

type declared in types.ts

The launch-selecting fields used to resolve the provider readiness check.

Prop

Type

Crouter (default)

class declared in client.ts

The client, and the only class an application constructs. Each namespace below wraps a family of daemon routes; request is the escape hatch for a route with no wrapper.

Prop

Type

CrouterOptions

interface declared in client.ts

Connection settings for a Crouter daemon. headers lets a Docker environment's connection() result pass directly to this constructor.

Prop

Type

EnsureProfileParams

type declared in types.ts

The profile settings profiles.ensure creates or updates.

Prop

Type

On this page