Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/dev-server/hooks/useDevServerStatus

Cockpit client (features), next. Source: ui/client/features/dev-server/hooks/useDevServerStatus.tsx.

Functions#

useDevServerStatus()#

useDevServerStatus(): object

Defined in: ui/client/features/dev-server/hooks/useDevServerStatus.tsx:11

The dev server's status, polled because it can change with no request in flight (it can crash, the branch can be switched).

Returns#

object

dispatch

dispatch: ActionDispatch<[DevServerAction]>

session

session: DevServerSession

take

take: (run) => Promise<DevServerStatus | null>

Parameters
run

() => Promise<DevServerStatus>

Returns

Promise<DevServerStatus | null>