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.

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

Typescript utility type to extract the target (generic) type of an injection token #2135

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

gthau
Copy link

@gthau gthau commented Mar 9, 2022

Created a typescript utility type to extract the target (generic) type of an injection token.

This allows to write injected dependencies like:

  • given the following injection token:
const MyToken = new InjectionToken<Promise<Array<string | number>>>('my-token');

you can write:

type MyTokenTargetType = InjectionTokenTargetType<typeof MyToken>;

class MyClass {
  constructor(@Inject(MyToken) someField: MyTokenTargetType) {}
}

instead of:

const MyToken = new InjectionToken<Promise<Array<string | number>>>('my-token');

class MyClass {
  constructor(@Inject(MyToken) someField: Promise<Array<string | number>>) {}
}

🚨 IMPORTANT: Please do not create a Pull Request without creating an issue first.

Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Screenshots/Sandbox (if appropriate/relevant):

Adding links to sandbox or providing screenshots can help us understand more about this PR and take action on it as appropriate

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Environment:

  • OS:
  • @graphql-modules/...:
  • NodeJS:

Checklist:

  • I have followed the CONTRIBUTING doc and the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests and linter rules pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

…e of an injection token.

This allows to write injected dependencies like:
- given the following injection token:
```ts
const MyToken = new InjectionToken<Promise<Array<string | number>>>('my-token');
```

you can write:
```ts
type MyTokenTargetType = InjectionTokenTargetType<typeof MyToken>;

class MyClass {
  constructor(@Inject(MyToken) someField: MyTokenTargetType) {}
}
```

instead of:

```ts
const MyToken = new InjectionToken<Promise<Array<string | number>>>('my-token');

class MyClass {
  constructor(@Inject(MyToken) someField: Promise<Array<string | number>>) {}
}
```
@changeset-bot
Copy link

changeset-bot bot commented Mar 9, 2022

⚠️ No Changeset found

Latest commit: ac0a71e

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

@vercel
Copy link

vercel bot commented Mar 9, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/theguild/graphql-modules/ArWnHZfMJEBn2P6THS571VhodATo
✅ Preview: Failed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant