Feat: Add typescript types for @faker-js/faker

[faker-js]

Feat: Add typescript types for @faker-js/faker

[Shinigami92]

For now please create a file in your repo with content:

// faker.d.ts
declare module '@faker-js/faker' {
  import faker from 'faker';
  export default faker;
}

and then just use the @types/faker

[damienwebdev]

read: weeks.

[micalevisk]

another way is using TS path aliases like:

{
  "compilerOptions": {
    "paths": {
      "faker/*": ["@faker-js/faker/*"],
      "faker": ["@faker-js/faker"]
    }
  }
}

thus you don't need to change anything besides the tsconfig file.

[Shinigami92]

// faker.d.ts
declare module '@faker-js/faker' {
  import faker from 'faker';
  export default faker;
}

It works! I tested this im my own repo at work!
Nothing wrong with them, cause until now we did not change anything according to that.

[Shinigami92]

Oh, really? I spent some time trying to figure out how I can link the faker.d.ts with the @types/faker package. Maybe the README file could be updated to remove the Typescript Support section or there could be a mention of the fact that TS support is available in the latest version.

Already planed 😉
But we decide it to leave as is for now, until v6.0.0 is fully released

[Shinigami92]

Can't this be actually included in the current repo? That way, it'll get fixed when it'll get fixed and we won't have to back out this change from a 10^6 downstream modules.

Happy to submit a PR is that seems like an acceptable band-aid.

This will not work, cause the current versions <=5.5.3 are already released and not touched by us except the package name.
But I already working on TS migration at all #72, but sadly I'm a human and not a AI, so this could take a week or so

[MohdImran001]

Thanks, for tagging me here @MilosPaunovic. 😃. As far as I have understood, @Shinigami92 is working on all the Typescript related things in #72. @Shinigami92 Please let me know, how can I get started. I have joined the discord server.

[damienwebdev]

Given the workaround here: #9 (comment) I'm closing this issue.

[nicolasrouanne]

FWIW in order to use named imports, I had to make a slightly different export from the .d.ts file than the proposed solution:

// faker.d.ts
declare module '@faker-js/faker' {
  import faker from 'faker';
  export = faker;
}

Using it as named imports

// some test file
import { datatype, date, hacker } from '@faker-js/faker';

This was inspired by how faker is exported from DefinitelyTyped

[Shinigami92]

@SametSahin10 Please try import faker from "@faker-js/faker" 😉

Could also be that you need "esModuleInterop": true in tsconfig.json

[SametSahin10]

@SametSahin10 Please try import faker from "@faker-js/faker" wink

Could also be that you need "esModuleInterop": true in tsconfig.json

I've added "esModuleInterop": true into tsconfig.json and it worked. 👍

[nick-krantz]

I'd be interested in contributing to getting types going for the project. Based on the discussion in #14, I think the intention is to add the types to DefinitelyTyped? Is that correct?

[Shinigami92]

The rewrite to TS could take some days

[nick-krantz]

Oh I must have misunderstood, I thought there would be an intermediate state where types would come before the TS rewrite.

read: weeks.

I believe it

[sramam]

Can't this be actually included in the current repo?
That way, it'll get fixed when it'll get fixed and we won't have to back out this change from a 10^6 downstream modules.

Happy to submit a PR is that seems like an acceptable band-aid.

[MilosPaunovic]

Hello @MohdImran001,

You were willing to help with types on community-faker, https://github.com/MilosPaunovic/community-faker/issues/3, but, for the benefit of the OpenSource, we are moving the official community-driven fork here, so, are you willing to help out here, as well?

[SametSahin10]

For now please create a file in your repo with content:

// faker.d.ts
declare module '@faker-js/faker' {
  import faker from 'faker';
  export default faker;
}

and then just use the @types/faker

Does the location of the faker.d.ts file matter? Where should we put the file?

[Shinigami92]

Does the location of the faker.d.ts file matter? Where should we put the file?

Please note that you can already switch to v6.0.0-alpha.3 with native TS support 🙌

[SametSahin10]

Does the location of the faker.d.ts file matter? Where should we put the file?

Please note that you can already switch to v6.0.0-alpha.3 with native TS support raised_hands

Oh, really? I spent some time trying to figure out how I can link the faker.d.ts with the @types/faker package. Maybe the README file could be updated to remove the Typescript Support section or there could be a mention of the fact that TS support is available in the latest version.

[SametSahin10]

The index.d.ts file handles the linking, right? Back then, we needed to create the faker.d.ts file because the index.d.ts did not exist. I'm currently learning how declaration files work in TS. @Shinigami92

[Shinigami92]

The index.d.ts file handles the linking, right? Back then, we needed to create the faker.d.ts file because the index.d.ts did not exist. I'm currently learning how declaration files work in TS. @Shinigami92

Yes it does, sadly we have currently for some an issue in the -alpha.3 because we shipped the index.ts next to index.d.ts, but this will be already fixed in -alpha.4

[SametSahin10]

The index.d.ts file handles the linking, right? Back then, we needed to create the faker.d.ts file because the index.d.ts did not exist. I'm currently learning how declaration files work in TS. @Shinigami92

Yes it does, sadly we have currently for some an issue in the -alpha.3 because we shipped the index.ts next to index.d.ts, but this will be already fixed in -alpha.4

Is the issue about importing? Cause I cannot import faker with:

import * as faker from "faker"

I get "Cannot find module or its type declarations" and "Unable to resolve path to module faker".