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

DocumentRepository

Extends:

BaseRepository → DocumentRepository

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

Method Summary

Public Methods
public

async create(bidId: *, documentObject: *): *

public

async delete(bidId: *, documentId: *): *

public

async findById(bidId: *, documentId: *): *

public

async get(bidId: *, params: *): *

Inherited Summary

From class BaseRepository
public
public

http: *

public
public

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

public
public

params: {}

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() source

Creates an instance of BaseRepository.

Override:

BaseRepository#constructor

Public Members

public endpoint: string source

Override:

BaseRepository#endpoint

Public Methods

public async create(bidId: *, documentObject: *): * source

Persists a new entity

Override:

BaseRepository#create

Params:

NameTypeAttributeDescription
bidId *
documentObject *

Return:

*

public async delete(bidId: *, documentId: *): * source

Deletes a single entity by its id

Override:

BaseRepository#delete

Params:

NameTypeAttributeDescription
bidId *
documentId *

Return:

*

public async findById(bidId: *, documentId: *): * source

Retrieves a single domain object by its id.

Override:

BaseRepository#findById

Params:

NameTypeAttributeDescription
bidId *
documentId *

Return:

*

public async get(bidId: *, params: *): * source

Retrieves an array of results for the endpoint

Override:

BaseRepository#get

Params:

NameTypeAttributeDescription
bidId *
params *

Return:

*