Skip to main content

@php-wasm/web

Index

Classes

Functions

Interfaces

References

Type Aliases

References

WithAPIState

Renames and re-exports WithIsReady

Type Aliases

PublicAPI

PublicAPI<Methods, PipedAPI>: RemoteAPI<Methods & PipedAPI>

Type parameters

  • Methods
  • PipedAPI = unknown

RemoteAPI

RemoteAPI<T>: Comlink.Remote<T> & WithAPIState

Type parameters

  • T

WithIsReady

WithIsReady: { isConnected: () => Promise<void>; isReady: () => Promise<void> }

Type declaration

  • isConnected: () => Promise<void>
      • (): Promise<void>

      • Resolves to true when the remote API is ready for Comlink communication, but not necessarily fully initialized yet.

        Returns Promise<void>

  • isReady: () => Promise<void>
      • (): Promise<void>

      • Resolves to true when the remote API is declares it’s fully loaded and ready to be used.

        Returns Promise<void>