refine icon indicating copy to clipboard operation
refine copied to clipboard

fix(docs): Changed type of options in translate function of i18nProvider

Open bzhn opened this issue 1 year ago • 2 comments

Example with options: any gives me the following error:

Type '(key: string, options?: any) => string | TFunctionDetailedResult<string, any>' is not assignable to type 'TranslateFunction'.
  Type 'string | TFunctionDetailedResult<string, any>' is not assignable to type 'string'.
    Type 'TFunctionDetailedResult<string, any>' is not assignable to type 'string'.ts(2322)

I found solution in a following file that fixes the error:

https://github.com/Fgruntjes/WFK-Finance/blob/7b6c817b913f89db6197c705d34e260aaf7ed726/frontend/src/i18n-provider/useI18nProvider.ts#L5

PR Checklist

Please check if your PR fulfills the following requirements:

  • [x] The commit message follows our guidelines: https://refine.dev/docs/guides-concepts/contributing/#commit-convention

Bugs / Features

  • [ ] Related issue(s) linked
  • [ ] Tests for the changes have been added
  • [x] Docs have been added / updated
  • [ ] Changesets have been added https://refine.dev/docs/guides-concepts/contributing/#creating-a-changeset

What is the current behavior?

What is the new behavior?

fixes # (issue)

Notes for reviewers

I'm following the guide at the page and getting error. The error is fixed when I change options?: any to options?: $Dictionary<unknown>.

The screenshot of an error:

image

bzhn avatar Apr 19 '24 14:04 bzhn

⚠️ No Changeset found

Latest commit: 5bb5e873f6ebf1bf578a1f17539b1540f765c385

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Apr 19 '24 14:04 changeset-bot[bot]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5bb5e873f6ebf1bf578a1f17539b1540f765c385. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

nx-cloud[bot] avatar Apr 19 '24 14:04 nx-cloud[bot]