Framework
Version

DevtoolsOptions

Interface: DevtoolsOptions

Optionen zur Konfiguration der TanStack Query Devtools.

Eigenschaften

buttonPosition?

ts
optional buttonPosition: DevtoolsButtonPosition;
optional buttonPosition: DevtoolsButtonPosition;

Die Position des TanStack-Logos zum Öffnen und Schließen des Devtools-Panels. top-left | top-right | bottom-left | bottom-right | relative Standardmäßig bottom-right.

Definiert in

providers.ts:192


client?

ts
optional client: QueryClient;
optional client: QueryClient;

Benutzerdefinierte Instanz von QueryClient

Definiert in

providers.ts:202


errorTypes?

ts
optional errorTypes: DevtoolsErrorType[];
optional errorTypes: DevtoolsErrorType[];

Verwenden Sie dies, um benutzerdefinierte Fehler zu definieren, die in den Devtools angezeigt werden können.

Definiert in

providers.ts:206


initialIsOpen?

ts
optional initialIsOpen: boolean;
optional initialIsOpen: boolean;

Setzen Sie dies auf true, wenn die Devtools standardmäßig geöffnet sein sollen.

Definiert in

providers.ts:186


loadDevtools?

ts
optional loadDevtools: boolean | "auto";
optional loadDevtools: boolean | "auto";

Ob die Entwicklertools geladen werden sollen.

  • auto- (Standard) Lädt Devtools nach Bedarf, wenn im Entwicklungsmodus. Überspringt das Laden im Produktionsmodus.
  • true- Lädt die Devtools immer, unabhängig von der Umgebung.
  • false- Lädt die Devtools niemals, unabhängig von der Umgebung.

Sie können true und false verwenden, um das Laden von Entwicklertools aus einer Umgebungsvariable zu überschreiben. Zum Beispiel kann eine Testumgebung im Produktionsmodus laufen, aber Sie möchten möglicherweise Entwicklertools laden.

Zusätzlich können Sie ein Signal im Callback verwenden, um die Devtools dynamisch basierend auf einer Bedingung zu laden. Zum Beispiel ein Signal, das aus einem RxJS-Observable erstellt wurde, das auf eine Tastenkombination hört.

Beispiel

ts
withDevtools(() => ({
  initialIsOpen: true,
  loadDevtools: inject(ExampleService).loadDevtools(),
}))
withDevtools(() => ({
  initialIsOpen: true,
  loadDevtools: inject(ExampleService).loadDevtools(),
}))

Definiert in

providers.ts:236


position?

ts
optional position: DevtoolsPosition;
optional position: DevtoolsPosition;

Die Position des TanStack Query Devtools-Panels. top | bottom | left | right Standardmäßig bottom.

Definiert in

providers.ts:198


shadowDOMTarget?

ts
optional shadowDOMTarget: ShadowRoot;
optional shadowDOMTarget: ShadowRoot;

Verwenden Sie dies, um die Styles der Devtools an ein bestimmtes Element im DOM anzuhängen.

Definiert in

providers.ts:214


styleNonce?

ts
optional styleNonce: string;
optional styleNonce: string;

Verwenden Sie dies, um einen Nonce an das Style-Tag zu übergeben, das dem Dokument-Head hinzugefügt wird. Dies ist nützlich, wenn Sie eine Content Security Policy (CSP) Nonce verwenden, um Inline-Stile zuzulassen.

Definiert in

providers.ts:210