ui/client/features/review/hooks/useReviewRoute

Cockpit client (features), v0.9. Source: ui/client/features/review/hooks/useReviewRoute.tsx.

Functions#

useReviewRoute()#

useReviewRoute(): object

Defined in: ui/client/features/review/hooks/useReviewRoute.tsx:13

Which change the URL names: /review is the list, /review?base=main&head=feat is one change, and an optional &plan=<id> compares it with a saved plan. The plan is only an id; the server checks it.

Returns#

base

base: any

head

head: any

openChange

openChange: (b, h, p?) => any

Parameters

b

string

h

string

p?

string | null

Returns

any

openList

openList: (b?) => any

Parameters

b?

string | null

Returns

any

plan

plan: any

setPlan

setPlan: (b, h, p) => any

Switch the plan on the change being viewed (or clear it with null); replaces the URL, no new history entry.

Parameters

b

string

h

string

p

string | null

Returns

any