DevtoolsQueryContribution
interface exported by @mwillbanks/tuil-devtools.
interface
Public interface exported by @mwillbanks/tuil-devtools.
export interface DevtoolsQueryContribution extends DevtoolsContribution {
readonly kind: "query";
query(input: string): unknown | Promise<unknown>;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
kind | "query" | Yes | The kind member uses the "query" contract. | — |
query | (input: string) => unknown | Promise<unknown> | Yes | The query member uses the (input: string) => unknown | Promise<unknown> contract. | — |
id | string | Yes | The id member uses the string contract. | — |
title | string | Yes | The title member uses the string contract. | — |
icon | string | undefined | No | The icon member uses the string | undefined contract. | — |
requiredCapabilities | readonly DevtoolsCapability[] | undefined | No | The requiredCapabilities member uses the readonly DevtoolsCapability[] | undefined contract. | DevtoolsCapability |
activation | (() => boolean) | undefined | No | The activation member uses the (() => boolean) | undefined contract. | — |
permissions | ReadonlySet<DevtoolsPermission> | Yes | The permissions member uses the ReadonlySet<DevtoolsPermission> contract. | DevtoolsPermission |
serialization | "json" | Yes | The serialization member uses the "json" contract. | — |
dispose | (() => void) | undefined | No | The dispose member uses the (() => void) | undefined contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference