Skip to content

Type predicate missing on isOrderedSet function type declaration #1947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
andyk opened this issue Aug 1, 2023 · 0 comments · Fixed by #1948
Closed

Type predicate missing on isOrderedSet function type declaration #1947

andyk opened this issue Aug 1, 2023 · 0 comments · Fixed by #1948
Labels
typescript

Comments

@andyk
Copy link

andyk commented Aug 1, 2023 •
edited
Loading

What happened

The type definition for the type guard function isOrderedSet inside is missing the is OrderedSet<unknown> type predicate here inside the namespace OrderedSet

immutable-js/type-definitions/immutable.d.ts

Line 1916 in a4eaaf0

function isOrderedSet(maybeOrderedSet: unknown): boolean;

The type predicated exists on the ValueObject definition of the function, as you can see here:

immutable-js/type-definitions/immutable.d.ts

Lines 5435 to 5438 in a4eaaf0

function isOrderedSet(
maybeOrderedSet: unknown
): maybeOrderedSet is OrderedSet<unknown>;

Seems like a small oversight and quick fix?

I checked that other guards do have the type predicate in both declarations, e.g. OrderedMap:

immutable-js/type-definitions/immutable.d.ts

Lines 1514 to 1516 in a4eaaf0

function isOrderedMap(
maybeOrderedMap: unknown
): maybeOrderedMap is OrderedMap<unknown, unknown>;

immutable-js/type-definitions/immutable.d.ts

Lines 5416 to 5419 in a4eaaf0

function isOrderedMap(
maybeOrderedMap: unknown
): maybeOrderedMap is OrderedMap<unknown, unknown>;

How to reproduce
@andyk andyk changed the title Type predicate missing on isOrderedSet function declaration Type predicate missing on isOrderedSet function type declaration Aug 1, 2023
@jdeniau jdeniau mentioned this issue Aug 1, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
typescript
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix isOrderedSet type immutable-js/immutable-js
2 participants
@andyk @jdeniau