Function whenReady

whenReady<K extends AsyncElementTagName>(
target: K,
): Promise<HTMLElementTagNameMap[K]>
Waits for the first element matching the given tag name to be fully initialized. Note that the promise never settles if the element cannot finish initializing (for example, a <pc-script-instance> that is not a direct child of <pc-script>, or a <pc-app> that could not create a graphics device — listen for its error event instead). A component element outside an entity-fronting element is the exception: it still becomes ready, but its component is null. Either way, a misplaced element logs a warning naming the parent it requires.
Type Parameters
- K extends AsyncElementTagName
Parameters
- target: K
  The tag name of the element to wait for (e.g. 'pc-app').
Returns Promise<HTMLElementTagNameMap[K]>
A promise that resolves with the element once it's ready.
Example
```
const { app } = await whenReady('pc-app');
```
- Defined in src/async-element.ts:108
whenReady<T extends AsyncElement>(target: T): Promise<T>
Waits for the given element to be fully initialized. Note that the promise never settles if the element cannot finish initializing (for example, an element that is never added to the document).
Type Parameters
- T extends AsyncElement
Parameters
- target: T
  The element to wait for.
Returns Promise<T>
A promise that resolves with the element once it's ready.
Example
```
const appElement = document.createElement('pc-app');
document.body.appendChild(appElement);
const { app } = await whenReady(appElement);
```
- Defined in src/async-element.ts:120
whenReady<T extends AsyncElement = AsyncElement, S extends string = string>(
    target: S extends | "object"
    | "input"
    | "progress"
    | "select"
    | "a"
    | "abbr"
    | "address"
    | "area"
    | "article"
    | "aside"
    | "audio"
    | "b"
    | "base"
    | "bdi"
    | "bdo"
    | "blockquote"
    | "body"
    | "br"
    | "button"
    | "canvas"
    | "caption"
    | "cite"
    | "code"
    | "col"
    | "colgroup"
    | "data"
    | "datalist"
    | "dd"
    | "del"
    | "details"
    | "dfn"
    | "dialog"
    | "div"
    | "dl"
    | "dt"
    | "em"
    | "embed"
    | "fieldset"
    | "figcaption"
    | "figure"
    | "footer"
    | "form"
    | "h1"
    | "h2"
    | "h3"
    | "h4"
    | "h5"
    | "h6"
    | "head"
    | "header"
    | "hgroup"
    | "hr"
    | "html"
    | "i"
    | "iframe"
    | "img"
    | "ins"
    | "kbd"
    | "label"
    | "legend"
    | "li"
    | "link"
    | "main"
    | "map"
    | "mark"
    | "menu"
    | "meta"
    | "meter"
    | "nav"
    | "noscript"
    | "ol"
    | "optgroup"
    | "option"
    | "output"
    | "p"
    | "picture"
    | "pre"
    | "q"
    | "rp"
    | "rt"
    | "ruby"
    | "s"
    | "samp"
    | "script"
    | "search"
    | "section"
    | "slot"
    | "small"
    | "source"
    | "span"
    | "strong"
    | "style"
    | "sub"
    | "summary"
    | "sup"
    | "table"
    | "tbody"
    | "td"
    | "template"
    | "textarea"
    | "tfoot"
    | "th"
    | "thead"
    | "time"
    | "title"
    | "tr"
    | "track"
    | "u"
    | "ul"
    | "var"
    | "video"
    | "wbr"
    | "pc-material"
        ? never
        : S,
): Promise<T>
Waits for the first element matching the given CSS selector to be fully initialized. Note that the promise never settles if the element cannot finish initializing (for example, a <pc-script-instance> that is not a direct child of <pc-script>, or a <pc-app> that could not create a graphics device — listen for its error event instead). A component element outside an entity-fronting element is the exception: it still becomes ready, but its component is null. Either way, a misplaced element logs a warning naming the parent it requires.
Type Parameters
- T extends AsyncElement = AsyncElement
- S extends string = string
Parameters
- target: S extends | "object"
  | "input"
  | "progress"
  | "select"
  | "a"
  | "abbr"
  | "address"
  | "area"
  | "article"
  | "aside"
  | "audio"
  | "b"
  | "base"
  | "bdi"
  | "bdo"
  | "blockquote"
  | "body"
  | "br"
  | "button"
  | "canvas"
  | "caption"
  | "cite"
  | "code"
  | "col"
  | "colgroup"
  | "data"
  | "datalist"
  | "dd"
  | "del"
  | "details"
  | "dfn"
  | "dialog"
  | "div"
  | "dl"
  | "dt"
  | "em"
  | "embed"
  | "fieldset"
  | "figcaption"
  | "figure"
  | "footer"
  | "form"
  | "h1"
  | "h2"
  | "h3"
  | "h4"
  | "h5"
  | "h6"
  | "head"
  | "header"
  | "hgroup"
  | "hr"
  | "html"
  | "i"
  | "iframe"
  | "img"
  | "ins"
  | "kbd"
  | "label"
  | "legend"
  | "li"
  | "link"
  | "main"
  | "map"
  | "mark"
  | "menu"
  | "meta"
  | "meter"
  | "nav"
  | "noscript"
  | "ol"
  | "optgroup"
  | "option"
  | "output"
  | "p"
  | "picture"
  | "pre"
  | "q"
  | "rp"
  | "rt"
  | "ruby"
  | "s"
  | "samp"
  | "script"
  | "search"
  | "section"
  | "slot"
  | "small"
  | "source"
  | "span"
  | "strong"
  | "style"
  | "sub"
  | "summary"
  | "sup"
  | "table"
  | "tbody"
  | "td"
  | "template"
  | "textarea"
  | "tfoot"
  | "th"
  | "thead"
  | "time"
  | "title"
  | "tr"
  | "track"
  | "u"
  | "ul"
  | "var"
  | "video"
  | "wbr"
  | "pc-material"
  ? never
  : S
  A CSS selector matching the element to wait for (e.g. '#my-app').
Returns Promise<T>
A promise that resolves with the element once it's ready.
Example
```
// In TypeScript, supply the element type when using an arbitrary selector
const { entity } = await whenReady<EntityElement>('pc-entity[name="camera"]');
```
- Defined in src/async-element.ts:134

Function whenReady

Type Parameters

Parameters

Returns Promise<HTMLElementTagNameMap[K]>

Example

Type Parameters

Parameters

Returns Promise<T>

Example

Type Parameters

Parameters

Returns Promise<T>

Example

Settings