WP Kernel API v0.3.0

---

WP Kernel API / core/src / KernelInstance

Interface: KernelInstance

Properties

getNamespace()

getNamespace: () => string;

Returns

string

---

getReporter()

getReporter: () => Reporter;

Returns

Reporter

---

invalidate()

invalidate: (patterns, options?) => void;

Parameters

patterns

CacheKeyPattern | CacheKeyPattern[]

options?

InvalidateOptions

Returns

void

---

emit()

emit: (eventName, payload) => void;

Parameters

eventName

string

payload

unknown

Returns

void

---

teardown()

teardown: () => void;

Returns

void

---

getRegistry()

getRegistry: () => KernelRegistry | undefined;

Returns

KernelRegistry | undefined

---

hasUIRuntime()

hasUIRuntime: () => boolean;

Returns

boolean

---

getUIRuntime()

getUIRuntime: () => 
  | KernelUIRuntime
  | undefined;

Returns

| KernelUIRuntime | undefined

---

attachUIBindings()

attachUIBindings: (attach, options?) => KernelUIRuntime;

Parameters

attach

KernelUIAttach

options?

UIIntegrationOptions

Returns

KernelUIRuntime

---

ui

ui: object;

isEnabled()

isEnabled: () => boolean;

Returns

boolean

options?

optional options: UIIntegrationOptions;

---

events

events: KernelEventBus;

---

defineResource()

defineResource: <T, TQuery>(config) => ResourceObject<T, TQuery>;

Type Parameters

T

T = unknown

TQuery

TQuery = unknown

Parameters

config

ResourceConfig<T, TQuery>

Returns

ResourceObject<T, TQuery>