Fix the export error #77

andreiglingeanu · 2017-12-15T21:11:15Z

Fixes #76

This will:

properly export update function
make MapAndSetOperators generic

coveralls · 2017-12-15T21:12:22Z

Coverage remained the same at 100.0% when pulling 202320d on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

kolodny · 2017-12-17T00:46:38Z

I'm fine with this PR, but is there any way to include a ts build/check step to npm test so that regressions on the .d.ts file don't come back to bite us?

ghost

This looks better than what's in DefinitelyTyped.
Have you considered using overloading instead of a union of queries? This would prevent you from e.g. using an ArrayOperator on something that's not an array.

declare function update<T>(data: ReadonlyArray<T>, query:  update.ArrayOperator<T>): ReadonlyArray<T>
declare function update<T>(data: ReadonlySet<T>, query: { $add: ReadonlyArray<T> } | { $remove: ReadonlyArray<T> }): ReadonlySet<T>
declare function update<K, V>(data: ReadonlyMap<K, V>, query: { $add: ReadonlyArray<[K, V]> } | { $remove: ReadonlyArray<K> }): ReadonlyMap<K, V>
declare function update<K extends string, T extends { readonly [key in K]: boolean }>(data: T, query: { $toggle: ReadonlyArray<K> }): T;
...etc...

...although I can't figure out how you would strongly-type nested queries without conditional types (microsoft/TypeScript#12424).

If you're interested in testing, dtslint can be run outside of DefinitelyTyped. (But make sure to remove the // Type definitions for immutability-helper header or it will think you're on DefinitelyTyped.)

ghost · 2017-12-20T19:57:01Z

index.d.ts

+// Type definitions for immutability-helper
+// Project: Immutability helper
+
+export default update


In the source code this is module.exports =, so it should be declared as export =.
See https://github.com/DefinitelyTyped/DefinitelyTyped#a-package-uses-export--but-i-prefer-to-use-default-imports-can-i-change-export--to-export-default

Cool, thanks

andreiglingeanu · 2017-12-20T21:31:15Z

Oh, thanks. I'll get over everything a covert it into a commit soon.

And yes, I have seen microsoft/TypeScript#12424 while researching a way to provide stronger types for the lib. I believe overloading is way better than having unions, thanks for that. But yeah, without conditional types we are indeed loosing some information about the generic type <T>.

andreiglingeanu · 2017-12-31T14:57:59Z

Hey @kolodny, now you can run npm run test-dtslint in order to verify the validity of the types, sorry for not getting them correct from the first pass

@andy-ms could you please see if typings are in a better shape now?

coveralls · 2017-12-31T14:58:41Z

Coverage remained the same at 100.0% when pulling af16399 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

coveralls · 2017-12-31T14:58:41Z

Coverage remained the same at 100.0% when pulling af16399 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

coveralls · 2017-12-31T14:58:41Z

Coverage remained the same at 100.0% when pulling af16399 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

ghost · 2018-01-02T16:01:20Z

@andreiglingeanu It looks good, but it doesn't seem like it will allow you to push to an array that's nested as a property? You would have to include $push in the Query type for that to work.

andreiglingeanu · 2018-01-03T11:46:24Z

Oh, my bad! For some kind of a reason I thought the array would be only on the first level.

I'll fix the typings, thanks.

andreiglingeanu · 2018-01-03T12:06:24Z

@andy-ms pushed the change. Now arrays, Map & Sets can be nested into objects. Does that look okay?

coveralls · 2018-01-03T12:08:31Z

Coverage remained the same at 100.0% when pulling 77b8957 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

coveralls · 2018-01-03T12:08:31Z

Coverage remained the same at 100.0% when pulling 77b8957 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

coveralls · 2018-01-03T12:08:31Z

Coverage remained the same at 100.0% when pulling 77b8957 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

coveralls · 2018-01-03T12:08:31Z

Coverage remained the same at 100.0% when pulling 77b8957 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

ghost · 2018-01-03T16:38:37Z

index.d.ts

+  | {$splice: Array<[number, number]>}
+  | {$splice: Array<[number, number]>}
+
+type MapAndSetOperators<T> = {$add: any[]} | {$remove: string[]}


For a Map, shouldn't this be $remove: K[] and $add: [K, V][]?
Similarly, for a Set you would remove/ add T, not string.

andreiglingeanu · 2018-01-03T19:00:15Z

Yeah, missed that. A strong limitation is that I won't be able to type properly the nested Map in a Query without conditional types, but we should be good for now.

coveralls · 2018-01-03T19:00:26Z

Coverage remained the same at 100.0% when pulling a0ab40c on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

coveralls · 2018-01-03T19:16:27Z

Coverage remained the same at 100.0% when pulling fe471d4 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

coveralls · 2018-01-03T19:16:27Z

Coverage remained the same at 100.0% when pulling fe471d4 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

ghost · 2018-01-03T19:52:13Z

index.d.ts

+  | Tree<T>
+  | ObjectOperators<T>
+  | ArrayOperators<T>
+  | SetOperators<T>


This would just be ArrayOperators<any> and SetOperators<any> since T here is the type of the object itself, not the type of its elements.

coveralls · 2018-01-03T20:28:57Z

Coverage remained the same at 100.0% when pulling bcd4248 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

ghost

Last comment

ghost · 2018-01-03T20:33:07Z

index.d.ts

+  query: ArrayOperators<T>,
+): ReadonlyArray<T>
+
+declare function update<T>(data: T, query: Query<T>): object


This should be the last overload so that the ReadonlySet and ReadonlyMap ones are tried first.

ghost · 2018-01-03T20:33:46Z

index.d.ts

+  | {$toggle: Array<keyof T>}
+  | {$unset: Array<keyof T>}
+  | {$merge: Partial<T>}
+  | {$apply: (old: T) => any}


Should this be => T?

andreiglingeanu · 2018-01-03T21:41:57Z

@andy-ms Thanks, learned a lot :)

coveralls · 2018-01-03T21:43:13Z

Coverage remained the same at 100.0% when pulling bbf0b56 on andreiglingeanu:patch-1 into 486a7e0 on kolodny:master.

kolodny · 2018-01-08T04:25:04Z

Awesome! Thanks for this. I'm going to add tslint to the build process so that it runs on travis. Are there any administrative steps to take after making a release, for example should there be a PR to remove immutability-helper from DefinitelyTyped

kolodny · 2018-01-08T04:26:18Z

Also I imagine that #79 can be closed, is that correct?

andreiglingeanu · 2018-01-08T10:50:19Z

Awesome!

@kolodny after we PR DefinitelyType yes, #79 can be closed

kolodny · 2018-01-08T15:23:17Z

Great, published to v2.6.3

Fix the export error

202320d

andreiglingeanu mentioned this pull request Dec 20, 2017

"typings" set in package.json, but no typings included #79

Closed

ghost reviewed Dec 20, 2017

View reviewed changes

refactor($typings): improve typescript types

af16399

feat($typings): allow Map, Set & Array to be nested in objects

77b8957

ghost reviewed Jan 3, 2018

View reviewed changes

andreiglingeanu added 2 commits January 3, 2018 20:56

feat($typings): split MapAndSet into Map & Set

fe471d4

feat($typings): remove repeated command

a0ab40c

ghost reviewed Jan 3, 2018

View reviewed changes

feat($typings): T -> any

bcd4248

ghost approved these changes Jan 3, 2018

View reviewed changes

feat($typings): overloading order & $apply return type

bbf0b56

kolodny merged commit 792f5ef into kolodny:master Jan 8, 2018

andreiglingeanu mentioned this pull request Jan 8, 2018

get rid of the immutability-helper types DefinitelyTyped/DefinitelyTyped#22763

Merged

8 tasks

dannysellers mentioned this pull request Jul 24, 2018

Case details | Assign to attorneys department-of-veterans-affairs/caseflow#6295

Merged

22 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix the export error #77

Fix the export error #77

andreiglingeanu commented Dec 15, 2017 •

edited

Loading

coveralls commented Dec 15, 2017 •

edited

Loading

kolodny commented Dec 17, 2017

ghost left a comment •

edited by ghost

Loading

ghost Dec 20, 2017

andreiglingeanu Dec 20, 2017 •

edited

Loading

andreiglingeanu commented Dec 20, 2017 •

edited

Loading

andreiglingeanu commented Dec 31, 2017 •

edited

Loading

coveralls commented Dec 31, 2017 •

edited

Loading

coveralls commented Dec 31, 2017

coveralls commented Dec 31, 2017

ghost commented Jan 2, 2018

andreiglingeanu commented Jan 3, 2018 •

edited

Loading

andreiglingeanu commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

ghost Jan 3, 2018

andreiglingeanu commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018

ghost Jan 3, 2018

coveralls commented Jan 3, 2018 •

edited

Loading

ghost left a comment

ghost Jan 3, 2018

ghost Jan 3, 2018

andreiglingeanu commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

kolodny commented Jan 8, 2018

kolodny commented Jan 8, 2018

andreiglingeanu commented Jan 8, 2018

kolodny commented Jan 8, 2018

Fix the export error #77

Fix the export error #77

Conversation

andreiglingeanu commented Dec 15, 2017 • edited Loading

coveralls commented Dec 15, 2017 • edited Loading

kolodny commented Dec 17, 2017

ghost left a comment • edited by ghost Loading

Choose a reason for hiding this comment

ghost Dec 20, 2017

Choose a reason for hiding this comment

andreiglingeanu Dec 20, 2017 • edited Loading

Choose a reason for hiding this comment

andreiglingeanu commented Dec 20, 2017 • edited Loading

andreiglingeanu commented Dec 31, 2017 • edited Loading

coveralls commented Dec 31, 2017 • edited Loading

coveralls commented Dec 31, 2017

coveralls commented Dec 31, 2017

ghost commented Jan 2, 2018

andreiglingeanu commented Jan 3, 2018 • edited Loading

andreiglingeanu commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

ghost Jan 3, 2018

Choose a reason for hiding this comment

andreiglingeanu commented Jan 3, 2018 • edited Loading

coveralls commented Jan 3, 2018 • edited Loading

coveralls commented Jan 3, 2018 • edited Loading

coveralls commented Jan 3, 2018

ghost Jan 3, 2018

Choose a reason for hiding this comment

coveralls commented Jan 3, 2018 • edited Loading

ghost left a comment

Choose a reason for hiding this comment

ghost Jan 3, 2018

Choose a reason for hiding this comment

ghost Jan 3, 2018

Choose a reason for hiding this comment

andreiglingeanu commented Jan 3, 2018 • edited Loading

coveralls commented Jan 3, 2018 • edited Loading

kolodny commented Jan 8, 2018

kolodny commented Jan 8, 2018

andreiglingeanu commented Jan 8, 2018

kolodny commented Jan 8, 2018

andreiglingeanu commented Dec 15, 2017 •

edited

Loading

coveralls commented Dec 15, 2017 •

edited

Loading

ghost left a comment •

edited by ghost

Loading

andreiglingeanu Dec 20, 2017 •

edited

Loading

andreiglingeanu commented Dec 20, 2017 •

edited

Loading

andreiglingeanu commented Dec 31, 2017 •

edited

Loading

coveralls commented Dec 31, 2017 •

edited

Loading

andreiglingeanu commented Jan 3, 2018 •

edited

Loading

andreiglingeanu commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

andreiglingeanu commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading