Add GlobalThis type
#511
Merged
Add GlobalThis type
#511
+37
−0
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
sindresorhus
requested changes
Nov 20, 2022
|
I don't think we should support |
papb
reviewed
Nov 21, 2022
trevorade
force-pushed
the
global_this
branch
2 times, most recently
from
c7dbcd9 to
ed59727
Compare
Fair enough. Just need to guard our codebase from |
sindresorhus
reviewed
Dec 3, 2022
sindresorhus
reviewed
Dec 3, 2022
trevorade
force-pushed
the
global_this
branch
from
ed59727 to
9312081
Compare
sindresorhus
requested changes
Dec 7, 2022
This type is for times when you need to access non-standard properties off of `window`, `self`, or `globalThis`. For example:
```ts
import type {GlobalThis} from 'type-fest';
interface ExtraProps extends GlobalThis {
readonly GLOBAL_TOKEN: string;
}
const extraProps = window as ExtraProps;
```
---
Normally, you would define a declaration file to add global variables.
When you need to do this in a more targeted manner though, a common approach is:
```ts
interface ExtraProps extends Window {
readonly GLOBAL_TOKEN: string
}
const extraProps = window as unknown as ExtraProps;
```
Without the cast through `unknown`, you get error `TS2352`.
You can try to workaround that with the following:
```ts
type GlobalThis = (typeof globalThis) & Window;
interface ExtraProps extends GlobalThis {
readonly GLOBAL_TOKEN: string
}
```
But then you get the error: `Property 'Infinity' of type 'number' is not assignable to numeric index type 'Window'.(2412)` (also for `NaN`).
So you have to redefine `Infinity` and `NaN` as `never` to get this working.
---
Note: In environments that choose to not load the `"dom"` lib (e.g., for workers or node), the global `Window` interface will not be defined. The only way to modify `Infinity` and `NaN` would be to declare `Window` in the `global` scope. This is undesirable though as now an empty `Window` symbol will be present for users of `type-fest`. The workaround here is to make use of a `@ts-ignore` to treat `Window` as `any` if it is not present.
trevorade
force-pushed
the
global_this
branch
from
9312081 to
186c756
Compare
|
Nice work 👍 |
|
I don't understand this type. Globals are global, what does "locally scoped properties on |
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.
This type is for times when you need to access non-standard properties off of
window,self, orglobalThis. For example:Normally, you would define a declaration file to add global variables.
This change permits introducing global symbols in a more targeted manner.
Note: In the test, it seems like
expectErrorshould work here rather than using@ts-expect-errorbut, unfortunately, it does not.I'd be happy to hear other suggestions on supporting this use case!