mirror of
https://github.com/sindresorhus/type-fest.git
synced 2025-12-08 19:25:05 +00:00
22 lines
688 B
TypeScript
22 lines
688 B
TypeScript
/**
|
|
Declare locally scoped properties on `globalThis`.
|
|
|
|
When defining a global variable in a declaration file is inappropriate, it can be helpful to define a `type` or `interface` (say `ExtraGlobals`) with the global variable and then cast `globalThis` via code like `globalThis as unknown as ExtraGlobals`.
|
|
|
|
Instead of casting through `unknown`, you can update your `type` or `interface` to extend `GlobalThis` and then directly cast `globalThis`.
|
|
|
|
@example
|
|
```
|
|
import type {GlobalThis} from 'type-fest';
|
|
|
|
type ExtraGlobals = GlobalThis & {
|
|
readonly GLOBAL_TOKEN: string;
|
|
};
|
|
|
|
(globalThis as ExtraGlobals).GLOBAL_TOKEN;
|
|
```
|
|
|
|
@category Type
|
|
*/
|
|
export type GlobalThis = typeof globalThis;
|