typescript - type checking route params when some params are required while other are optional
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 38/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- react-native, typescript
- Área
- documentation
Línea de trabajo
Revisa la página de TypeScript sobre la comprobación de tipos del navegador enlazada en el issue, incluidos sus ejemplos de RootStackParamList y el comportamiento de setParams descrito por el informante. Aclara cómo representar rutas con parámetros obligatorios y opcionales, y actualiza el ejemplo o la explicación correspondiente para que las llamadas de navegación documentadas coincidan con los tipos compatibles.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
regarding: https://reactnavigation.org/docs/typescript/#type-checking-the-navigator
it says:
Specifying undefined means that the route doesn't have params. A union type with undefined (e.g. SomeType | undefined) means that params are optional.
here it says SomeType | undefined, where it looks like its referring to a single param. but "params" is plural and seems to refer to all the route params.
however, in the above example it shows:
type RootStackParamList = {
Home: undefined;
Profile: { userId: string };
Feed: { sort: 'latest' | 'top' } | undefined;
};
this example shows that either a route takes no params, takes 1 required param or 1 optional param. but what if a route takes both required and optional params? in this case i cannot type the entire param object to be undefined
so something like this:
type RootStackParamList = {
SomeRoute: {
param1: string,
param2: string | undefined,
}
};
i tried this, however it still shows errors when not passing the optional params. so this code:
navigation.navigate('SomeRoute', {
param1: 'some string'
});
shows this error:
Argument of type '{ param1: string; }' is not assignable to parameter of type '{ param2: string | undefined; param1: string; }'.
Property 'param2' is missing in type '{ param1: string; }' but required in type '{ param2: string | undefined; param1: string; }'.ts(2345)
in my case, im setting param2 in SomeRoute with useLayoutEffect with setParams(), so i need to type it or else that shows in error.
Type '{ param2: any; }' is not assignable to type 'Partial<Readonly<{ param1: string; }>>'.
Object literal may only specify known properties, and 'param2' does not exist in type 'Partial<Readonly<{ param1: string; }>>'.ts(2322)
this error disappears when typing it like i did. but i still get the other error.
i have also tried setting the types as optional with a question mark. but this also shows an error if the screen takes no other params.
so this no longer shows an error:
type RootStackParamList = {
SomeRoute: {
param1: string;
param2?: string | undefined,
}
};
navigation.navigate('SomeRoute', {
param1: 'some string,
});
but this does:
type RootStackParamList = {
SomeRoute: {
param2?: string | undefined,
}
};
navigation.navigate('SomeRoute');
is it possible to define route params like this? where some are required while others are optional, not just the while params object?
- Lenguaje dominante
- JavaScript
- Estrellas
- 324
- Forks
- 2k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de react-navigation/react-navigation.github.io
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 94/100
react-navigation/react-navigation.github.io#1516 · 1 comentario ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Todos los issues de react-navigation/react-navigation.github.io
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
palladius/rails8-app-on-gcp#145 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
dotenvx/dotenv-vscode#139 ·
-
test-change-proposal
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
web-platform-tests/interop#1455 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
corsairdev/corsair#1764 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100