Line

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

ui/client/features/clone/workflows/Github

Cockpit client (features), next. Source: ui/client/features/clone/workflows/Github.ts.

Type Aliases#

GithubAction#

GithubAction = { status: GithubStatus; type: "STATUS"; } | { type: "STATUS_FAILED"; } | { type: "BUSY"; } | { error: string; type: "ERROR"; } | { query: string; type: "SET_QUERY"; } | { type: "REPOS_LOADING"; } | { list: GithubRepoList; type: "REPOS"; } | { error: string; type: "REPOS_FAILED"; }

Defined in: ui/client/features/clone/workflows/Github.ts:19


GithubState#

GithubState = object

Defined in: ui/client/features/clone/workflows/Github.ts:6

The GitHub connection for private repositories: its status and the repositories it can read. The token is not here (nor anywhere in the browser).

Properties#

busy

busy: boolean

Defined in: ui/client/features/clone/workflows/Github.ts:9

error

error: string | null

Defined in: ui/client/features/clone/workflows/Github.ts:10

list

list: GithubRepoList | null

Defined in: ui/client/features/clone/workflows/Github.ts:12

query

query: string

Defined in: ui/client/features/clone/workflows/Github.ts:14

The filter typed above the picker (asked of the server, which searches all pages).

repos

repos: GithubRepo[]

Defined in: ui/client/features/clone/workflows/Github.ts:11

reposError

reposError: string | null

Defined in: ui/client/features/clone/workflows/Github.ts:16

reposLoading

reposLoading: boolean

Defined in: ui/client/features/clone/workflows/Github.ts:15

status

status: GithubStatus | null

Defined in: ui/client/features/clone/workflows/Github.ts:8

Null until the first answer (or when it failed): the feature shows nothing until it is known to be on.

Variables#

initialGithubState#

const initialGithubState: GithubState

Defined in: ui/client/features/clone/workflows/Github.ts:29

Functions#

githubReducer()#

githubReducer(state, action): GithubState

Defined in: ui/client/features/clone/workflows/Github.ts:31

Parameters#

state

GithubState

action

GithubAction

Returns#

GithubState