ag-admin/OpenSlides
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update datastore-service.txt

Browse Source
This commit is contained in:
jsangmeister 2020-04-08 11:20:55 +02:00 committed by GitHub
parent 952355ab94
commit d3b9404efd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/interfaces/datastore-service.txt
View File

@ -165,7 +165,7 @@ get(fqid: Fqid, mapped_fields?: Field[], position?: Position, get_deleted_models
*
* @throws InvalidFormat
*/
getMany(requests: GetManyRequest[], mapped_fields?: Field[], position?: Position, get_deleted_models?: DeletedModelsBehaviour): Partial<Model>[];
getMany(requests: GetManyRequest[], mapped_fields?: Field[], position?: Position, get_deleted_models?: DeletedModelsBehaviour): Map<Fqid, Partial<Model>>;
Interface GetManyRequest {
collection: Collection;
@ -208,18 +208,19 @@ count(collection: Collection, filter: Filter): {count: number; position: Positio
/**
* Executes a min aggregation on all models of one collection on
* the given field that satisfy the filter condition.
* The field is cast to int by default. If aggregation of another field type is needed,
* a valid type can be passed via the type parameter.
*
* @throws InvalidFormat
*/
min(collection: Collection, filter: Filter, field: Field): {min: Value; position: Position;}
min(collection: Collection, filter: Filter, field: Field, type?: string): {min: Value; position: Position;}
/**
* Executes a max aggregation on all models of one collection on
* the given field that satisfy the filter condition.
* Analogous to min.
*
* @throws InvalidFormat
*/
max(collection: Collection, filter: Filter, field: Field): {max: Value; position: Position;}
max(collection: Collection, filter: Filter, field: Field, type?: string): {max: Value; position: Position;}
Type Filter = And | Or | Not | FilterOperator
@ -230,7 +231,7 @@ Type Filter = And | Or | Not | FilterOperator
Interface FilterOperator {
field: Field;
value: Value | null;
operator: '==' | '!=' | '<' | '>' | '>=' | '<=';
operator: '=' | '!=' | '<' | '>' | '>=' | '<=';
}
Interface Not {