Utwórz zmienną globalną w TypeScript


91

W JavaScript mogę po prostu zrobić to:

 something = 'testing';

A potem w innym pliku:

 if (something === 'testing')

i zostanie somethingzdefiniowane (o ile były wywoływane we właściwej kolejności).

Nie wiem, jak to zrobić w TypeScript.

Właśnie tego próbowałem.

W pliku .d.ts:

interface Window { something: string; }

Następnie w moim pliku main.ts:

 window.something = 'testing';

następnie w innym pliku:

 if (window.something  === 'testing')

I to działa. Ale chcę móc stracić window.część tego i po prostu somethingbyć globalnym. Czy istnieje sposób, aby to zrobić w języku TypeScript?

(Jeśli ktoś jest zainteresowany, naprawdę próbuję skonfigurować logowanie dla mojej aplikacji. Chcę mieć możliwość wywołania log.Debugz dowolnego pliku bez konieczności importowania i tworzenia obiektów).

Odpowiedzi:


4

Okej, więc to jest prawdopodobnie jeszcze brzydsze niż to, co zrobiłeś, ale w każdym razie ...

ale robię to samo, więc ...

To, co możesz zrobić, aby to zrobić w czystym języku TypeScript, to użyć evalfunkcji w następujący sposób:

declare var something: string;
eval("something = 'testing';")

A później będziesz w stanie to zrobić

if (something === 'testing')

To nic innego jak hack, aby wymusić wykonanie instrukcji bez odmowy kompilacji declare varprzez TypeScript , a my dla TypeScript skompilujemy resztę kodu.


To nie działa dla mnie. Mam eval ('myglobalvar = {};') ;. Wynika z tego: Uncaught ReferenceError: myglobalvar nie jest zdefiniowany w eval (eval at <anonymous> .....). Co zabawne, jeśli uruchomię go z konsoli, to działa.
— Ryan How

2
@DragonRock Wypróbowałem Chrome i FF. Więc naprawdę nie jestem pewien, co się działo. W każdym razie zakończyło się zadeklarowaniem var myglobalvar; (<dowolne> okno) .myglobalvar = {}; Następnie mogę odwołać się do niego bez okna.
— Ryan How

2
.d.tsZamiast tego naprawdę powinno się to zrobić za pomocą pliku definicji.
— brianespinosa

2
To działa dla mnie:export declare const SERVER = "10.1.1.26";
— xinthose

2
Używanie evaljest wysoce odradzane, dlatego sugeruję skorzystanie z tego rozwiązania stackoverflow.com/a/56984504/5506278
— Yaroslav Bai

62

W .d.tspliku definicji

type MyGlobalFunctionType = (name: string) => void

Jeśli pracujesz w przeglądarce, dodajesz członków do kontekstu okna przeglądarki:

interface Window {
  myGlobalFunction: MyGlobalFunctionType
}

Ten sam pomysł dla NodeJS:

declare module NodeJS {
  interface Global {
    myGlobalFunction: MyGlobalFunctionType
  }
}

Teraz deklarujesz zmienną główną (która faktycznie będzie żyła w oknie lub globalnie)

declare const myGlobalFunction: MyGlobalFunctionType;

Następnie w zwykłym .tspliku, ale zaimportowanym jako efekt uboczny, faktycznie zaimplementujesz to:

global/* or window */.myGlobalFunction = function (name: string) {
  console.log("Hey !", name);
};

I wreszcie użyj go w innym miejscu w bazie kodu, korzystając z:

global/* or window */.myGlobalFunction("Kevin");

myGlobalFunction("Kevin");

4
(Robię tylko przelotny komentarz) Porozmawiaj o pracy, aby stworzyć prostą zmienną globalną! lol
— Pytth

6
@Benoit Nie dostaję części z napisem „ale zaimportowana jako efekt uboczny”. Co przez to rozumiesz?. Próbowałem to zrobić, ale to nie działa, czy możesz udostępnić przykład kodu źródłowego?
— BernalCarlos

Działa to dobrze w przypadku .tsplików, ale kiedy używam window.myGlobalFunctionw moich .tsxplikach, tak nie jest. Co jeszcze muszę zmienić ?!
— Kousha

13
Gdzie umieszczasz plik d.ts i jak konfigurujesz TypeScript, aby go załadował?
— Matthias

25

globalTo jest przyszłość.

Po pierwsze, pliki TypeScript mają dwa rodzaje plików scopes

Zakres globalny

Jeśli twój plik nie ma żadnych linii importlubexport , ten plik zostałby wykonany w zakresie globalnym, że wszystkie zawarte w nim deklaracje są widoczne poza tym plikiem.

Utworzylibyśmy więc zmienne globalne w ten sposób:

// xx.d.ts
declare var age: number

// or 
// xx.ts
// with or without declare keyword
var age: number

// other.ts
globalThis.age = 18 // no error

Cała magia pochodzi var. Wymień varsię letlub constnie będzie działać.

zakres modułu

Jeśli twój plik ma jakąkolwiek linię importlubexport , ten plik zostanie wykonany w swoim własnym zakresie, który musimy rozszerzyć globalnie przez scalanie deklaracji .

// xx[.d].ts
declare global {
  var age: number;
}

// other.ts
globalThis.age = 18 // no error

Więcej informacji na temat modułu można znaleźć w oficjalnej dokumentacji


Ale jak byś to zrobił bez hacka „var”? Wydaje mi się, że to oznacza, w jaki sposób mógłbym zrobić rozszerzenie typu w globalThis?
— Tom

1
@Tom varjest konieczny. Ale możesz po prostu zadeklarować zmienną bez inicjalizacji
— edvard chen

Pracowało dla mnie (przynajmniej na razie), dziękuję bardzo, chciałbym, aby ta odpowiedź wzrosła. FYI: W moim przypadku potrzebowałem dodać // @ts-ignorepowyżej globalThislinii dla wkładki.
— David

Jak nazwałbyś zmienną age w dowolnym pliku maszynopisu?
— Ashok kumar Ganesan

17

Oto jak to naprawiłem:

Kroki:

  1. Zadeklarowano globalną przestrzeń nazw, np. Custom.d.ts, jak poniżej:
declare global {
    namespace NodeJS {
        interface Global {
            Config: {}
        }
    }
}
export default global;
  1. Zamapuj powyższy utworzony plik na „tsconfig.json”, jak poniżej:
"typeRoots": ["src/types/custom.d.ts" ]
  1. Pobierz powyższą utworzoną zmienną globalną w dowolnym z plików, jak poniżej:
console.log(global.config)

Uwaga:

  1. wersja maszynopisu: „3.0.1”.

  2. W moim przypadku wymaganiem było ustawienie zmiennej globalnej przed uruchomieniem aplikacji, a zmienna powinna mieć dostęp do wszystkich obiektów zależnych, abyśmy mogli uzyskać wymagane właściwości konfiguracyjne.

Mam nadzieję że to pomoże!

Dziękuję Ci


14

Znalazłem sposób, który działa, jeśli używam JavaScript w połączeniu z TypeScript.

logowanie.d.ts:

declare var log: log4javascript.Logger;

deklaracja dziennika. js :

log = null;

initalize-app.ts

import './log-declaration.js';

// Call stuff to actually setup log.  
// Similar to this:
log = functionToSetupLog();

To umieszcza go w zasięgu globalnym i TypeScript o tym wie. Więc mogę go używać we wszystkich moich plikach.

UWAGA: Myślę, że to działa tylko dlatego, że mam allowJsopcję TypeScript ustawioną na true.

Jeśli ktoś opublikuje czyste rozwiązanie TypeScript, zaakceptuję to.


1
W pliku initalize-app.ts możesz użyć: declare var log: any; Wtedy nie musisz mieć pliku d.ts ani pliku js. Możesz zastąpić dowolny z rzeczywistym typem lub definicją interfejsu.
— mattferderer

5

używam tylko tego

import {globalVar} from "./globals";
declare let window:any;
window.globalVar = globalVar;

1
Powoduje to odrzucenie wszystkich informacji o typie. Równie dobrze może używać Javascript.
— Timmmm,

3

Spędziłem kilka godzin, aby znaleźć właściwy sposób na zrobienie tego. W moim przypadku próbuję zdefiniować globalną zmienną „log”, więc kroki były następujące:

1) skonfiguruj swoje, tsconfig.jsonaby uwzględnić zdefiniowane typy ( src/typesfolder, node_modules - zależy od Ciebie):

...other stuff...
"paths": {
  "*": ["node_modules/*", "src/types/*"]
}

2) stwórz plik src/types/global.d.tsz następującą zawartością ( bez importu! - to ważne), możesz zmienić ją tak, anyby odpowiadała Twoim potrzebom + użyj windowinterfejsu zamiast NodeJSpracy z przeglądarką:

/**
 * IMPORTANT - do not use imports in this file!
 * It will break global definition.
 */
declare namespace NodeJS {
    export interface Global {
        log: any;
    }
}

declare var log: any;

3) teraz możesz wreszcie użyć / wdrożyć logtam, gdzie jest to potrzebne:

// in one file
global.log = someCoolLogger();
// in another file
log.info('hello world');
// or if its a variable
global.log = 'INFO'

Co jest pathsw tsconfig.jsonśrodku? Doktorzy nie wspominają o tym.
— tambre

Dlaczego Globalw definicjach jest to wielkie litery, ale nie w rzeczywistym użyciu?
— tambre

@tambre nie wiem, dlaczego TS docs nie masz to udokumentowane, można znaleźć kilka szczegółów dotyczących tego config tutaj: json.schemastore.org/tsconfig i tutaj: basarat.gitbooks.io/typescript/docs/project/tsconfig.html chodzi Globalz dużymi literami - tak "globalna" deklaracja interfejsu nazwana w przestrzeni nazw nodejs.
— Alexey

1

Musiałem uczynić lodash globalnym, aby użyć istniejącego pliku .js, którego nie mogłem zmienić, tylko wymagałem.

Okazało się, że to zadziałało:

import * as lodash from 'lodash';

(global as any)._ = lodash;

0

Jako dodatek do odpowiedzi Dima V zrobiłem to, aby ta działała dla mnie.

// First declare the window global outside the class

declare let window: any;

// Inside the required class method

let globVarName = window.globVarName;


Czy osoba, która oddała głos w dół, może wyjaśnić powód?
— Jonathan Cardoz,

7
Cóż, jest to rozwiązanie, takie jak przyklejenie czarną taśmą kontrolkę „check engine” na desce rozdzielczej. Rozwiązuje problem, ale nie we właściwy sposób. Zniszczy typy. To nie jest optymalne rozwiązanie; jest to obejście, które działa również wokół głównego celu maszynopisu: mieć typy.
— Matthias

Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.