From d330ca9ce03d6ad0ffa17395eb75f625699e91c4 Mon Sep 17 00:00:00 2001 From: Shai Rose Date: Wed, 25 Jul 2018 16:49:00 +0300 Subject: [PATCH] updated docs --- DOCS_README.md | 1 + docs/classes/apicallmodel.html | 2 +- docs/classes/datacache.html | 18 ++--- docs/classes/datastoreservice.html | 10 +-- docs/classes/datatransformersservice.html | 4 +- docs/classes/entitiesservice.html | 8 +-- docs/classes/entitiesservicebase.html | 8 +-- docs/classes/entityconfigbase.html | 28 ++++---- docs/classes/entityfieldsservice.html | 4 +- docs/classes/entitymodelbase.html | 6 +- docs/classes/entityrelationshipsservice.html | 4 +- docs/classes/errorsservice.html | 2 +- docs/classes/http.html | 18 ++--- docs/classes/immutability.html | 4 +- docs/classes/modelbase.html | 6 +- docs/classes/modelentity.html | 52 +++++++------- docs/classes/paris.html | 36 +++++----- docs/classes/readonlyrepository.html | 38 +++++----- docs/classes/relationshiprepository.html | 56 +++++++-------- docs/classes/repository.html | 50 ++++++------- docs/classes/todo.html | 10 +-- docs/classes/valueobjectsservice.html | 8 +-- docs/enums/dataavailability.html | 6 +- docs/enums/dataquerysortdirection.html | 4 +- docs/enums/entityerrortypes.html | 4 +- docs/enums/entitygetmethod.html | 4 +- docs/enums/relationshiptype.html | 4 +- docs/globals.html | 70 +++++++++---------- docs/index.html | 1 + .../apicallbackendconfiginterface.html | 12 ++-- docs/interfaces/apicallconfig.html | 26 +++---- docs/interfaces/apicalltype.html | 4 +- docs/interfaces/datacachesettings.html | 6 +- docs/interfaces/dataentityconstructor.html | 10 +-- docs/interfaces/dataentitytype.html | 10 +-- docs/interfaces/dataoptions.html | 4 +- docs/interfaces/dataquery.html | 8 +-- docs/interfaces/dataquerysortfield.html | 4 +- docs/interfaces/dataset.html | 8 +-- docs/interfaces/datatransformer.html | 6 +- docs/interfaces/entitybackendconfig.html | 34 ++++----- docs/interfaces/entityconfig.html | 58 +++++++-------- docs/interfaces/entityerrorevent.html | 6 +- docs/interfaces/entityevent.html | 2 +- docs/interfaces/entitymodelconfigbase.html | 2 +- docs/interfaces/entityrelationshipconfig.html | 44 ++++++------ .../entityrelationshiprepositorytype.html | 8 +-- docs/interfaces/field.html | 24 +++---- docs/interfaces/fieldconfig.html | 18 ++--- docs/interfaces/httpoptions.html | 8 +-- docs/interfaces/ientityconfigbase.html | 24 +++---- .../ientityrelationshiprepositorytype.html | 8 +-- docs/interfaces/ireadonlyrepository.html | 18 ++--- docs/interfaces/irelationshiprepository.html | 30 ++++---- docs/interfaces/irepository.html | 20 +++--- docs/interfaces/modelconfig.html | 28 ++++---- docs/interfaces/modelentitycacheconfig.html | 4 +- docs/interfaces/parisconfig.html | 10 +-- docs/interfaces/removeentitiesevent.html | 4 +- docs/interfaces/saveentityevent.html | 8 +-- docs/interfaces/saveitems.html | 4 +- 61 files changed, 464 insertions(+), 462 deletions(-) diff --git a/DOCS_README.md b/DOCS_README.md index 3ee55b6..c631b42 100644 --- a/DOCS_README.md +++ b/DOCS_README.md @@ -70,3 +70,4 @@ Check the [Wiki](https://github.com/Microsoft/paris/wiki) for advanced uses and [Github](https://github.com/Microsoft/paris) +![logo](https://github.com/Microsoft/paris/blob/master/paris_logo-192x192.png) \ No newline at end of file diff --git a/docs/classes/apicallmodel.html b/docs/classes/apicallmodel.html index 62387df..180cb34 100644 --- a/docs/classes/apicallmodel.html +++ b/docs/classes/apicallmodel.html @@ -104,7 +104,7 @@
config: ApiCallConfig<TResult, TInput>
diff --git a/docs/classes/datacache.html b/docs/classes/datacache.html index 0ff206f..b57cadb 100644 --- a/docs/classes/datacache.html +++ b/docs/classes/datacache.html @@ -123,7 +123,7 @@
  • Parameters

    @@ -145,7 +145,7 @@
    getter: function
    @@ -187,7 +187,7 @@
    obj: number
    @@ -197,7 +197,7 @@
    time: function | number
    @@ -214,7 +214,7 @@
  • @@ -245,7 +245,7 @@
  • @@ -267,7 +267,7 @@
  • Returns void

    @@ -284,7 +284,7 @@
  • @@ -339,7 +339,7 @@
  • diff --git a/docs/classes/datastoreservice.html b/docs/classes/datastoreservice.html index c471ffb..d7a3219 100644 --- a/docs/classes/datastoreservice.html +++ b/docs/classes/datastoreservice.html @@ -106,7 +106,7 @@
  • Parameters

    @@ -132,7 +132,7 @@
  • Parameters

    @@ -164,7 +164,7 @@
  • Type parameters

    @@ -202,7 +202,7 @@
  • Type parameters

    @@ -243,7 +243,7 @@
  • Type parameters

    diff --git a/docs/classes/datatransformersservice.html b/docs/classes/datatransformersservice.html index d1bb10c..107d3f2 100644 --- a/docs/classes/datatransformersservice.html +++ b/docs/classes/datatransformersservice.html @@ -98,7 +98,7 @@
  • Parameters

    @@ -124,7 +124,7 @@
  • Parameters

    diff --git a/docs/classes/entitiesservice.html b/docs/classes/entitiesservice.html index bbb9299..c0c91e0 100644 --- a/docs/classes/entitiesservice.html +++ b/docs/classes/entitiesservice.html @@ -122,7 +122,7 @@

    Returns Array<ModelEntity>

    @@ -143,7 +143,7 @@

    Parameters

    @@ -170,7 +170,7 @@

    Parameters

    @@ -194,7 +194,7 @@

    Parameters

    diff --git a/docs/classes/entitiesservicebase.html b/docs/classes/entitiesservicebase.html index a91ee29..3f83b1a 100644 --- a/docs/classes/entitiesservicebase.html +++ b/docs/classes/entitiesservicebase.html @@ -127,7 +127,7 @@
  • Returns Array<T>

    @@ -147,7 +147,7 @@
  • Parameters

    @@ -173,7 +173,7 @@
  • Parameters

    @@ -196,7 +196,7 @@
  • Parameters

    diff --git a/docs/classes/entityconfigbase.html b/docs/classes/entityconfigbase.html index b0cc9c2..4885c3f 100644 --- a/docs/classes/entityconfigbase.html +++ b/docs/classes/entityconfigbase.html @@ -150,7 +150,7 @@
  • Parameters

    @@ -176,7 +176,7 @@ @@ -187,7 +187,7 @@ @@ -198,7 +198,7 @@ @@ -209,7 +209,7 @@ @@ -220,7 +220,7 @@ @@ -231,7 +231,7 @@
    @@ -275,7 +275,7 @@ @@ -286,7 +286,7 @@ @@ -303,7 +303,7 @@
  • Returns Array<Field>

    @@ -323,7 +323,7 @@
  • Returns TEntity

    @@ -340,7 +340,7 @@
  • Parameters

    @@ -363,7 +363,7 @@
  • Parameters

    @@ -386,7 +386,7 @@
  • Parameters

    diff --git a/docs/classes/entityfieldsservice.html b/docs/classes/entityfieldsservice.html index 604a80f..d1e77d0 100644 --- a/docs/classes/entityfieldsservice.html +++ b/docs/classes/entityfieldsservice.html @@ -98,7 +98,7 @@
  • Parameters

    @@ -124,7 +124,7 @@
  • Parameters

    diff --git a/docs/classes/entitymodelbase.html b/docs/classes/entitymodelbase.html index 7b0e720..f90ff11 100644 --- a/docs/classes/entitymodelbase.html +++ b/docs/classes/entitymodelbase.html @@ -123,7 +123,7 @@

    Parameters

    @@ -146,7 +146,7 @@ @@ -157,7 +157,7 @@ diff --git a/docs/classes/entityrelationshipsservice.html b/docs/classes/entityrelationshipsservice.html index 5023625..292c1a0 100644 --- a/docs/classes/entityrelationshipsservice.html +++ b/docs/classes/entityrelationshipsservice.html @@ -98,7 +98,7 @@
  • Type parameters

    @@ -130,7 +130,7 @@
  • Type parameters

    diff --git a/docs/classes/errorsservice.html b/docs/classes/errorsservice.html index cde4e38..9e7f408 100644 --- a/docs/classes/errorsservice.html +++ b/docs/classes/errorsservice.html @@ -97,7 +97,7 @@
  • Parameters

    diff --git a/docs/classes/http.html b/docs/classes/http.html index f2d8523..6645d13 100644 --- a/docs/classes/http.html +++ b/docs/classes/http.html @@ -105,7 +105,7 @@
  • Parameters

    @@ -134,7 +134,7 @@
  • Parameters

    @@ -163,7 +163,7 @@
  • Parameters

    @@ -192,7 +192,7 @@
  • Parameters

    @@ -218,7 +218,7 @@
  • Parameters

    @@ -244,7 +244,7 @@
  • Parameters

    @@ -273,7 +273,7 @@
  • Parameters

    @@ -302,7 +302,7 @@
  • Parameters

    @@ -331,7 +331,7 @@
  • Type parameters

    diff --git a/docs/classes/immutability.html b/docs/classes/immutability.html index ca4e4fc..d91439d 100644 --- a/docs/classes/immutability.html +++ b/docs/classes/immutability.html @@ -98,7 +98,7 @@
  • @@ -141,7 +141,7 @@
  • Type parameters

    diff --git a/docs/classes/modelbase.html b/docs/classes/modelbase.html index b3c7936..f477bdb 100644 --- a/docs/classes/modelbase.html +++ b/docs/classes/modelbase.html @@ -109,7 +109,7 @@
  • Parameters

    @@ -131,7 +131,7 @@
    $parent: ModelBase
    @@ -141,7 +141,7 @@
    id: any
    diff --git a/docs/classes/modelentity.html b/docs/classes/modelentity.html index 71580c4..5cf0c3b 100644 --- a/docs/classes/modelentity.html +++ b/docs/classes/modelentity.html @@ -164,7 +164,7 @@

    Parameters

    @@ -190,7 +190,7 @@ @@ -201,7 +201,7 @@ @@ -212,7 +212,7 @@ @@ -223,7 +223,7 @@ @@ -234,7 +234,7 @@ @@ -245,7 +245,7 @@ @@ -257,7 +257,7 @@

    Implementation of EntityConfig.entityConstructor

    Inherited from EntityConfigBase.entityConstructor

    @@ -269,7 +269,7 @@

    Implementation of ModelConfig.fields

    Inherited from EntityConfigBase.fields

    @@ -280,7 +280,7 @@
    @@ -313,7 +313,7 @@

    Implementation of EntityConfig.idProperty

    Inherited from EntityConfigBase.idProperty

    @@ -324,7 +324,7 @@ @@ -335,7 +335,7 @@
    @@ -372,7 +372,7 @@
    @@ -418,7 +418,7 @@
    @@ -456,7 +456,7 @@
    @@ -495,7 +495,7 @@

    Implementation of EntityConfig.pluralName

    Inherited from EntityConfigBase.pluralName

    @@ -507,7 +507,7 @@

    Implementation of EntityConfig.readonly

    Inherited from EntityConfigBase.readonly

    @@ -519,7 +519,7 @@

    Implementation of EntityConfig.serializeItem

    Overrides EntityConfigBase.serializeItem

    @@ -564,7 +564,7 @@

    Implementation of EntityConfig.singularName

    Inherited from EntityConfigBase.singularName

    @@ -576,7 +576,7 @@

    Implementation of EntityConfig.values

    Inherited from EntityConfigBase.values

    @@ -594,7 +594,7 @@

    Returns Array<Field>

    @@ -615,7 +615,7 @@

    Returns TEntity

    @@ -633,7 +633,7 @@

    Parameters

    @@ -657,7 +657,7 @@

    Parameters

    @@ -681,7 +681,7 @@

    Parameters

    diff --git a/docs/classes/paris.html b/docs/classes/paris.html index 1c70898..ae23fa2 100644 --- a/docs/classes/paris.html +++ b/docs/classes/paris.html @@ -124,7 +124,7 @@
  • Parameters

    @@ -146,7 +146,7 @@
    config: ParisConfig
    @@ -156,7 +156,7 @@
    dataStore: DataStoreService
    @@ -166,7 +166,7 @@
    error$: Observable<EntityErrorEvent>
    @@ -182,7 +182,7 @@
    remove$: Observable<RemoveEntitiesEvent>
    @@ -197,7 +197,7 @@
    save$: Observable<SaveEntityEvent>
    @@ -219,7 +219,7 @@
  • @@ -253,7 +253,7 @@
  • @@ -306,7 +306,7 @@
  • @@ -349,7 +349,7 @@
  • @@ -401,7 +401,7 @@
  • @@ -460,7 +460,7 @@ toDo$.subscribe((toDo:Todo
  • @@ -490,7 +490,7 @@ toDo$.subscribe((toDo:Todo
  • @@ -550,7 +550,7 @@ toDoListHistory$.subscribe((
    @@ -590,7 +590,7 @@ toDoListHistory$.subscribe((
    @@ -630,7 +630,7 @@ toDoListHistory$.subscribe((
    @@ -677,7 +677,7 @@ toDoListHistory$.subscribe((
    @@ -727,7 +727,7 @@ toDoListHistory$.subscribe((
    diff --git a/docs/classes/readonlyrepository.html b/docs/classes/readonlyrepository.html index 143908f..bd01f45 100644 --- a/docs/classes/readonlyrepository.html +++ b/docs/classes/readonlyrepository.html @@ -163,7 +163,7 @@
  • Parameters

    @@ -201,7 +201,7 @@ @@ -211,7 +211,7 @@
    entityBackendConfig: EntityBackendConfig<TEntity, TRawData>
    @@ -221,7 +221,7 @@
    entityConstructor: DataEntityConstructor<TEntity>
    @@ -231,7 +231,7 @@
    error$: Observable<EntityErrorEvent>
    @@ -248,7 +248,7 @@
  • @@ -271,7 +271,7 @@
  • @@ -296,7 +296,7 @@
  • @@ -318,7 +318,7 @@
  • @@ -340,7 +340,7 @@
  • @@ -378,7 +378,7 @@
  • @@ -401,7 +401,7 @@
  • @@ -429,7 +429,7 @@
  • @@ -468,7 +468,7 @@
  • @@ -514,7 +514,7 @@
  • @@ -546,7 +546,7 @@
  • @@ -577,7 +577,7 @@
  • @@ -631,7 +631,7 @@
  • @@ -677,7 +677,7 @@
  • diff --git a/docs/classes/relationshiprepository.html b/docs/classes/relationshiprepository.html index 91f19a7..e5b62c8 100644 --- a/docs/classes/relationshiprepository.html +++ b/docs/classes/relationshiprepository.html @@ -166,7 +166,7 @@

    Parameters

    @@ -204,7 +204,7 @@ @@ -215,7 +215,7 @@ @@ -227,7 +227,7 @@

    Implementation of IRelationshipRepository.entity

    Inherited from ReadonlyRepository.entity

    @@ -238,7 +238,7 @@ @@ -249,7 +249,7 @@ @@ -260,7 +260,7 @@ @@ -271,7 +271,7 @@ @@ -282,7 +282,7 @@ @@ -292,7 +292,7 @@
    sourceItem: TSource
    @@ -310,7 +310,7 @@
  • Parameters

    @@ -566,7 +566,7 @@
  • @@ -602,7 +602,7 @@

    Parameters

    @@ -628,7 +628,7 @@
  • Parameters

    @@ -657,7 +657,7 @@
  • @@ -693,7 +693,7 @@

    Parameters

    @@ -720,7 +720,7 @@
    @@ -752,7 +752,7 @@
    @@ -807,7 +807,7 @@
    @@ -854,7 +854,7 @@
    diff --git a/docs/classes/repository.html b/docs/classes/repository.html index 7a03fa3..da56ada 100644 --- a/docs/classes/repository.html +++ b/docs/classes/repository.html @@ -160,7 +160,7 @@

    Parameters

    @@ -196,7 +196,7 @@

    Implementation of IRepository.entity

    Inherited from ReadonlyRepository.entity

    @@ -207,7 +207,7 @@ @@ -218,7 +218,7 @@ @@ -229,7 +229,7 @@ @@ -239,7 +239,7 @@
    remove$: Observable<RemoveEntitiesEvent>
    @@ -249,7 +249,7 @@
    save$: Observable<SaveEntityEvent>
    @@ -267,7 +267,7 @@
    @@ -291,7 +291,7 @@
  • @@ -605,7 +605,7 @@
  • @@ -636,7 +636,7 @@
  • @@ -673,7 +673,7 @@
  • @@ -705,7 +705,7 @@
    @@ -737,7 +737,7 @@
    @@ -792,7 +792,7 @@
    @@ -839,7 +839,7 @@
    diff --git a/docs/classes/todo.html b/docs/classes/todo.html index 9d59f27..da5c681 100644 --- a/docs/classes/todo.html +++ b/docs/classes/todo.html @@ -113,7 +113,7 @@

    Inherited from EntityModelBase.constructor

    Overrides ModelBase.constructor

    Parameters

    @@ -136,7 +136,7 @@ @@ -148,7 +148,7 @@

    Inherited from EntityModelBase.id

    Overrides ModelBase.id

    @@ -158,7 +158,7 @@
    text: string
    @@ -168,7 +168,7 @@
    time: Date
    diff --git a/docs/classes/valueobjectsservice.html b/docs/classes/valueobjectsservice.html index 76343dc..9391600 100644 --- a/docs/classes/valueobjectsservice.html +++ b/docs/classes/valueobjectsservice.html @@ -122,7 +122,7 @@

    Returns Array<EntityConfigBase>

    @@ -143,7 +143,7 @@

    Parameters

    @@ -170,7 +170,7 @@

    Parameters

    @@ -194,7 +194,7 @@

    Parameters

    diff --git a/docs/enums/dataavailability.html b/docs/enums/dataavailability.html index 68e0390..b9db869 100644 --- a/docs/enums/dataavailability.html +++ b/docs/enums/dataavailability.html @@ -94,7 +94,7 @@
    available:
    @@ -109,7 +109,7 @@
    deep:
    @@ -124,7 +124,7 @@
    flat:
    diff --git a/docs/enums/dataquerysortdirection.html b/docs/enums/dataquerysortdirection.html index 4f3bf9a..413e6ce 100644 --- a/docs/enums/dataquerysortdirection.html +++ b/docs/enums/dataquerysortdirection.html @@ -86,7 +86,7 @@
    ascending:
    @@ -96,7 +96,7 @@
    descending:
    diff --git a/docs/enums/entityerrortypes.html b/docs/enums/entityerrortypes.html index 5e5f9ec..74a5355 100644 --- a/docs/enums/entityerrortypes.html +++ b/docs/enums/entityerrortypes.html @@ -86,7 +86,7 @@
    DataParseError:
    @@ -96,7 +96,7 @@
    HttpError:
    diff --git a/docs/enums/entitygetmethod.html b/docs/enums/entitygetmethod.html index e659498..793ab6f 100644 --- a/docs/enums/entitygetmethod.html +++ b/docs/enums/entitygetmethod.html @@ -86,7 +86,7 @@
    getItem:
    @@ -96,7 +96,7 @@
    query:
    diff --git a/docs/enums/relationshiptype.html b/docs/enums/relationshiptype.html index e2a46a5..0ab34de 100644 --- a/docs/enums/relationshiptype.html +++ b/docs/enums/relationshiptype.html @@ -86,7 +86,7 @@
    OneToMany:
    @@ -96,7 +96,7 @@
    OneToOne:
    diff --git a/docs/globals.html b/docs/globals.html index 33f0bf6..d44c602 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -201,7 +201,7 @@
    DataSetOptionsSort: Array<DataQuerySortField>
    @@ -211,7 +211,7 @@
    EntityConfigFunctionOrValue: function | string
    @@ -221,7 +221,7 @@
    EntityFieldConfigFunctionOrValue: function | string
    @@ -231,7 +231,7 @@
    EntityFields: Map<string, Field>
    @@ -241,7 +241,7 @@
    EntityId: string | number
    @@ -251,7 +251,7 @@
    Index: object
    @@ -269,7 +269,7 @@
    ModelPropertyValue: object
    @@ -287,7 +287,7 @@
    RequestMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
    @@ -297,7 +297,7 @@
    UrlParams: object
    @@ -318,7 +318,7 @@
    DEFAULT_RELATIONSHIP_TYPES: RelationshipType[] = [RelationshipType.OneToMany, RelationshipType.OneToOne]
    @@ -328,7 +328,7 @@
    DEFAULT_TIMEOUT: 60000 = 60000
    @@ -338,7 +338,7 @@
    DEFAULT_VALUE_ID: "__default" = "__default"
    @@ -348,7 +348,7 @@
    FIELD_DATA_SELF: "__self" = "__self"
    @@ -358,7 +358,7 @@
    entitiesService: EntitiesService = new EntitiesService()
    @@ -368,7 +368,7 @@
    entityFieldsService: EntityFieldsService = new EntityFieldsService
    @@ -378,7 +378,7 @@
    entityRelationshipsService: EntityRelationshipsService = new EntityRelationshipsService
    @@ -388,7 +388,7 @@
    expect: ExpectStatic = chai.expect
    @@ -398,7 +398,7 @@
    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}]
    @@ -408,7 +408,7 @@
    transformersMap: Map<Function, DataTransformer> = new Map
    @@ -418,7 +418,7 @@
    valueObjectsService: ValueObjectsService = new ValueObjectsService
    @@ -435,7 +435,7 @@
  • Parameters

    @@ -458,7 +458,7 @@
  • Parameters

    @@ -481,7 +481,7 @@
  • @@ -512,7 +512,7 @@
  • Parameters

    @@ -535,7 +535,7 @@
  • Parameters

    @@ -558,7 +558,7 @@
  • Type parameters

    @@ -602,7 +602,7 @@
  • Type parameters

    @@ -646,7 +646,7 @@
  • Parameters

    @@ -669,7 +669,7 @@
  • Type parameters

    @@ -715,7 +715,7 @@
    defaultConfig: object
    @@ -724,7 +724,7 @@
    allItemsProperty: string = "items"
    @@ -734,7 +734,7 @@
    entityIdProperty: string = "id"
    @@ -745,7 +745,7 @@
    defaultDataOptions: object
    @@ -754,7 +754,7 @@
    allowCache: true = true
    @@ -764,7 +764,7 @@
    availability: deep = DataAvailability.deep
    diff --git a/docs/index.html b/docs/index.html index b952289..3b5d667 100644 --- a/docs/index.html +++ b/docs/index.html @@ -109,6 +109,7 @@ paris.getItemById(TodoItem, 1).subscribe(Advanced

    Check the Wiki for advanced uses and explanations.

    Github

    +

    logo

  • Returns TResult

    diff --git a/docs/interfaces/apicalltype.html b/docs/interfaces/apicalltype.html index 7c2ada1..3b7453a 100644 --- a/docs/interfaces/apicalltype.html +++ b/docs/interfaces/apicalltype.html @@ -114,7 +114,7 @@
  • Parameters

    @@ -136,7 +136,7 @@
    config: ApiCallConfig<TResult, TInput>
    diff --git a/docs/interfaces/datacachesettings.html b/docs/interfaces/datacachesettings.html index 09ed01e..5cbe547 100644 --- a/docs/interfaces/datacachesettings.html +++ b/docs/interfaces/datacachesettings.html @@ -103,7 +103,7 @@
    getter: function
    @@ -134,7 +134,7 @@
    max: number
    @@ -144,7 +144,7 @@
    time: function | number
    diff --git a/docs/interfaces/dataentityconstructor.html b/docs/interfaces/dataentityconstructor.html index 99fbfbf..a132110 100644 --- a/docs/interfaces/dataentityconstructor.html +++ b/docs/interfaces/dataentityconstructor.html @@ -126,7 +126,7 @@

    Parameters

    @@ -152,7 +152,7 @@ @@ -163,7 +163,7 @@ @@ -174,7 +174,7 @@ @@ -185,7 +185,7 @@ diff --git a/docs/interfaces/dataentitytype.html b/docs/interfaces/dataentitytype.html index 5ea8e13..d676700 100644 --- a/docs/interfaces/dataentitytype.html +++ b/docs/interfaces/dataentitytype.html @@ -125,7 +125,7 @@
  • Parameters

    @@ -150,7 +150,7 @@
    entityConfig: ModelEntity<TEntity, TRawData, TId>
    @@ -160,7 +160,7 @@
    pluralName: string
    @@ -170,7 +170,7 @@
    singularName: string
    @@ -180,7 +180,7 @@
    valueObjectConfig: EntityConfigBase
    diff --git a/docs/interfaces/dataoptions.html b/docs/interfaces/dataoptions.html index 6eb1d70..cdf1567 100644 --- a/docs/interfaces/dataoptions.html +++ b/docs/interfaces/dataoptions.html @@ -101,7 +101,7 @@
    allowCache: boolean
    @@ -116,7 +116,7 @@
    availability: DataAvailability
    diff --git a/docs/interfaces/dataquery.html b/docs/interfaces/dataquery.html index 50291cd..d1c0d7a 100644 --- a/docs/interfaces/dataquery.html +++ b/docs/interfaces/dataquery.html @@ -96,7 +96,7 @@
    page: number
    @@ -106,7 +106,7 @@
    pageSize: number
    @@ -116,7 +116,7 @@ @@ -126,7 +126,7 @@
    where: object | string
    diff --git a/docs/interfaces/dataquerysortfield.html b/docs/interfaces/dataquerysortfield.html index 2e1f153..9fd972c 100644 --- a/docs/interfaces/dataquerysortfield.html +++ b/docs/interfaces/dataquerysortfield.html @@ -94,7 +94,7 @@ @@ -104,7 +104,7 @@
    field: string
    diff --git a/docs/interfaces/dataset.html b/docs/interfaces/dataset.html index c83e249..08bc3c9 100644 --- a/docs/interfaces/dataset.html +++ b/docs/interfaces/dataset.html @@ -104,7 +104,7 @@
    count: number
    @@ -114,7 +114,7 @@
    items: Array<T>
    @@ -124,7 +124,7 @@
    next: string
    @@ -134,7 +134,7 @@
    previous: string
    diff --git a/docs/interfaces/datatransformer.html b/docs/interfaces/datatransformer.html index a9c53e1..0acf54e 100644 --- a/docs/interfaces/datatransformer.html +++ b/docs/interfaces/datatransformer.html @@ -95,7 +95,7 @@
    parse: Function
    @@ -105,7 +105,7 @@
    serialize: Function
    @@ -115,7 +115,7 @@
    type: any
    diff --git a/docs/interfaces/entitybackendconfig.html b/docs/interfaces/entitybackendconfig.html index ee206bc..5b89b22 100644 --- a/docs/interfaces/entitybackendconfig.html +++ b/docs/interfaces/entitybackendconfig.html @@ -142,7 +142,7 @@
    allItemsEndpoint: string
    @@ -159,7 +159,7 @@
    allItemsEndpointTrailingSlash: boolean
    @@ -181,7 +181,7 @@
    allItemsProperty: string
    @@ -217,7 +217,7 @@ @@ -228,7 +228,7 @@ @@ -239,7 +239,7 @@ @@ -250,7 +250,7 @@
    @@ -268,7 +268,7 @@
    getRemoveData: function
    @@ -309,7 +309,7 @@
    loadAll: boolean
    @@ -331,7 +331,7 @@
    @@ -368,7 +368,7 @@
    parseDataQuery: function
    @@ -414,7 +414,7 @@
    parseItemQuery: function
    @@ -482,7 +482,7 @@
    parseRemoveQuery: function
    @@ -534,7 +534,7 @@
    parseSaveQuery: function
    @@ -591,7 +591,7 @@
    saveMethod: function | RequestMethod
    @@ -609,7 +609,7 @@ @@ -619,7 +619,7 @@
    timeout: number
    diff --git a/docs/interfaces/entityconfig.html b/docs/interfaces/entityconfig.html index e2dbfbb..de3e2ca 100644 --- a/docs/interfaces/entityconfig.html +++ b/docs/interfaces/entityconfig.html @@ -156,7 +156,7 @@
    @@ -174,7 +174,7 @@
    @@ -197,7 +197,7 @@
    @@ -233,7 +233,7 @@ @@ -244,7 +244,7 @@ @@ -255,7 +255,7 @@ @@ -266,7 +266,7 @@ @@ -277,7 +277,7 @@
    @@ -296,7 +296,7 @@
    @@ -322,7 +322,7 @@
    @@ -364,7 +364,7 @@
    @@ -396,7 +396,7 @@
    @@ -439,7 +439,7 @@
    @@ -455,7 +455,7 @@
    @@ -477,7 +477,7 @@
    @@ -515,7 +515,7 @@
    @@ -562,7 +562,7 @@
    @@ -631,7 +631,7 @@
    @@ -684,7 +684,7 @@
    @@ -725,7 +725,7 @@
    @@ -783,7 +783,7 @@
    @@ -800,7 +800,7 @@
    @@ -822,7 +822,7 @@
    @@ -840,7 +840,7 @@ @@ -851,7 +851,7 @@
    @@ -895,7 +895,7 @@
    @@ -912,7 +912,7 @@ @@ -923,7 +923,7 @@
    @@ -944,7 +944,7 @@
    diff --git a/docs/interfaces/entityerrorevent.html b/docs/interfaces/entityerrorevent.html index 58d3f66..1783c89 100644 --- a/docs/interfaces/entityerrorevent.html +++ b/docs/interfaces/entityerrorevent.html @@ -101,7 +101,7 @@ @@ -111,7 +111,7 @@
    originalError: any
    @@ -121,7 +121,7 @@ diff --git a/docs/interfaces/entityevent.html b/docs/interfaces/entityevent.html index f0ce8ce..77a8902 100644 --- a/docs/interfaces/entityevent.html +++ b/docs/interfaces/entityevent.html @@ -104,7 +104,7 @@ diff --git a/docs/interfaces/entitymodelconfigbase.html b/docs/interfaces/entitymodelconfigbase.html index c4c003c..b5a84a0 100644 --- a/docs/interfaces/entitymodelconfigbase.html +++ b/docs/interfaces/entitymodelconfigbase.html @@ -97,7 +97,7 @@
    id: string | number
    diff --git a/docs/interfaces/entityrelationshipconfig.html b/docs/interfaces/entityrelationshipconfig.html index 500c3fa..16c6550 100644 --- a/docs/interfaces/entityrelationshipconfig.html +++ b/docs/interfaces/entityrelationshipconfig.html @@ -143,7 +143,7 @@
    @@ -161,7 +161,7 @@
    @@ -184,7 +184,7 @@
    @@ -219,7 +219,7 @@
    allowedTypes: Array<RelationshipType>
    @@ -230,7 +230,7 @@ @@ -241,7 +241,7 @@ @@ -251,7 +251,7 @@
    dataEntity: DataEntityType<TData>
    @@ -262,7 +262,7 @@ @@ -273,7 +273,7 @@
    @@ -291,7 +291,7 @@
    foreignKey: string
    @@ -301,7 +301,7 @@
    getRelationshipData: function
    @@ -338,7 +338,7 @@
    @@ -380,7 +380,7 @@
    @@ -402,7 +402,7 @@
    @@ -440,7 +440,7 @@
    @@ -487,7 +487,7 @@
    @@ -556,7 +556,7 @@
    @@ -609,7 +609,7 @@
    @@ -667,7 +667,7 @@
    @@ -685,7 +685,7 @@ @@ -695,7 +695,7 @@
    sourceEntity: DataEntityType<TSource>
    @@ -706,7 +706,7 @@
    diff --git a/docs/interfaces/entityrelationshiprepositorytype.html b/docs/interfaces/entityrelationshiprepositorytype.html index c8b3d36..39aa7f0 100644 --- a/docs/interfaces/entityrelationshiprepositorytype.html +++ b/docs/interfaces/entityrelationshiprepositorytype.html @@ -113,7 +113,7 @@ @@ -124,7 +124,7 @@ @@ -135,7 +135,7 @@ @@ -146,7 +146,7 @@ diff --git a/docs/interfaces/field.html b/docs/interfaces/field.html index e3f1f01..8e50ce0 100644 --- a/docs/interfaces/field.html +++ b/docs/interfaces/field.html @@ -110,7 +110,7 @@
    @@ -136,7 +136,7 @@ addresses: Array<Address>
    @@ -201,7 +201,7 @@ date: Date;
    @@ -216,7 +216,7 @@ date: Date; @@ -227,7 +227,7 @@ date: Date;
    @@ -242,7 +242,7 @@ date: Date;
    isArray: boolean
    @@ -253,7 +253,7 @@ date: Date;
    @@ -269,7 +269,7 @@ date: Date;
    @@ -341,7 +341,7 @@ formatFlavor: Array<NotificationFormat>
    @@ -371,7 +371,7 @@ zip:string;
    @@ -393,7 +393,7 @@ zip:string;
    @@ -409,7 +409,7 @@ zip:string;
    type: Function
    diff --git a/docs/interfaces/fieldconfig.html b/docs/interfaces/fieldconfig.html index 2cd142e..3e37697 100644 --- a/docs/interfaces/fieldconfig.html +++ b/docs/interfaces/fieldconfig.html @@ -113,7 +113,7 @@
    @@ -138,7 +138,7 @@ addresses: Array<Address>
    data: "__self" | string | Array<string>
    @@ -202,7 +202,7 @@ date: Date;
    defaultValue: any
    @@ -217,7 +217,7 @@ date: Date;
    id: string
    @@ -232,7 +232,7 @@ date: Date;
    name: string
    @@ -247,7 +247,7 @@ date: Date;
    parse: function
    @@ -318,7 +318,7 @@ formatFlavor: Array<NotificationFormat>
    require: function | string
    @@ -347,7 +347,7 @@ zip:string;
    required: boolean
    @@ -368,7 +368,7 @@ zip:string;
    serialize: false | function
    diff --git a/docs/interfaces/httpoptions.html b/docs/interfaces/httpoptions.html index 41141df..f2476f0 100644 --- a/docs/interfaces/httpoptions.html +++ b/docs/interfaces/httpoptions.html @@ -107,7 +107,7 @@
    data: T
    @@ -117,7 +117,7 @@
    params: U
    @@ -127,7 +127,7 @@
    separateArrayParams: boolean
    @@ -137,7 +137,7 @@
    timeout: number
    diff --git a/docs/interfaces/ientityconfigbase.html b/docs/interfaces/ientityconfigbase.html index bdae080..763b200 100644 --- a/docs/interfaces/ientityconfigbase.html +++ b/docs/interfaces/ientityconfigbase.html @@ -126,7 +126,7 @@
    entityConstructor: DataEntityConstructor<TEntity, TRawData, TId>
    @@ -136,7 +136,7 @@
    getDefaultValue: function
    @@ -161,7 +161,7 @@
    getValueById: function
    @@ -192,7 +192,7 @@
    hasValue: function
    @@ -234,7 +234,7 @@
    idProperty: keyof TRawData
    @@ -249,7 +249,7 @@
    parseSaveItemsQuery: function
    @@ -289,7 +289,7 @@
    pluralName: string
    @@ -305,7 +305,7 @@
    readonly: boolean
    @@ -326,7 +326,7 @@
    serializeItem: function
    @@ -369,7 +369,7 @@
    singularName: string
    @@ -385,7 +385,7 @@
    supportedEntityGetMethods: Array<EntityGetMethod>
    @@ -395,7 +395,7 @@
    values: Array<TEntity>
    diff --git a/docs/interfaces/ientityrelationshiprepositorytype.html b/docs/interfaces/ientityrelationshiprepositorytype.html index a8c5343..0c45822 100644 --- a/docs/interfaces/ientityrelationshiprepositorytype.html +++ b/docs/interfaces/ientityrelationshiprepositorytype.html @@ -112,7 +112,7 @@
    allowedTypes: Array<RelationshipType>
    @@ -122,7 +122,7 @@
    dataEntityType: DataEntityType<TData>
    @@ -132,7 +132,7 @@
    relationshipConfig: EntityRelationshipConfig<TSource, TData>
    @@ -142,7 +142,7 @@
    sourceEntityType: DataEntityType<TSource>
    diff --git a/docs/interfaces/ireadonlyrepository.html b/docs/interfaces/ireadonlyrepository.html index d220604..5528f1a 100644 --- a/docs/interfaces/ireadonlyrepository.html +++ b/docs/interfaces/ireadonlyrepository.html @@ -125,7 +125,7 @@
    allItems$: Observable<Array<T>>
    @@ -135,7 +135,7 @@
    createItem: function
    @@ -166,7 +166,7 @@
    createNewItem: function
    @@ -191,7 +191,7 @@
    endpointName: string
    @@ -201,7 +201,7 @@ @@ -211,7 +211,7 @@
    getEndpointUrl: function
    @@ -242,7 +242,7 @@
    getItemById: function
    @@ -284,7 +284,7 @@
    query: function
    @@ -315,7 +315,7 @@
    serializeItem: function
    diff --git a/docs/interfaces/irelationshiprepository.html b/docs/interfaces/irelationshiprepository.html index 30e2379..766e508 100644 --- a/docs/interfaces/irelationshiprepository.html +++ b/docs/interfaces/irelationshiprepository.html @@ -130,7 +130,7 @@ @@ -140,7 +140,7 @@
    allowedTypes: Set<RelationshipType>
    @@ -151,7 +151,7 @@
    @@ -183,7 +183,7 @@
    @@ -208,7 +208,7 @@
    dataEntityType: DataEntityType
    @@ -219,7 +219,7 @@ @@ -230,7 +230,7 @@ @@ -241,7 +241,7 @@
    @@ -273,7 +273,7 @@
    @@ -315,7 +315,7 @@
    getRelatedItem: function
    @@ -353,7 +353,7 @@
    @@ -384,7 +384,7 @@
    queryForItem: function
    @@ -421,7 +421,7 @@
    relationshipConfig: EntityRelationshipConfig<TSource, TData>
    @@ -432,7 +432,7 @@
    @@ -466,7 +466,7 @@
    sourceEntityType: DataEntityType
    diff --git a/docs/interfaces/irepository.html b/docs/interfaces/irepository.html index abe4355..4d92fa9 100644 --- a/docs/interfaces/irepository.html +++ b/docs/interfaces/irepository.html @@ -122,7 +122,7 @@ @@ -133,7 +133,7 @@
    @@ -165,7 +165,7 @@
    @@ -191,7 +191,7 @@ @@ -202,7 +202,7 @@ @@ -213,7 +213,7 @@
    @@ -245,7 +245,7 @@
    @@ -288,7 +288,7 @@
    @@ -319,7 +319,7 @@
    save: function
    @@ -351,7 +351,7 @@
    diff --git a/docs/interfaces/modelconfig.html b/docs/interfaces/modelconfig.html index 3f6dda8..423d7ec 100644 --- a/docs/interfaces/modelconfig.html +++ b/docs/interfaces/modelconfig.html @@ -133,7 +133,7 @@ @@ -143,7 +143,7 @@
    fields: EntityFields
    @@ -153,7 +153,7 @@
    fieldsArray: Array<Field>
    @@ -164,7 +164,7 @@
    @@ -190,7 +190,7 @@
    @@ -222,7 +222,7 @@
    @@ -265,7 +265,7 @@
    @@ -281,7 +281,7 @@
    @@ -322,7 +322,7 @@
    @@ -339,7 +339,7 @@
    @@ -361,7 +361,7 @@
    @@ -405,7 +405,7 @@
    @@ -422,7 +422,7 @@ @@ -433,7 +433,7 @@
    diff --git a/docs/interfaces/modelentitycacheconfig.html b/docs/interfaces/modelentitycacheconfig.html index 4cfaf2d..19e9f83 100644 --- a/docs/interfaces/modelentitycacheconfig.html +++ b/docs/interfaces/modelentitycacheconfig.html @@ -102,7 +102,7 @@
    max: number
    @@ -112,7 +112,7 @@
    time: function | number
    diff --git a/docs/interfaces/parisconfig.html b/docs/interfaces/parisconfig.html index b375f20..4c60200 100644 --- a/docs/interfaces/parisconfig.html +++ b/docs/interfaces/parisconfig.html @@ -97,7 +97,7 @@
    allItemsProperty: string
    @@ -107,7 +107,7 @@
    apiRoot: string
    @@ -117,7 +117,7 @@
    data: any
    @@ -127,7 +127,7 @@
    entityIdProperty: string
    @@ -137,7 +137,7 @@
    http: AjaxRequest
    diff --git a/docs/interfaces/removeentitiesevent.html b/docs/interfaces/removeentitiesevent.html index 24fdaff..af85df5 100644 --- a/docs/interfaces/removeentitiesevent.html +++ b/docs/interfaces/removeentitiesevent.html @@ -100,7 +100,7 @@ @@ -110,7 +110,7 @@
    items: Array<any>
    diff --git a/docs/interfaces/saveentityevent.html b/docs/interfaces/saveentityevent.html index 9dcfb84..49b7639 100644 --- a/docs/interfaces/saveentityevent.html +++ b/docs/interfaces/saveentityevent.html @@ -102,7 +102,7 @@ @@ -112,7 +112,7 @@
    isNew: boolean
    @@ -122,7 +122,7 @@
    newValue: any
    @@ -132,7 +132,7 @@
    previousValue: any
    diff --git a/docs/interfaces/saveitems.html b/docs/interfaces/saveitems.html index 9420b6f..43c4c8b 100644 --- a/docs/interfaces/saveitems.html +++ b/docs/interfaces/saveitems.html @@ -94,7 +94,7 @@
    items: Array<any>
    @@ -104,7 +104,7 @@
    method: "POST" | "PUT"