Home Manual Reference Source

References

summary
public
public

This class serves to quickly load a Project instance with included Bids

public

Creates a authorized context instance.

public

F getAuthToken(username: string, password: string, config: object): Promise<object>

Obtains a user access token and refresh_token.

public

V helpers: *

public

V services: {"BaseWorkupService": *}

domain

summary
public

Assembly Class

public

C Bid

Bids are self assessing classes representing the totality of a bid estimate.

public

A base class for all other bid entities to extend.

public

Bid Variable Class

public

Component Class

public

Component Group Class

public

Datatable Class

public

C Field

Field Class

public

Field Group Class

public

Represents line item data.

public

C Metric

Metric Class

public

A Project contains multiple Bids and summations of the bid results.

public

C User

domain/factories

summary
public

Factory class to generate a Bid instance with internal bid entities.

domain/scaffolding

summary
public
public
public

domain/services

summary
public

Helper class to manage all bid entities in a bid.

public
public

Validates a bid structure and dependencies.

public
public
public
public
public
public
public
public

C ProjectService(projectRepository: ProjectRepository, bidService: BidService)

public

Get the entities assembly if it has one

public

Determine if the entity has an assembly

public

F setAssembly(entity: BidEntity, assembly: Assembly | string): BidEntity

Set the entity's assembly reference. Omitting or passing null for the assembly will UNSET the assembly reference

public
public

repositories

summary
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
this class was deprecated. This class will be removed in version 1.1.x.
public
public
public
this class was deprecated. This class will be removed in version 1.1.x.
public
public
this class was deprecated. This class will be removed in version 1.1.x.
public
public
public
public
public
public

utils

summary
public

The AdvanceEventEmitter extends event emitter 3's functionality to check for max executions (due to circular loops) and adds an ability to fire a delayed event.

public
public
public