implab/implabjs-dojo-typings Commit - r20:1c7650c17856

added type parameter to dojo.store.api.SortInformation,...

cin -

r20:1c7650c17856 v1.0.8 default

parent child

Context file:

r20:1c7650c17856

Collapse all files

dojo-typings/src/main/typings/dijit/form.d.ts +10 -10

                      /* dijit/form/_AutoCompleterMixin */
                      /* tslint:disable:class-name */
-                     interface _AutoCompleterMixin<T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions = dojo.store.api.QueryOptions> extends _SearchMixin<T, Q, O> {
+                     interface _AutoCompleterMixin<T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions<T> = dojo.store.api.QueryOptions<T>> extends _SearchMixin<T, Q, O> {
                          /**
                           * This is the item returned by the dojo/store/api/Store implementation that
                           * provides the data for this ComboBox, it's the currently selected item.
                          /**
                           * Fills in the items in the drop down list
                           */
-                         createOptions(results: T[], options: dojo.store.api.QueryOptions, labelFunc: (item: T) => { html: boolean; label: string; }): void;
+                         createOptions(results: T[], options: dojo.store.api.QueryOptions<T>, labelFunc: (item: T) => { html: boolean; label: string; }): void;
                          /**
                           * Clears the entries in the drop down list, but of course keeps the previous and next buttons.
                          disabled?: boolean;
                      }
-                     interface _FormSelectWidget<T extends Object, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions = dojo.store.api.QueryOptions> extends _FormValueWidget {
+                     interface _FormSelectWidget<T extends Object, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions<T> = dojo.store.api.QueryOptions<T>> extends _FormValueWidget {
                          /**
                           * Whether or not we are multi-valued
                           */
                      /* dijit/form/_SearchMixin */
-                     interface _SearchMixin<T extends Object, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions = dojo.store.api.QueryOptions> {
+                     interface _SearchMixin<T extends Object, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions<T> = dojo.store.api.QueryOptions<T>> {
                          /**
                           * Argument to data provider.
                           * Specifies maximum number of search results to return per query
                      /* dijit/form/ComboBox */
-                     interface ComboBox<T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions = dojo.store.api.QueryOptions, C extends Constraints = Constraints> extends ValidationTextBox<C>, ComboBoxMixin<T, Q, O> {
+                     interface ComboBox<T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions<T> = dojo.store.api.QueryOptions<T>, C extends Constraints = Constraints> extends ValidationTextBox<C>, ComboBoxMixin<T, Q, O> {
                          // set(name: string, value: any): this;
                          // set(values: Object): this;
                      }
                      interface ComboBoxConstructor extends _WidgetBaseConstructor<ComboBox<any>> {
-                         new <T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions = dojo.store.api.QueryOptions, C extends Constraints = Constraints>(params: Object, srcNodeRef: dojo.NodeOrString): ComboBox<T, Q, O, C>;
+                         new <T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions<T> = dojo.store.api.QueryOptions<T>, C extends Constraints = Constraints>(params: Object, srcNodeRef: dojo.NodeOrString): ComboBox<T, Q, O, C>;
                      }
                      /* dijit/form/ComboBoxMixin */
-                     interface ComboBoxMixin<T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions = dojo.store.api.QueryOptions> extends _HasDropDown<_ComboBoxMenu<T>>, _AutoCompleterMixin<T, Q, O> {
+                     interface ComboBoxMixin<T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions<T> = dojo.store.api.QueryOptions<T>> extends _HasDropDown<_ComboBoxMenu<T>>, _AutoCompleterMixin<T, Q, O> {
                          /**
                           * Dropdown widget class used to select a date/time.
                      /* dijit/form/FilteringSelect */
-                     interface FilteringSelect<C extends Constraints, T extends Object, Q extends string | Object | Function, O extends dojo.store.api.QueryOptions> extends MappedTextBox<C>, ComboBoxMixin<T, Q, O> {
+                     interface FilteringSelect<C extends Constraints, T extends Object, Q extends string | Object | Function, O extends dojo.store.api.QueryOptions<T>> extends MappedTextBox<C>, ComboBoxMixin<T, Q, O> {
                          /**
                           * True (default) if user is required to enter a value into this field.
                           */
                      }
                      interface FilteringSelectConstructor extends _WidgetBaseConstructor<FilteringSelect<any, any, any, any>> {
-                         new <C extends Constraints, T extends Object, Q extends string | Object | Function, O extends dojo.store.api.QueryOptions>(params: Object, srcNodeRef: dojo.NodeOrString): FilteringSelect<C, T, Q, O>;
+                         new <C extends Constraints, T extends Object, Q extends string | Object | Function, O extends dojo.store.api.QueryOptions<T>>(params: Object, srcNodeRef: dojo.NodeOrString): FilteringSelect<C, T, Q, O>;
                      }
                      /* dijit/form/Form */
                      /* dijit/form/Select */
-                     interface Select<T extends Object, Q extends dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions, U extends dijit._WidgetBase> extends _FormSelectWidget<T, Q, O>, _HasDropDown<U>, _KeyNavMixin {
+                     interface Select<T extends Object, Q extends dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions<T>, U extends dijit._WidgetBase> extends _FormSelectWidget<T, Q, O>, _HasDropDown<U>, _KeyNavMixin {
                          baseClass: string;
                          /**

dojo-typings/src/main/typings/dijit/modules.d.ts +1 -1

              }
              declare module 'dijit/form/FilteringSelect' {
-             	type FilteringSelect<C extends dijit.form.Constraints = dijit.form.Constraints, T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions = dojo.store.api.QueryOptions> = dijit.form.FilteringSelect<C, T, Q, O>;
+             	type FilteringSelect<C extends dijit.form.Constraints = dijit.form.Constraints, T extends Object = any, Q extends dojo.store.api.BaseQueryType = dojo.store.api.BaseQueryType, O extends dojo.store.api.QueryOptions<T> = dojo.store.api.QueryOptions<T>> = dijit.form.FilteringSelect<C, T, Q, O>;
              	const FilteringSelect: dijit.form.FilteringSelectConstructor;
              	export = FilteringSelect;
              }

dojo-typings/src/main/typings/dojo/store.d.ts +19 -17

              			/* dojo/store/api/Store */
-             			interface SortInformation {
+             			interface SortInformation<K extends string | number | symbol = string> {
              				/**
              				 * The name of the attribute to sort on.
              				 */
-             				attribute: string;
+             				attribute: K;
              				/**
              				 * The direction of the sort.  Default is false.
              				descending?: boolean;
              			}
-             			interface QueryOptions {
+                         type SortFn<T> = (left: T, right: T) => number;
+             			interface QueryOptions<T = unknown> {
              				/**
              				 * A list of attributes to sort on, as well as direction
              				 * For example:
              				 * If the sort parameter is omitted, then the natural order of the store may be
              				 * applied if there is a natural order.
              				 */
-             				sort?: SortInformation[];
+             				sort?: SortFn<T> | SortInformation<keyof T>[];
              				/**
              				 * The first result to begin iteration on
              			type BaseQueryType = string | object | ((...params: unknown[]) => boolean);
              			interface QueryEngine<T extends object, Q extends BaseQueryType> {
-             				<O extends QueryOptions>(query: Q, options?: O): QueryEngineFunction<T>;
+             				<O extends QueryOptions<T>>(query: Q, options?: O): QueryEngineFunction<T>;
              			}
              			interface PutDirectives<T extends object> {
              			interface Queryable<
              				T extends object,
              				Q extends BaseQueryType,
-             				O extends QueryOptions,
+             				O extends QueryOptions<T>,
              				R extends QueryResults<T> = QueryResults<T>> {
              				/**
              				query(query?: Q, options?: O): R;
              			}
-             			interface SyncStore<T extends object, Q extends BaseQueryType = Partial<T> | ((item: T) => boolean) | string, O extends QueryOptions = QueryOptions>
+             			interface SyncStore<T extends object, Q extends BaseQueryType = Partial<T> | ((item: T) => boolean) | string, O extends QueryOptions<T> = QueryOptions<T>>
              				extends IdentityProvider<T>, Queryable<T, Q, O, SyncQueryResults<T>> {
              				/**
              			}
-             			interface AsyncStore<T extends object, Q extends BaseQueryType = Partial<T> | ((item: T) => boolean) | string, O extends QueryOptions = QueryOptions>
+             			interface AsyncStore<T extends object, Q extends BaseQueryType = Partial<T> | ((item: T) => boolean) | string, O extends QueryOptions<T> = QueryOptions<T>>
              				extends IdentityProvider<T>, Queryable<T, Q, O, AsyncQueryResults<T>> {
              				/**
              			}
-             			interface HierarchicalStore<T extends object, O extends QueryOptions = QueryOptions, R extends QueryResults<T> = QueryResults<T>> {
+             			interface HierarchicalStore<T extends object, O extends QueryOptions<T> = QueryOptions<T>, R extends QueryResults<T> = QueryResults<T>> {
              				/**
              				 * Retrieves the children of an object.
              				getChildren(parent: T, options?: O): R;
              			}
-             			interface Store<T extends object, Q extends BaseQueryType = Partial<T> | ((item: T) => boolean) | string, O extends QueryOptions = QueryOptions>
+             			interface Store<T extends object, Q extends BaseQueryType = Partial<T> | ((item: T) => boolean) | string, O extends QueryOptions<T> = QueryOptions<T>>
              				extends IdentityProvider<T>, Queryable<T, Q, O> {
              				/**
              		interface DataStoreOptions<T extends object> {
              			idProperty?: keyof T;
-             			queryEngine?: api.QueryEngine<T, api.QueryOptions>;
+             			queryEngine?: api.QueryEngine<T, api.QueryOptions<T>>;
              			store?: data.api.Read<T> | data.api.Write<T> | data.api.Identity<T>;
              		}
-             		interface DataStore<T extends object> extends api.Store<T, api.BaseQueryType, api.QueryOptions>  {
+             		interface DataStore<T extends object> extends api.Store<T, api.BaseQueryType, api.QueryOptions<T>>  {
              			/**
              			 * The object store to convert to a data store
              			 */
              			timeout?: number
              		}
-             		interface JsonRestQueryOptions extends api.QueryOptions {
+             		interface JsonRestQueryOptions<T = unknown> extends api.QueryOptions<T> {
              			headers?: Headers;
              			timeout?: number;
              		interface JsonRestOptions<T extends object> {
              			idProperty?: keyof T;
-             			queryEngine?: api.QueryEngine<T, JsonRestQueryOptions>;
+             			queryEngine?: api.QueryEngine<T, JsonRestQueryOptions<T>>;
              			headers?: Headers;
              			target?: string;
              			rangeParam?: string;
              		interface JsonRest<
              			T extends object,
              			Q extends api.BaseQueryType = (Partial<T> | string) & api.BaseQueryType,
-             			O extends JsonRestQueryOptions = JsonRestQueryOptions>
+             			O extends JsonRestQueryOptions<T> = JsonRestQueryOptions<T>>
              			extends api.AsyncStore<T, Q, O> {
              			/**
              			 * Additional headers to pass in all requests to the server. These can be overridden
              		interface MemoryOptions<T extends object> {
              			data?: T[];
              			idProperty?: keyof T;
-             			queryEngine?: api.QueryEngine<T, api.QueryOptions>;
+             			queryEngine?: api.QueryEngine<T, api.QueryOptions<T>>;
              			setData?: (data: T[]) => void;
              		}
                      type ObservableQueryResults<T extends object> = ObservableQueryResultsMixin<T> & api.QueryResults<T>;
-             		interface ObservableMixin<T extends object, Q extends api.BaseQueryType, O extends api.QueryOptions, R extends api.QueryResults<T> = api.QueryResults<T> > {
+             		interface ObservableMixin<T extends object, Q extends api.BaseQueryType, O extends api.QueryOptions<T>, R extends api.QueryResults<T> = api.QueryResults<T> > {
              			notify(object: T, existingId?: api.Identity): void;
              			/**

dojo-typings/src/test/ts/StoreTests.ts +2 -1

              observable.query().observe(() => { });
              store.query().forEach(() => { });
              const total = await store.query().total;
-             const result = await store.query();
+             const res1 = await store.query(undefined, { sort: [{ attribute: "duration", descending: true }] });
+             const res2 = await store.query(undefined, { sort: ({ duration: a }, { duration: b }) => a - b });
              mem.query();

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages