fix: #1005 fixed, by updating type-definations to getItem method.

[baraich]

Changes

Updated the getItem function to check if the fallback parameter is provided. If it is, the function will return a non-null type.

[netlify]

✅ Deploy Preview for creative-fairy-df92c4 ready!

Name	Link
🔨 Latest commit	9626fd9
🔍 Latest deploy log	https://app.netlify.com/sites/creative-fairy-df92c4/deploys/66fb6d60d6cc3c0008b8de2d
😎 Deploy Preview	https://deploy-preview-1007--creative-fairy-df92c4.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[Timeraa]

Maybe add a type test into the storage tests for that

[baraich]

@Timeraa I am unsure, what do you mean? I have tested the project locally and after then I created a pull request.

Some cases

const value = await storage.getItem("local:key")
      // ^? any 

const value = await storage.getItem<string>("local:key")
      // ^? string | null 

const value = await storage.getItem("local:key", { fallback: "abc" })
      // ^? string 

const value = await storage.getItem<string>("local:key", { fallback: "abc" })
      // ^? string 

[Timeraa]

Using https://vitest.dev/guide/testing-types in https://github.com/wxt-dev/wxt/blob/main/packages/wxt/src/__tests__/storage.test.ts

I think @aklinker1 needs to add the --typecheck flag to the test commands but you can use vitest --typecheck in the packages/wxt package

[baraich]

Using https://vitest.dev/guide/testing-types in https://github.com/wxt-dev/wxt/blob/main/packages/wxt/src/__tests__/storage.test.ts

I think @aklinker1 needs to add the --typecheck flag to the test commands but you can use vitest --typecheck in the packages/wxt package

@Timeraa Hi, according to your guidance I rank the typecheck command and all the tests in storage.test.ts are passing and I am sure it's safe to merge.

[baraich]

@aklinker1 or @Timeraa, please merge the pull request asap, I am unable to concentrate on my tomorrows' board examination or if you are not planning to merge please provide appropriate feedback.

Thanks in advance.

[baraich]

Also, here is the flow of types.

• When we haven't provided a type hint, or fallback parameter the return type in unknown.
  

• Now, I have given a type hint.
  

• And when I have given fallback, then the following behaviour is expected.
  

• Moreover, it has type-safety built in, if I hint the function that type is number then I cannot pass anything else than number to fallback parameter.
  

[pkg-pr-new]

Open in Stackblitz

@wxt-dev/auto-icons

pnpm add https://pkg.pr.new/@wxt-dev/auto-icons@1007

@wxt-dev/i18n

pnpm add https://pkg.pr.new/@wxt-dev/i18n@1007

@wxt-dev/module-react

pnpm add https://pkg.pr.new/@wxt-dev/module-react@1007

@wxt-dev/module-solid

pnpm add https://pkg.pr.new/@wxt-dev/module-solid@1007

@wxt-dev/module-svelte

pnpm add https://pkg.pr.new/@wxt-dev/module-svelte@1007

@wxt-dev/module-vue

pnpm add https://pkg.pr.new/@wxt-dev/module-vue@1007

wxt

pnpm add https://pkg.pr.new/wxt@1007

commit: 9626fd9

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.87%. Comparing base (a64ff22) to head (9626fd9).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1007      +/-   ##
==========================================
- Coverage   82.14%   81.87%   -0.28%     
==========================================
  Files         127      127              
  Lines        6625     6625              
  Branches     1103     1102       -1     
==========================================
- Hits         5442     5424      -18     
- Misses       1169     1187      +18     
  Partials       14       14              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[aklinker1]

Can you make the PR editable by maintainers? I can't seem to push the type tests.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork

    it('should return a nullable type when getItem is called without a fallback', async () => {
      const res = await storage.getItem<string>('local:test');
      expectTypeOf(res).toBeNullable();
    });

    it('should return a nullable type when getItem is called without a fallback', async () => {
      const res = await storage.getItem<string>('local:test', {
        fallback: 'test',
      });
      expectTypeOf(res).not.toBeNullable();
    });

[baraich]

@aklinker1 Hi, I have allowed edits by maintainers.

[baraich]

@aklinker1 Hi, I think there is some problem with your test code.

[aklinker1]

No, the test code is correct, your change doesn't work when the first type parameter is passed in.

-     const res = await storage.getItem<string>('local:test', {
+     const res = await storage.getItem('local:test', {
        fallback: 'test',
      });

[baraich]

@aklinker1, Yes, you are write, when we pass the type hint and fallback. It defaults to typehint and null condition. Will fix an update. Thanks

[baraich]

@aklinker1 All 16 tests are passing now.

[baraich]

@aklinker1 Why is it should changes required, I have made the changes please review them. Your reviewing part is left. Thanks.

[aklinker1]

Thanks!

[baraich]

Thanks, for approving the changes. As this is my first time contribution to open source, I am not aware of the steps involved. Are there more steps to this, as the pull request doesn't seem as it has been merged (please correct if wrong) even after you have approved.

[aklinker1]

Just had to wait for checks to pass, just getting back to this now!

[aklinker1]

Released in v0.19.11