Caido
GuidesTutorialsReferenceConcepts

Projects ​

Project ​

Project = object

A saved immutable Project.

Methods ​

getId() ​

getId(): ID

The unique Caido ID of the project.

Returns ​

ID

getName() ​

getName(): string

The name of the project.

Returns ​

string

getPath() ​

getPath(): string

The directory where the project is located.

Returns ​

string

getStatus() ​

getStatus(): ProjectStatus

The status of the project.

Returns ​

ProjectStatus

getVersion() ​

getVersion(): string

The version of the project. The format is MAJOR.MINOR.PATCH.

Returns ​

string

ProjectsSDK ​

ProjectsSDK = object

The SDK for the Projects service.

Methods ​

getCurrent() ​

getCurrent(): Promise<Project | undefined>

Get the currently selected Project if any.

Returns ​

Promise<Project | undefined>

Example ​
js
await sdk.projects.getCurrent();

ProjectStatus ​

ProjectStatus = "ready" | "restoring" | "error"

A Project status.