Class ProjectResource

Methods for Argo CD projects.

Index

Methods

create deleteByName events get list repositories update

Methods

create

create(project: ArgoCdProject, signal?: AbortSignal): Promise<ArgoCdProject>
Creates a project.
Parameters
- project: ArgoCdProject
- Optionalsignal: AbortSignal
Returns Promise<ArgoCdProject>
- Defined in src/resources/ProjectResource.ts:34

deleteByName

deleteByName(name: string, signal?: AbortSignal): Promise<Record<string, never>>
Deletes a project by name.
Parameters
- name: string
- Optionalsignal: AbortSignal
Returns Promise<Record<string, never>>
- Defined in src/resources/ProjectResource.ts:48

events

events(name: string, signal?: AbortSignal): Promise<ArgoCdEvent[]>
Returns Kubernetes events for a project.
Parameters
- name: string
- Optionalsignal: AbortSignal
Returns Promise<ArgoCdEvent[]>
- Defined in src/resources/ProjectResource.ts:56

get

get(name: string, signal?: AbortSignal): Promise<ArgoCdProject>
Gets one project by name.
Parameters
- name: string
- Optionalsignal: AbortSignal
Returns Promise<ArgoCdProject>
- Defined in src/resources/ProjectResource.ts:25

list

list(
params?: ArgoCdProjectListParams,
signal?: AbortSignal,
): Promise<ArgoCdProjectList>
Lists projects, optionally filtered by name.
Parameters
- params: ArgoCdProjectListParams = {}
- Optionalsignal: AbortSignal
Returns Promise<ArgoCdProjectList>
- Defined in src/resources/ProjectResource.ts:17

repositories

repositories(name: string, signal?: AbortSignal): Promise<ArgoCdRepositoryList>
Returns repositories associated with a project.
Parameters
- name: string
- Optionalsignal: AbortSignal
Returns Promise<ArgoCdRepositoryList>
- Defined in src/resources/ProjectResource.ts:66

update

update(
    name: string,
    project: ArgoCdProject,
    signal?: AbortSignal,
): Promise<ArgoCdProject>
Updates a project by name.
Parameters
- name: string
- project: ArgoCdProject
- Optionalsignal: AbortSignal
Returns Promise<ArgoCdProject>
- Defined in src/resources/ProjectResource.ts:39