Home Manual Reference Source 
import BaseRepository from 'pvbid-sdk/src/repositories/BaseRepository.js'
public class | source

BaseRepository

Direct Subclass:

AssemblyRepository, BaseDefinitionRepository, BidRepository, CacheRepository, DatatableRepository, DocumentRepository, DynamicGroupRepository, FieldRepository, IndustryWidePredictionModelRepository, LineItemRepository, MetricRepository, PredictionModelRepository, ProjectRepository, SnapshotRepository, UserRepository

Indirect Subclass:

AssemblyDefRepository, ComponentDefRepository, ComponentGroupDefRepository, DatatableDefRepository, FieldDefRepository, FieldGroupDefRepository, LineItemDefRepository, MetricDefRepository, ProjectStatusRepository, TagRepository

Constructor Summary

Public Constructor
public

constructor(endpoint: string, singleMap: string, multiMap: string)

Creates an instance of BaseRepository.

Member Summary

Public Members
public
public

http: *

public
public

map: {"single": *, "multi": *}

public
public

params: {}

Method Summary

Public Methods
public

async create(entity: BidEntity): Promise<BidEntity>

Persists a new entity
public

async delete(id: number | string): Promise<Object>

Deletes a single entity by its id
public

Retrieves a single domain object by its id.
public

async get(params: Object): Promise<BidEntity[]>

Retrieves an array of results for the endpoint
public

async save(entity: BidEntity): Promise<BidEntity>

Persists an update to the entity

Public Constructors

public constructor(endpoint: string, singleMap: string, multiMap: string) source

Creates an instance of BaseRepository.

Params:

NameTypeAttributeDescription
endpoint string

The API endpoint for the entity
singleMap string

The singular noun for the entity (ie. 'bid' or 'assembly')
multiMap string

The plural noun for the entity (ie. 'bids' or 'assemblies')

Public Members

public endpoint: * source

public http: * source

public httpConfig: * source

public map: {"single": *, "multi": *} source

public metaData: * source

public params: {} source

Public Methods

public async create(entity: BidEntity): Promise<BidEntity> source

Persists a new entity

Params:

NameTypeAttributeDescription
entity BidEntity

An entity object to persist

Return:

Promise<BidEntity>

The newly persisted entity

public async delete(id: number | string): Promise<Object> source

Deletes a single entity by its id

Params:

NameTypeAttributeDescription
id number | string

The id of the entity to delete

Return:

Promise<Object>

Response status message

public async findById(id: number | string): Promise<BidEntity|undefined> source

Retrieves a single domain object by its id.

Params:

NameTypeAttributeDescription
id number | string

The id of the entity to retrieve.

Return:

Promise<BidEntity|undefined>

public async get(params: Object): Promise<BidEntity[]> source

Retrieves an array of results for the endpoint

Params:

NameTypeAttributeDescription
params Object
  • optional

A set of parameters to include for the endpoint.

Return:

Promise<BidEntity[]>

Array of results filtered by the given params

public async save(entity: BidEntity): Promise<BidEntity> source

Persists an update to the entity

Params:

NameTypeAttributeDescription
entity BidEntity

Return:

Promise<BidEntity>

The updated entity