Skip to content
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

Fix type of navigate method #39169

Merged
merged 5 commits into from
Dec 17, 2024
Merged

Fix type of navigate method #39169

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f02e24a
Fixes type of navigate method
pajosieg Nov 26, 2024
bfb47bd
Replace interface and define parameter overloading inline;
pajosieg Nov 27, 2024
a5c3ee8
Merge branch 'master' into topics/fix-gatsby-link-navigate-type
serhalp Dec 16, 2024
4809265
Merge branch 'master' into topics/fix-gatsby-link-navigate-type
serhalp Dec 16, 2024
7b54d2e
Merge branch 'master' into topics/fix-gatsby-link-navigate-type
serhalp Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/gatsby-link/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from "react"
import { NavigateFn, LinkProps } from "@reach/router" // These come from `@types/reach__router`
import { NavigateOptions, LinkProps } from "@reach/router" // These come from `@types/reach__router`

// eslint-disable-next-line @typescript-eslint/naming-convention
export interface GatsbyLinkProps<TState> extends LinkProps<TState> {
Expand Down Expand Up @@ -33,7 +33,10 @@ export class Link<TState> extends React.Component<
* Sometimes you need to navigate to pages programmatically, such as during form submissions. In these
* cases, `Link` won’t work.
*/
export const navigate: (...args: Parameters<NavigateFn>) => void;
export const navigate: {
(to: string, options?: NavigateOptions<{}>): void
(to: number): void
}
Comment on lines -36 to +39
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ref: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/3fe735cfa0d0d25922b71d02ac748a96ea3d67a8/types/reach__router/index.d.ts#L103-L106

👍🏼 Looks right


/**
* It is common to host sites in a sub-directory of a site. Gatsby lets you set the path prefix for your site.
Expand Down