Class ProjectService<ProjectType>

An implementation of the FIN project service.

Type Parameters

ProjectType extends Project = Project

Index

Constructors

Methods

createProject readAll readByName update

Constructors

constructor

new ProjectService<ProjectType extends Project = Project>(
serviceConfig: ClientServiceConfig,
): ProjectService<ProjectType>
Constructs a new project service object.
Type Parameters
- ProjectType extends Project = Project
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
Returns ProjectService<ProjectType>
- Defined in src/client/ProjectService.ts:37

Methods

createProject

createProject(project: HaysonDict | ProjectType): Promise<ProjectType>
Create a project.
Parameters
- project: HaysonDict | ProjectType
Returns Promise<ProjectType>
The created project. Please note, the record only contains the name.

Params
project The project to create.
- Defined in src/client/ProjectService.ts:82

readAll

readAll(): Promise<HGrid<ProjectType>>
Query all projects.

Returns Promise<HGrid<ProjectType>>
The result of the read operation.
- Defined in src/client/ProjectService.ts:66

readByName

readByName(name: string): Promise<ProjectType>
Read a project via its name.
Parameters
- name: string
  The name of the project to read.
Returns Promise<ProjectType>
The project record.

Throws
An error if the project can't be found.
- Defined in src/client/ProjectService.ts:49

update

update(project: HaysonDict | ProjectType): Promise<ProjectType>
Update a project record.
Parameters
- project: HaysonDict | ProjectType
  The project record to update.
Returns Promise<ProjectType>
A updated project record.
- Defined in src/client/ProjectService.ts:102