facebookexperimental/Recoil

[Typescript] Use selectorFamily with an interface

Open

#629 opened on Sep 30, 2020

View on GitHub
 (7 comments) (8 reactions) (1 assignee)JavaScript (19,428 stars) (1,151 forks)batch import
TypeScript / Flowhelp wanted

Description

I have a simple interface called Filters

export interface Filters {
  search: string;
}

And I'm trying to use it like with selectorFamily like that: selectorFamily<Patient[], Filters> I'm getting typescript error

Type 'Filters' does not satisfy the constraint 'SerializableParam'. Type 'Filters' is not assignable to type 'Readonly<{ [key: string]: SerializableParam; }>'. Index signature is missing in type 'Filters'.ts(2344)

If I simply extract the interface selectorFamily<Patient[], { search: string }> it works, but I would happy to not do it

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript basicsRecoil state management
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the Recoil type definitions in the repository, specifically the `selectorFamily` function and the `SerializableParam` constraint. Look at how generics are constrained and whether the interface can be made to satisfy the constraint without an index signature. Check existing comments for suggested workarounds or maintainer input on whether this is intended behavior.