-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: add section explaining Types global namespace usage (#97) #226
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
Open
Adityapradh
wants to merge
1
commit into
piotrwitek:master
Choose a base branch
from
Adityapradh:add-types-global-namespace
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.
+40
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
## Using the `Types` Global Namespace | ||
|
||
In a large-scale React + Redux + TypeScript project, it's often helpful to use the `Types` global namespace to share type definitions across your application. | ||
|
||
### ✅ Why Use a Global Namespace? | ||
|
||
- Central place to store common types like `User`, `Product`, etc. | ||
- No need to import types in every file. | ||
- Improves consistency and scalability. | ||
|
||
### 🔧 Example Setup | ||
|
||
1. Create a global declaration file: | ||
|
||
```ts | ||
// src/types/global.d.ts | ||
export {}; | ||
|
||
declare global { | ||
namespace Types { | ||
type User = { | ||
id: string; | ||
name: string; | ||
email: string; | ||
}; | ||
} | ||
} | ||
### 💡 Usage Example | ||
|
||
Now you can use `Types` anywhere in your code **without importing**: | ||
|
||
```ts | ||
const greet = (user: Types.User) => { | ||
console.log(`Hello, ${user.name}`); | ||
}; | ||
|
||
const total = (product: Types.Product) => { | ||
return product.price * 2; | ||
}; | ||
|
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.
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.
The
product
type is not defined in the global namespace example above. This could lead to confusion for readers trying to implement the example. Either define theProduct
type in the global namespace or change the example to use theUser
type to align with the provided example.