Options
All
  • Public
  • Public/Protected
  • All
Menu

Paris

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

DataSetOptionsSort

DataSetOptionsSort: Array<DataQuerySortField>

EntityConfigFunctionOrValue

EntityConfigFunctionOrValue: function | string

EntityFieldConfigFunctionOrValue

EntityFieldConfigFunctionOrValue: function | string

EntityFields

EntityFields: Map<string, Field>

EntityId

EntityId: string | number

ModelPropertyValue

ModelPropertyValue: object

Type declaration

RequestMethod

RequestMethod: "GET" | "DELETE" | SaveRequestMethod

SaveRequestMethod

SaveRequestMethod: "POST" | "PUT" | "PATCH"

UrlParams

UrlParams: object

Type declaration

  • [index: string]: any

Variables

Const DEFAULT_ALL_ITEMS_PROPERTY

DEFAULT_ALL_ITEMS_PROPERTY: "items" = "items"

Const DEFAULT_ID_PROPERTY

DEFAULT_ID_PROPERTY: "id" = "id"

Const DEFAULT_RELATIONSHIP_TYPES

DEFAULT_RELATIONSHIP_TYPES: RelationshipType[] = [RelationshipType.OneToMany, RelationshipType.OneToOne]

Const DEFAULT_TIMEOUT

DEFAULT_TIMEOUT: 60000 = 60000

Const DEFAULT_VALUE_ID

DEFAULT_VALUE_ID: "__default" = "__default"

Const FIELD_DATA_SELF

FIELD_DATA_SELF: "__self" = "__self"

Let entitiesService

entitiesService: EntitiesService = new EntitiesService()

Const entityFieldsService

entityFieldsService: EntityFieldsService = new EntityFieldsService

Const entityRelationshipsService

entityRelationshipsService: EntityRelationshipsService = new EntityRelationshipsService

Const transformers

transformers: Array<DataTransformer> = [{type: Date,parse: (dateValue:string) => new Date(dateValue),serialize: (date:Date) => date ? date.toISOString() : null},{type: RegExp,parse: (pattern:string) => new RegExp(pattern),serialize: (regExp:RegExp) => regExp ? regExp.toString().match(/^\/(.*)\/$/)[1] : null}]

Const transformersMap

transformersMap: Map<Function, DataTransformer> = new Map

Let valueObjectsService

valueObjectsService: ValueObjectsService = new ValueObjectsService

Functions

ApiCall

Entity

  • Entity(config: EntityConfig<any, any, any, any>): (Anonymous function)

EntityField

  • EntityField(fieldConfig?: FieldConfig): PropertyDecorator
  • All properties of models (Entity/ValueObject) that should be handled by Paris should be decorated with EntityField. When Paris creates an instance of a model, it maps the raw data arrived from backend to class properties, through EntityFields.

    Parameters

    Returns PropertyDecorator

EntityRelationship

ValueObject

queryToHttpOptions

Object literals

Const defaultConfig

defaultConfig: object

allItemsProperty

allItemsProperty: string = "items"

entityIdProperty

entityIdProperty: string = "id"

Const defaultDataOptions

defaultDataOptions: object

allowCache

allowCache: true = true

availability

availability: deep = DataAvailability.deep

Generated using TypeDoc