-
Notifications
You must be signed in to change notification settings - Fork 713
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
feat: strongly-typed Container
#1575
Open
alecgibson
wants to merge
1
commit into
inversify:master
Choose a base branch
from
alecgibson:strongly-typed-injection
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alecgibson
force-pushed
the
strongly-typed-injection
branch
2 times, most recently
from
July 5, 2024 12:14
255acc1
to
efff40c
Compare
This is a non-breaking change, affecting only TypeScript types, and doesn't change the implementation in any way. Motivation ========== `inversify` already has some basic support for types when binding, and retrieving bindings. However, the type support requires manual intervention from developers, and can be error-prone. For example, the following code will happily compile, even though the types here are inconsistent: ```ts container.bind<Bar>('bar').to(Bar); const foo = container.get<Foo>('bar') ``` Furthermore, this paves the way for [type-safe injection][1], which will be added once this change is in. Improved type safety ==================== This change adds an optional type parameter to the `Container`, which takes an identifier map as an argument. For example: ```ts type IdentifierMap = { foo: Foo; bar: Bar; }; const container = new Container<IdentifierMap>; ``` If a `Container` is typed like this, we now get strong typing both when binding, and getting bindings: ```ts const container = new Container<IdentifierMap>; container.bind('foo').to(Foo); // ok container.bind('foo').to(Bar); // error const foo: Foo = container.get('foo') // ok const bar: Bar = container.get('foo') // error ``` This also has the added benefit of no longer needing to pass around service identifier constants: the strings (or symbols) are all strongly typed, and will fail compilation if an incorrect one is used. Non-breaking ============ This change aims to make no breaks to the existing types, so any `Container` without an argument should continue to work as it did before. [1]: inversify#788 (comment)
alecgibson
force-pushed
the
strongly-typed-injection
branch
from
July 5, 2024 13:25
efff40c
to
131c0fa
Compare
alecgibson
commented
Jul 5, 2024
} | ||
|
||
export type Bind = <T = unknown>(serviceIdentifier: ServiceIdentifier<T>) => BindingToSyntax<T>; | ||
export type Bind<T extends BindingMap = any> = | ||
<B extends ContainerBinding<T, K>, K extends ContainerIdentifier<T> = any>(serviceIdentifier: K) => BindingToSyntax<B>; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note, in the interest of keeping changes to a minimum, I haven't touched the BindingToSyntax
type, but we may want to consider tweaking it — either as part of this change, or a future change — because:
container.bind('foo').toDynamicValue(
({container}) => container.get('bar') // not strongly typed
)
@PodaruDragos any thoughts on this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is a non-breaking change, affecting only TypeScript types, and doesn't change the implementation in any way.
Motivation
inversify
already has some basic support for types when binding, and retrieving bindings.However, the type support requires manual intervention from developers, and can be error-prone.
For example, the following code will happily compile, even though the types here are inconsistent:
Furthermore, this proposal paves the way for type-safe injection, which will be added once this change is in.
Improved type safety
This change adds an optional type parameter to the
Container
, which takes an identifier map as an argument. For example:If a
Container
is typed like this, we now get strong typing both when binding, and getting bindings:This also has the added benefit of no longer needing to pass around service identifier constants: the strings (or symbols) are all strongly typed, and will fail compilation if an incorrect one is used.
Non-breaking
This change aims to make no breaks to the existing types, so any
Container
without an argument should continue to work as it did before.Related Issue
#788
How Has This Been Tested?
Types of changes
Checklist: