Class ProjectResource

Represents a Checkmarx project resource with chainable async methods.

Implements PromiseLike<CheckmarxProject> so it can be awaited directly to fetch the project info, while also exposing sub-resource methods.

Example

// Await directly to get project info
const project = await cxClient.project('project-id');

// Get branches with filters
const branches = await cxClient.project('project-id').branches({ branchName: 'main' });

Implements

PromiseLike<CheckmarxProject>

Index

Methods

branches get then

Methods

branches

branches(params?: BranchesParams): Promise<CheckmarxBranch[]>
Fetches branches belonging to this project.

GET /api/projects/{projectId}/branches
Parameters
- Optionalparams: BranchesParams
  Optional filters: limit, offset, branchName
Returns Promise<CheckmarxBranch[]>
An array of branches
- Defined in src/resources/ProjectResource.ts:72

get

get(): Promise<CheckmarxProject>
Fetches the project details.

GET /api/projects/{projectId}

Returns Promise<CheckmarxProject>
The project object
- Defined in src/resources/ProjectResource.ts:60

then

then<TResult1 = CheckmarxProject, TResult2 = never>(
    onfulfilled?:
        | null
        | (value: CheckmarxProject) => TResult1 | PromiseLike<TResult1>,
    onrejected?: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>,
): PromiseLike<TResult1 | TResult2>
Allows the resource to be awaited directly, resolving with the project info. Delegates to ProjectResource.get.
Type Parameters
- TResult1 = CheckmarxProject
- TResult2 = never
Parameters
- Optionalonfulfilled: null | (value: CheckmarxProject) => TResult1 | PromiseLike<TResult1>
- Optionalonrejected: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>
Returns PromiseLike<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in src/resources/ProjectResource.ts:46

Class ProjectResource

Example

Implements

Index

Methods

Methods

branches

Parameters

Returns Promise<CheckmarxBranch[]>

get

Returns Promise<CheckmarxProject>

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

Settings

On This Page