Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModelEntity<TEntity, TRawData, TId, TDataSet>

Type parameters

Hierarchy

Implements

Index

Constructors

constructor

Properties

Optional allItemsEndpoint

allItemsEndpoint: string

Optional allItemsEndpointTrailingSlash

allItemsEndpointTrailingSlash: boolean

Optional allItemsProperty

allItemsProperty: string

Optional baseUrl

Optional cache

cache: boolean | ModelEntityCacheConfig<TEntity>

endpoint

entityConstructor

entityConstructor: DataEntityType<TEntity, TRawData, TId>

Optional fields

fields: EntityFields

Optional getRemoveData

getRemoveData: function

Type declaration

    • (items: Array<TEntity>): any
    • Parameters

      • items: Array<TEntity>

      Returns any

Optional idProperty

idProperty: keyof TRawData

Optional loadAll

loadAll: boolean = false

Optional parseDataQuery

parseDataQuery: function

Type declaration

    • Parameters

      Returns object

      • [index: string]: any

Optional parseDataSet

parseDataSet: function

Type declaration

    • (dataSet: TDataSet): DataSet<TRawData>
    • Parameters

      • dataSet: TDataSet

      Returns DataSet<TRawData>

Optional parseItemQuery

parseItemQuery: function

Type declaration

Optional parseRemoveQuery

parseRemoveQuery: function

Type declaration

Optional parseSaveQuery

parseSaveQuery: function

Type declaration

pluralName

pluralName: string

readonly

readonly: boolean = false

Optional serializeItem

serializeItem: function

Type declaration

    • Parameters

      • item: TEntity
      • Optional serializedItem: any
      • Optional entity: IEntityConfigBase
      • Optional config: ParisConfig
      • Optional serializationData: any

      Returns any

singularName

singularName: string

values

values: Array<TEntity>

Accessors

fieldsArray

  • get fieldsArray(): Array<Field>

idField

Methods

getDefaultValue

  • getDefaultValue(): TEntity

getValueById

  • getValueById(valueId: EntityId): TEntity

hasValue

supportsGetMethod

Generated using TypeDoc